testautomation/framework/tools/includes/scriptorganizer_tools.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: scriptorganizer_tools.inc,v $
  10 '*
  11 '* $Revision: 1.2 $
  12 '*
  13 '* last change: $Author: jsk $ $Date: 2008-06-20 08:03:54 $
  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 : joerg.skottke@sun.com
  35 '*
  36 '*  short description : Test scripting-organizers / document-attached scripts
  37 '*
  38 '\******************************************************************************
  39
  40 function hCreateScriptingObject( cName as string ) as boolean
  41
  42     '///<h3>Create a new scripting object for the current module</h3>
  43     '///<i>Starting point: Script organizer is open, module selected</i><br>
  44     '///<u>Input</u>:
  45     '///<ol>
  46     '///+<li>Name of the module (string)</li>
  47     '///<ul>
  48     '///+<li>Any name the organizer can accept</li>
  49     '///</ul>
  50     '///</ol>
  51     '///<u>Returns</u>:
  52     '///<ol>
  53     '///+<li>Errorcondition</li>
  54     '///<ul>
  55     '///+<li>TRUE on success</li>
  56     '///+<li>FALSE on failure or invalid user input</li>
  57     '///</ul>
  58     '///</ol>
  59     '///<u>Description</u>:
  60     '///<ul>
  61
  62
  63     const CFN = "hNewScriptingObject::"
  64     dim brc as boolean
  65
  66     '///+<li>Verify the function parameter</li>
  67     if ( cName = "" ) then
  68         warnlog( CFN & "Empty Name for scripting object passed to function" )
  69         hCreateScriptingObject() = false
  70         exit function
  71     endif
  72
  73     '///+<li>Verify that the &quot;Create...&quot; button exists</li>
  74     Kontext "ScriptOrganizer"
  75     if ( not PBCreate.exists( 2 ) ) then
  76         warnlog( CFN & "Create-button does not exist" )
  77         hCreateScriptingObject() = false
  78         exit function
  79     endif
  80
  81     '///+<li>Verify that the &quot;Create...&quot; button is enabled</li>
  82     if ( PBCreate.isEnabled() ) then
  83
  84         '///+<li>Click &quot;Create...&quot; to open the naming dialog</li>
  85         PBCreate.click()
  86
  87         '///+<li>Name the new script</li>
  88         Kontext "ScriptNameDlg"
  89         if ( ScriptNameDlg.exists( 2 ) ) then
  90
  91             EFObjectName.setText( cName )
  92             ScriptNameDlg.OK()
  93             brc = true
  94
  95         endif
  96
  97     else
  98         printlog( CFN & "Button is disabled" )
  99         brc = false
 100     endif
 101
 102     '///+<li>Verify that we are back on the script organizer</li>
 103     kontext "ScriptOrganizer"
 104     if ( not ScriptOrganizer.exists( 2 ) ) then
 105         warnlog( CFN & "Could not return to ScriptOrganizer" )
 106         brc = false
 107     endif
 108
 109    hCreateScriptingObject() = brc
 110    '///</ul>
 111
 112 end function
 113
 114 '*******************************************************************************
 115
 116 function hRenameScriptingObject( cName as string ) as boolean
 117
 118     '///<h3>Rename the selected script</h3>
 119     '///<i>Starting point: Script organizer is open, a script is selected</i><br>
 120     '///<u>Input</u>:
 121     '///<ol>
 122     '///+<li>New name of the script</li>
 123     '///<ul>
 124     '///+<li>Any name the script organizer does accept</li>
 125     '///</ul>
 126     '///</ol>
 127     '///<u>Returns</u>:
 128     '///<ol>
 129     '///+<li>Errorcondition</li>
 130     '///<ul>
 131     '///+<li>TRUE on success</li>
 132     '///+<li>FALSE on failure or invalid user input</li>
 133     '///</ul>
 134     '///</ol>
 135     '///<u>Description</u>:
 136     '///<ul>
 137
 138     use "global\tools\includes\optional\t_stringtools.inc"
 139
 140     const CFN = "hRenameScriptingObject::"
 141     dim cMessage as string
 142     dim brc as boolean
 143
 144     brc = true
 145
 146     '///+<li>Verify the function parameter</li>
 147     if ( cName = "" ) then
 148         warnlog( CFN & "Empty Name for scripting object passed to function" )
 149         hRenameScriptingObject() = false
 150         exit function
 151     endif
 152
 153     '///+<li>Verify that the &quot;Rename...&quot; button exists</li>
 154     Kontext "ScriptOrganizer"
 155     if ( not PBRename.exists( 2 ) ) then
 156         warnlog( CFN & "Rename button does not exist, aborting" )
 157         hRenameScriptingObject() = false
 158         exit function
 159     endif
 160
 161     '///+<li>Verify that the &quot;Rename...&quot; button is enabled</li>
 162     if ( PBRename.isEnabled() ) then
 163
 164         '///+<li>Click &quot;Rename...&quot; to open the renaming dialog</li>
 165         PBRename.click()
 166
 167         '///+<li>Name the new script</li>
 168         Kontext "ScriptNameDlg"
 169         if ( ScriptNameDlg.exists( 2 ) ) then
 170
 171             EFObjectName.setText( cName )
 172             ScriptNameDlg.OK()
 173
 174             '///+<li>Test for any messagebox, try to close it with OK</li>
 175             kontext "active"
 176             if ( active.exists( 1 ) ) then
 177                 cMessage = hRemoveLineBreaks( active.getText )
 178                 printlog( CFN & cMessage )
 179                 brc = false
 180                 active.OK()
 181             endif
 182
 183         endif
 184
 185     endif
 186
 187     '///+<li>Verify that we are back on the script organizer</li>
 188     kontext "ScriptOrganizer"
 189     if ( not ScriptOrganizer.exists( 2 ) ) then
 190         warnlog( CFN & "Could not return to ScriptOrganizer" )
 191         brc = false
 192     endif
 193
 194     hRenameScriptingObject() = brc
 195     '///</ul>
 196
 197 end function
 198
 199 '*******************************************************************************
 200
 201 function hDeleteScript( cName as string , bSuccess as boolean ) as boolean
 202
 203     '///<h3>Delete the selected script</h3>
 204     '///<i>Starting point: Script organizer is open, a script is selected</i><br>
 205     '///<u>Input</u>:
 206     '///<ol>
 207     '///+<li>Name of the script (string)</li>
 208     '///<ul>
 209     '///+<li>For debugging purpose only, the name will be used for warnlogs</li>
 210     '///+<li>May be an empty string (not recommended)</li>
 211     '///</ul>
 212     '///+<li>Expected result (boolean)</li>
 213     '///<ul>
 214     '///+<li>TRUE: The script is expected to be deleted without warnings/errors</li>
 215     '///+<li>FALSE: The script should not be deletable</li>
 216     '///</ul>
 217     '///</ol>
 218     '///<u>Returns</u>:
 219     '///<ol>
 220     '///+<li>Errorcondition (boolean) - see description</li>
 221     '///<ul>
 222     '///+<li>TRUE on success (expected outcome)</li>
 223     '///+<li>FALSE on failure</li>
 224     '///</ul>
 225     '///</ol>
 226     '///<u>Description</u>:
 227     '///<ul>
 228
 229     use "global\tools\includes\optional\t_stringtools.inc"
 230
 231     const CFN = "hDeleteScript::"
 232     dim iPos as integer
 233     dim cMessage as string
 234
 235     '///+<li>Test for the possible conditions:</li>
 236     '///<ol>
 237     '///+<li>Delete is correctly enabled (success)</li>
 238     kontext "ScriptOrganizer"
 239     if ( PBDelete.isEnabled() and bSuccess ) then
 240
 241         PBDelete.click()
 242         kontext "active"
 243         cMessage = active.getText()
 244         cMessage = hRemoveLineBreaks( cMessage )
 245         printlog( CFN & cMessage )
 246         active.yes()
 247
 248         kontext "active"
 249         if ( active.exists( 1 ) ) then
 250             cMessage = active.getText()
 251             cMessage = hRemoveLineBreaks( cMessage )
 252             qaerrorlog( CFN & "Message: Failed to delete object: " & cName )
 253             printlog( CFN & cMessage )
 254             active.ok()
 255         endif
 256         hDeleteScript() = true
 257
 258     '///+<li>Delete is disabled correctly (success)</li>
 259     elseif ( ( not PBDelete.isEnabled() ) and ( not bSuccess ) ) then
 260
 261         printlog( CFN & "Delete-Button disabled for non-deletable object: " & cName )
 262         hDeleteScript() = true
 263
 264     '///+<li>Delete is enabled but should not be (failure)</li>
 265     elseif ( PBDelete.isEnabled() and ( not bSuccess ) ) then
 266
 267         PBDelete.click()
 268
 269         kontext "active"
 270         if ( active.exists( 1 ) ) then
 271             cMessage = active.getText()
 272             cMessage = hRemoveLineBreaks( cMessage )
 273             printlog( CFN & "Delete-Button enabled for non deletable object" )
 274             printlog( CFN & cMessage )
 275             active.yes()
 276         endif
 277
 278         kontext "active"
 279         if ( active.exists( 2 ) ) then
 280             cMessage = active.getText()
 281             cMessage = hRemoveLineBreaks( cMessage )
 282             printlog( CFN & "Message: Failed to delete object" )
 283             printlog( CFN & cMessage )
 284             active.ok()
 285         endif
 286         hDeleteScript() = false
 287
 288     '///+<li>Delete is incorrectly disabled (failure)</li>
 289     elseif ( ( not PBDelete.isEnabled() ) and bSuccess ) then
 290
 291         printlog( CFN & "Delete-Button disabled for deletable object" )
 292         hDeleteScript() = false
 293
 294     else
 295
 296         warnlog( CFN & "Unknown condition in if-statement" )
 297         hDeleteScript() = false
 298
 299     endif
 300     '///</ol>
 301     '///</ul>
 302
 303 end function
 304
 305 '*******************************************************************************
 306
 307 function hOpenScriptOrganizer( iDialog as integer ) as boolean
 308
 309     '///<h3>Open the ScriptOrganizers and verify that they are open</h3>
 310     '///<i>Starting point: Any document</i><br>
 311     '///<u>Input</u>:
 312     '///<ol>
 313     '///+<li>Dialog-ID (integer)</li>
 314     '///<ul>
 315     '///+<li>1 = BeanShell organizer</li>
 316     '///+<li>2 = JavaScript organizer</li>
 317     '///+<li>3 = Python script organizer</li>
 318     '///</ul>
 319     '///</ol>
 320     '///<u>Returns</u>:
 321     '///<ol>
 322     '///+<li>Errorcondition</li>
 323     '///<ul>
 324     '///+<li>TRUE if the expected organizer is open</li>
 325     '///+<li>FALSE if the expected organizer is not open</li>
 326     '///</ul>
 327     '///</ol>
 328     '///<u>Description</u>:
 329     '///<ul>
 330
 331     const CFN = "hOpenScriptOrganizer::"
 332
 333     '///<li>Call the associated slot</li>
 334     select case iDialog
 335     case 1 : ToolsMacrosOrganizeMacrosBeanShell
 336     case 2 : ToolsMacrosOrganizeMacrosJavaScript
 337     case 3 : ToolsMacrosOrganizeMacrosPython
 338     end select
 339
 340     '///<li>Verify that the dialog is open, return TRUE if yes</li>
 341     kontext "ScriptOrganizer"
 342     if ( ScriptOrganizer.exists( 5 ) ) then
 343         hOpenScriptOrganizer() = true
 344         printlog( CFN & "Dialog is open" )
 345     else
 346         hopenScriptOrganizer() = false
 347         warnlog( CFN & "Slot failed, dialog not open" )
 348     endif
 349
 350     '///</ul>
 351
 352 end function
 353
 354 '*******************************************************************************
 355
 356 function hCloseScriptOrganizer() as boolean
 357
 358     '///<h3>Close a Script Organizer (Cancel)</h3>
 359     '///<i>Starting point: Any open Script Organizer</i><br>
 360     '///<u>Input</u>:
 361     '///<ol>
 362     '///+<li>Nothing</li>
 363     '///</ol>
 364     '///<u>Returns</u>:
 365     '///<ol>
 366     '///+<li>Errorcondition (boolean)</li>
 367     '///<ul>
 368     '///+<li>TRUE if the Script Organizer was closed</li>
 369     '///+<li>FALSE if the Script Organizer is still open</li>
 370     '///</ul>
 371     '///</ol>
 372     '///<u>Description</u>:
 373     '///<ul>
 374
 375
 376     const CFN = "hCloseScriptOrganizer::"
 377
 378     hCloseScriptOrganizer() = false
 379
 380     '///+<li>Try to close the script </li>
 381     kontext "ScriptOrganizer"
 382     if ( ScriptOrganizer.exists( 5 ) ) then
 383         ScriptOrganizer.cancel()
 384         hCloseScriptOrganizer() = true
 385     endif
 386
 387     '///</ul>
 388
 389 end function
 390
 391 '*******************************************************************************
 392
 393 function hOpenRunMacroDialog() as boolean
 394
 395     '///<h3>Open the &quot;Run Macro&quot; dialog</h3>
 396     '///<i>Starting point: Any document</i><br>
 397     '///<u>Input</u>:
 398     '///<ol>
 399     '///+<li>Nothing</li>
 400     '///</ol>
 401     '///<u>Returns</u>:
 402     '///<ol>
 403     '///+<li>Errorcondition</li>
 404     '///<ul>
 405     '///+<li>TRUE if dialog is open</li>
 406     '///+<li>FALSE if the Script Selector does not exist</li>
 407     '///</ul>
 408     '///</ol>
 409     '///<u>Description</u>:
 410     '///<ul>
 411
 412
 413     '///+<li>Execute the ToolsMacrosRunMacro slot</li>
 414     ToolsMacrosRunMacro
 415
 416     '///+<li>Verify that the dialog is present</li>
 417     kontext "ScriptSelector"
 418     if ( ScriptSelector.exists( 2 ) ) then
 419         hOpenRunMacroDialog() = true
 420     else
 421         hOpenRunMacroDialog() = false
 422     endif
 423     '///</ul>
 424
 425 end function