testautomation/global/system/includes/gvariabl.inc

   1 'encoding UTF-8  Do not remove or change this line!
   2 '**************************************************************************
   3 '* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 '*
   5 '* Copyright 2008 by Sun Microsystems, Inc.
   6 '*
   7 '* OpenOffice.org - a multi-platform office productivity suite
   8 '*
   9 '* $RCSfile: gvariabl.inc,v $
  10 '*
  11 '* $Revision: 1.2 $
  12 '*
  13 '* last change: $Author: vg $ $Date: 2008-08-19 12:49:36 $
  14 '*
  15 '* This file is part of OpenOffice.org.
  16 '*
  17 '* OpenOffice.org is free software: you can redistribute it and/or modify
  18 '* it under the terms of the GNU Lesser General Public License version 3
  19 '* only, as published by the Free Software Foundation.
  20 '*
  21 '* OpenOffice.org is distributed in the hope that it will be useful,
  22 '* but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 '* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 '* GNU Lesser General Public License version 3 for more details
  25 '* (a copy is included in the LICENSE file that accompanied this code).
  26 '*
  27 '* You should have received a copy of the GNU Lesser General Public License
  28 '* version 3 along with OpenOffice.org.  If not, see
  29 '* <http://www.openoffice.org/license.html>
  30 '* for a copy of the LGPLv3 License.
  31 '*
  32 '/************************************************************************
  33 '*
  34 '* owner : helge.delfs@sun.com
  35 '*
  36 '* short description : all global variables
  37 '*
  38 '************************************************************************
  39 '*
  40 ' #1 OnlyForDocuGVariables
  41 '*
  42 '\***********************************************************************
  43
  44 '/// * System for the installed Office
  45 Global gPlatform as String          '///+ gPlatform => Operatingsystem (internal shortkey)
  46 Global gSYSName as String           '///+ gSYSName => Name of Operatingsystems
  47 Global gSystemPath as String        '///+ gSystemPath => Systempath
  48 Global gPathSigne as String         '///+ gPathSigne => Pathsigne for the Operationsystem
  49 Global gPlatGroup as String         '///+ gPlatGroup => the systemgroup  for the OS  (e.g. 'unx' 'w95' etc.)
  50 Global iSystemSprache as Integer    '///+ iSystemSprache => code for the systemlanguage (01 = en_us, 40 = de_de)
  51 Global gSVersionIni as String       '///+ gSVersionIni => path to sversion.ini
  52
  53 '/// * System for the Testtool
  54 Global gtSYSName as String          '///+ gtSYSName => Name of Testtool-Operationsystem
  55 Global gtPlatform as String         '///+ gtPlatform => Operatingsystem (internal shortkey)
  56 Global gtSystemPath as String       '///+ gtSystemPath => Users Home directory
  57 Global gtCommonSystemPath as String '///+ gtCommonSystemPath => Global directory AllUser or /etc
  58 Global gTesttoolIni as String       '///+ gTesttoolIni => Path to Testtool.ini
  59 Global gtHidLstPath as String       '///+ gtHidLstPath => Path to hid.lst
  60 Global gTTProfileName as string     '///+ gTTProfileName => The current used Profile
  61
  62 '/// * Settings for Crashreporter
  63 Global gUseProxy                    '///+ Value of [Crashreporter] 'UseProxy' from the testtool control file: Is TRUE or FALSE
  64 Global gProxyServer                 '///+ Value of [Crashreporter] 'ProxyServer' from the testtool control file: string
  65 Global gProxyPort                   '///+ Value of [Crashreporter] 'ProxyPort' from the testtool control file: string
  66 Global gReturnAddress               '///+ Value of [Crashreporter] 'ReturnAddress' from the testtool control file: string
  67 Global gAllowContact                '///+ Value of [Crashreporter] 'AllowContact' from the testtool control file: Is TRUE or FALSE
  68 Global gConnectionType              '///+ Value is depending on gUseProxy: TRUE = MANUALPROXY, FALSE = DIRECT
  69
  70 '/// * path - variables
  71 Global gOfficePath as String        '///+ gOfficePath => included the path of the Office-installation
  72 Global gOfficeBasisPath as String   '///+ gOfficeBasisPath => included the path of the Office-basis-installation
  73 Global gRemotePath as String        '///+ gRemotePath => Base Directory on Remote system
  74 Global gTesttoolPath as String      '///+ gTesttoolPath => included the path of the Testtool-directory (changed with ConvertPath)
  75 Global oTesttoolPath as String      '///+ oTesttoolPath => original Testtool-directory
  76 Global sAppExe as String            '///+ sAppExe => included the whole path to 'soffice.exe' or 'soffice'
  77 Global sFactory as String           '///+ sFactory => Which application module should be used swriter, scalc, ...
  78 Global sAppParameter as String      '///+ sAppParameter => included all parameters for the executable
  79 Global sCapturePath as String       ' path for graphic-snapshots
  80 Global gPrivateEnvironmentLocation as string '///+ gPrivateEnvironmentLocation: Location for test environment special data and files
  81
  82 '/// * Officevariables
  83 Global iSprache as Integer          '///+ iSprache  => code for the office-language (01=en_us, 49=de_de etc.)
  84 Global bAsianLan as Boolean         '///+ bAsianLan => if the office-language is an asian language (81, 82, 86, 88) => TRUE
  85 Global bCTLLan as Boolean           '///+ bCTLLan   => if the office-language is an CTL language (66, 91, 96, 97) => TRUE
  86 Global gLanguage as String          '///+ gLanguage => the languagename for office language
  87 Global gISOLang as String           '///+ gISOLang  => the language code ISO 639 (and ISO 3166 for en language)
  88 Global gAsianSup as Boolean         '///+ gAsianSup => if asian support is activated in options
  89 Global gCTLSup as Boolean           '///+ gCTLSup   => if CTL support is activated in options
  90 Global gAccessibility as Boolean    '///+ gAccessibility => If an accessibility tool is detected (gnome, JAWS)
  91 Global gProductName as string        '///+ gProductName => Name of the product (StarOffice, OpenOffice.org, ...)
  92 Global gMacroSecurityLevel as integer'///+ gMacroSecurityLevel => Macro Security Level (0: Low ... 3: Very High)
  93 Global gOfficeVersion as string     '///+ gOfficeVersion => The version number of the office like 3.1, 9.0 ...
  94
  95 '/// - global OLE-objectnames
  96 global gOLEWriter as String         '///+ gOLEWriter       => OLE-object-name for Writer
  97 global gOLECalc as String           '///+ gOLECalc         => OLE-object-name for Calc
  98 global gOLEImpress as String        '///+ gOLEImpress      => OLE-object-name for Impress
  99 global gOLEDraw as String           '///+ gOLEDraw         => OLE-object-name for Draw
 100 global gOLEChart as String          '///+ gOLEChart        => OLE-object-name for Chart
 101 global gOLEMath as String           '///+ gOLEMath         => OLE-object-name for Math
 102 global gOLEOthers as String         '///+ gOLEOthers       => OLE-object-name for the others-entry
 103
 104 '/// * variables, for the applications
 105 Global gApplication as String       '///+ gApplication => included the tested application (DRAW, WRITER etc.)
 106 Global gNoNewDoc as Boolean         ' old
 107
 108 '/// * other variables
 109 Global gClient as Boolean           '///+ gClient => TRUE : Client will be tested; FALSE : files will be saved/loaded on clientside
 110 Global gClientLaden as Boolean      '///+ gClientLaden => TRUE = files will be saved/loaded on serverside (only for UNIX-systems) ; FALSE : files will be saved/loaded on clientside
 111 Global gClientUser as String        '///+ gClientUser => Username of Client-User
 112 Global gClientUserPWD as String     '///+ gClientUserPWD =>  password of Client-User
 113 Global gsClient as String           '///+ gsClient =>  path to the sclient.exe
 114 Global gClientAufUNIX as String     ' old
 115 Global sServerIni as String         ' old
 116
 117 Global gNetzInst as Boolean         '///+ gNetz => TRUE : Netinstallation will be tested; FALSE : normal full-version will be tested
 118 Global gNetzOfficePath as String    '///+ gNetzOfficePath => path to the Network-Installation
 119
 120 Global gSamePC as Boolean           '///+ gSamePC => TRUE : StarOffice and Testtool run on same mashine
 121 Global gPort as String              ' Portnumber for communication between Testtool and Office
 122 Global gHost as String              '///+ gHost => for remote-test : Hostname for Office-OS
 123 Global gPCName as String            '///+ gPCname => name for the mashine, where Testtool runs
 124
 125 '/// *
 126 Global gDasNicht                    '///+ gDasNicht => 0 the translation-mechanism will be activated
 127 Global gbSnapShot as Boolean        '///+ gbSnapShot => true Dialogtest-routines create screenshots
 128 Global gVersionsnummer as String    '///+ gVersionsnummer => full version number (major + minor + buildID)
 129 Global gMajor as string             '///+ gMajor: only something like 'src680'
 130 Global gMinor as string             '///+ gMinor: only something like 'm37'
 131 Global gBuild as integer            '///+ gBuild: only something like 4711
 132 Global gUser as String              '///+ gUser => User-LoginName (e.g. 'tz')
 133 Global gInputbox as Boolean         ' old
 134 Global sSchedule as String          ' old
 135 Global bDebugVersion as Boolean     '///+ bDebugVersion => TRUE : Debugversion; FALSE : normal Producktversion of Office
 136 Global gCWS as Boolean              '///+ gCWS = TRUE if a Child WorkSpace (CWS) has been detected.
 137 Global gStatusDatabase as Boolean   '/// gStatusDatabase = TRUE if the testscripts are running on a TT-Framework-server.
 138 Global gLocalStatusDatabase as string '///  <> "" set to a local path string, to work with a local status database
 139 Global gStatusFeatureLevel as Integer '///+ gStatusFeatureLevel : Controled from privateenvironment.inc
 140 Global gUseSysDlg                   '///+ gUseSysDlg => FALSE : use internal file-dialogs of StarOffice; => TRUE : use system-file-dialogs
 141 Global gOOO as boolean              '///+ gOOO => if an OpenOffice.org-version is tested, this variable is TRUE
 142 Global gOOoShutdownTimeOut as integer'///+ gOOoShutdownTimeOut => max. time to wait in seconds, after quiting OOo
 143 Global gOOoStartupTimeOut as integer'///+ gOOoStartupTimeOut => max. time to wait in seconds, for starting OOo
 144 Global gStartTheOffice as boolean '///+ gStartTheOffice => indicates an alternative startroutine is run
 145
 146 '///* variables only for creating the status-pages
 147 Global gTestDate as String          '///+ gTestDate : fix date of startup
 148 Global gTestTime as String          '///+ gTestTime : fix time of startup
 149 Global gTestName as String          '///+ gTestName : name of the test (must be set as parameter in hStatusIn())
 150 Global gTestAppArea as String       '///+ gTestAppArea : name of the testarea (e.g. writer, calc etc.) - (must be set as parameter in hStatusIn())
 151 Global gErrorSum as Integer         '///+ gErrorSum : last value of errors in a test
 152 Global gWarningSum as Integer       '///+ gWarningSum : last value of warnings in a test
 153 Global gQaErrorSum as Integer       '///+ gQaErrorSum : last value of qaErrors in a test
 154 Global gStatusDuration              '///+ gStatusDuration : starting time to get at the end the duration of a test
 155 Global gTestcaseStart as Date       '///+ gTestCaseDuration : starting time of the testcase
 156 Global glsStatusPage (32000) as String  '///+ glsStatusPage () : list for the output in the status-page
 157 Global gTestDescr as String         '///+ short descrition for the test
 158 Global gTestFileName as String      ' only a dummy variable, until GH give me a new method in testtool
 159 Global gDatabasePath as string      '///+ top directory, of location for wget and result database files
 160
 161 '///* Private environment values; values get set in qa/qatesttool/global/private/inc/privateenvironment.inc
 162 Global privateDatabaseServerName as string
 163 Global privateDatabaseServerIP as string
 164 Global privateProxyServer as string
 165 Global privateProxyPort as integer
 166 Global privateDatabasePath as string
 167 Global privateDatabaseServerPath as string
 168
 169 '///* Macro Security Settings - Symbolic names for security levels (constants)
 170 Global Const GC_MACRO_SECURITY_LEVEL_LOW      = 0  '///+ GC_MACRO_SECURITY_LEVEL_LOW:      Symbolic name for low macro security
 171 Global Const GC_MACRO_SECURITY_LEVEL_MEDIUM   = 1  '///+ GC_MACRO_SECURITY_LEVEL_MEDIUM:   Symbolic name for medium macro security
 172 Global Const GC_MACRO_SECURITY_LEVEL_HIGH     = 2  '///+ GC_MACRO_SECURITY_LEVEL_HIGH:     Symbolic name for high macro security
 173 Global Const GC_MACRO_SECURITY_LEVEL_VERYHIGH = 3  '///+ GC_MACRO_SECURITY_LEVEL_VERYHIGH: Symbolic name for very high macro security
 174 Global Const GC_MACRO_SECURITY_LEVEL_DEFAULT  = 2  '///+ GC_MACRO_SECURITY_LEVEL_DEFAULT:  Symbolic name for default macro security level
 175
 176 '///* OOo Improvement Program
 177 Global gOOoImprovementIsEnabled as boolean
 178
 179 '///* Performance flags
 180 Global GLOBAL_USE_NEW_SLEEP as boolean ' keep the old sleep() behavior
 181
 182 sub OnlyForDocuGVariables
 183 '///<b>System for the installed Office</b>
 184 '///<i>gPlatform</i>: Operatingsystem (internal shortkey)
 185 '///<i>gSYSName</i>: Name of Operatingsystems
 186 '///<i>gSystemPath</i>: Systempath
 187 '///<i>gPathSigne</i>: Pathsigne for the Operationsystem
 188 '///<i>gPlatGroup</i>: The systemgroup  for the OS  (e.g. 'unx' 'w95' etc.)
 189 '///<i>iSystemSprache</i>: Code for the systemlanguage (01 = en_us, 40 = de_de)
 190 '///<i>gSVersionIni</i>: Path to sversion.ini
 191
 192 '///<b>System for the Testtool</b>
 193 '///<i>gtSYSName</i>: Name of Testtool-Operationsystem
 194 '///<i>gtPlatform</i>: Operatingsystem (internal shortkey)
 195 '///<i>gtSystemPath</i>: Systempfad
 196 '///<i>gTesttoolIni</i>: Path to Testtool.ini
 197 '///<i>gtHidLstPath</i>: Path to hid.lst
 198
 199 '///<b>Settings for Crashreporter</b>
 200 '///<i>gUseProxy</i>: Value of [Crashreporter] 'UseProxy' from the testtool control file: Is TRUE or FALSE
 201 '///<i>gProxyServer</i>: Value of [Crashreporter] 'ProxyServer' from the testtool control file: string
 202 '///<i>gProxyPort</i>: Value of [Crashreporter] 'ProxyPort' from the testtool control file: string
 203 '///<i>gReturnAddress</i>: Value of [Crashreporter] 'ReturnAddress' from the testtool control file: string
 204 '///<i>gAllowContact</i>: Value of [Crashreporter] 'AllowContact' from the testtool control file: Is TRUE or FALSE
 205 '///<i>gConnectionType</i>: Value is depending on gUseProxy: TRUE = MANUALPROXY, FALSE = DIRECT
 206
 207 '///<b>Path - variables</b>
 208 '///<i>gOfficePath</i>: Includes the path of the Office-installation
 209 '///<i>gTesttoolPath</i>: Includes the path of the Testtool-directory (changed with ConvertPath)
 210 '///<i>oTesttoolPath</i>: Original Testtool-directory
 211 '///<i>sAppExe</i>: Includes the whole path to 'soffice.exe' or 'soffice'
 212 '///<i>sAppParameter</i>: Includes all parameters for the executable
 213 '///<i>sCapturePath</i>: Path for graphic-snapshots
 214 '///<i>gPrivateEnvironmentLocation</i>: Location for test environment special data and files
 215
 216 '///<b>Officevariables</b>
 217 '///<i>iSprache </i>: Code for the office-language (01=en_us, 49=de_de etc.)
 218 '///<i>bAsianLan</i>: If the office-language is an asian language (81, 82, 86, 88)</i>: TRUE
 219 '///<i>gLanguage</i>: The languagename for office language
 220 '///<i>gMacroSecurityLevel</i>: Macro Security Level (0: Low ... 3: Very High)
 221
 222 '///<b>global OLE-objectnames</b>
 223 '///<i>gOLEWriter</i>: OLE-object-name for Writer
 224 '///<i>gOLECalc</i>: OLE-object-name for Calc
 225 '///<i>gOLEImpress</i>: OLE-object-name for Impress
 226 '///<i>gOLEDraw</i>: OLE-object-name for Draw
 227 '///<i>gOLEChart</i>: OLE-object-name for Chart
 228 '///<i>gOLEMath</i>: OLE-object-name for Math
 229 '///<i>gOLEOthers</i>: OLE-object-name for the others-entry
 230
 231 '///<b>variables, for the applications</b>
 232 '///<i>gApplication</i>: Includes the tested application (DRAW, WRITER etc.)
 233
 234 '///<b>other variables</b>
 235 '///<i>gClient</i>:<ul><li>TRUE: Client will be tested</li><li>FALSE: Files will be saved/loaded on client side</li></ul>
 236 '///<i>gClientLaden</i>:<ul><li>TRUE: Files will be saved/loaded on server side (only for UNIX-systems)</li><li>FALSE: Files will be saved/loaded on client side</li></ul>
 237 '///<i>gClientUser</i>: Username of Client-User
 238 '///<i>gClientUserPWD</i>:  Password of Client-User
 239 '///<i>gsClient</i>:  Path to the sclient.exe
 240 '///<i>gNetz</i>:<ul><li>TRUE: Net installation will be tested</li><li>FALSE: Normal full/FAT-version will be tested</li></ul>
 241 '///<i>gNetzOfficePath</i>: Path to the Network-Installation
 242 '///<i>gSamePC</i>:<ul><li>TRUE: Office and Testtool run on same mashine</li></ul>
 243 '///<i>gHost</i>: (For remote-tests) Hostname for Office OE/OS
 244 '///<i>gPCname</i>: Name for the machine, where the Testtool runs
 245
 246 '///<b>Variables only for creating the status-pages</b>
 247 '///<i>gTestDate</i>: Fix date of startup
 248 '///<i>gTestTime</i>: Fix time of startup
 249 '///<i>gTestName</i>: Name of the test (must be set as parameter in <i>hStatusIn()</i>)
 250 '///<i>gTestAppArea</i>: Name of the office module (e.g. writer, calc etc.) - (must be set as parameter in <i>hStatusIn()</i>)
 251 '///<i>gErrorSum</i>: Last value of errors in a test
 252 '///<i>gWarningSum</i>: Last value of warnings in a test
 253 '///<i>gStatusDuration</i>: Starting time to get at the end the duration of a test
 254 '///<i>glsStatusPage()</i>: List for the output in the status-page
 255 '///<i>gStatusFeatureLevel</i> : Controled from privateenvironment.txt
 256
 257 '///<b>Specials</b>
 258 '///<i>gDasNicht</i>: 0 the translation-mechanism will be activated
 259 '///<i>gbSnapShot as Boolean</i>:<ul><li>TRUE: Dialogtest-routines create screenshots</li></ul>
 260 '///<i>gVersionsnummer</i>: Full version number (major + minor + buildID)
 261 '///<i>gUser</i>: User login name (e.g. 'tz')
 262 '///<i>bDebugVersion</i>:<ul><li>TRUE: Debugversion</li><li>FALSE: normal Producktversion of office</li></ul>
 263 '///<i>gUseSysDlg</i>:<ul><li>FALSE: Use internal file-dialogs of the office</li><li>TRUE: Use system-file-dialogs</li></ul>
 264 '///<i>gOOO</i>: If an OpenOffice.org-version has been detected, this variable is TRUE
 265 '///<i>gOOoShutdownTimeOut</i>: Max. time to wait in seconds, after quiting OOo
 266 '///<i>gOOoStartupTimeOut</i>: Max. time to wait in seconds, for starting OOo
 267 end sub
 268