testautomation/framework/tools/includes/toolbar_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: toolbar_tools.inc,v $
  10 '*
  11 '* $Revision: 1.2 $
  12 '*
  13 '* last change: $Author: obo $ $Date: 2008-07-25 09:56:35 $
  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 : global update test (Standardbar)
  37 '*
  38 '\***************************************************************************
  39
  40 function hAccessStandardBar() as boolean
  41
  42     '///<h3>Verify that the Standard Bar exists</h3>
  43     '///<i>This function works for all gApplications</i><br>
  44     '///<u>Input</u>:
  45     '///<ol>
  46     '///+<li>Nothing</li>
  47     '///</ol>
  48     '///<u>Returns</u>:
  49     '///<ol>
  50     '///+<li>Errorcondition (boolean)</li>
  51     '///<ul>
  52     '///+<li>TRUE if StandardBar exists</li>
  53     '///+<li>FALSE if standardBar does not exist</li>
  54     '///</ul>
  55     '///</ol>
  56     '///<u>Description</u>:
  57     '///<ul>
  58     const CFN = "hAccessStandardBar::"
  59     dim brc as boolean
  60
  61     printlog( CFN & "Enter" )
  62
  63     '///+<li>Open a new document</li>
  64     hCreateDocument()
  65
  66     '///+<li>Try to access the standardbar (query .exists())</li>
  67     kontext "StandardBar"
  68     if ( StandardBar.exists() ) then
  69         if ( standardbar.isVisible() ) then
  70             printlog( CFN & "StandardBar is visible. Good." )
  71             brc = true
  72         else
  73             warnlog( "The StandardBar is not visible in " & gApplication )
  74             brc = false
  75         endif
  76     else
  77         warnlog( "The StandardBar does not exist in " & gApplication )
  78         brc = false
  79     endif
  80
  81     '///+<li>Close the navigator</li>
  82     hCloseNavigator()
  83
  84     '///+<li>Close the document</li>
  85     hDestroyDocument()
  86     hAccessStandardBar() = brc
  87     printlog( CFN & "Exit" )
  88     '///</ul>
  89
  90 end function
  91
  92 '*******************************************************************************
  93
  94 function hResetStandardBar() as boolean
  95
  96     '///<h3>Reset the Standard Bar to default configuration</h3>
  97     '///<u>Input</u>:
  98     '///<ol>
  99     '///+<li>Nothing</li>
 100     '///</ol>
 101     '///<u>Returns</u>:
 102     '///<ol>
 103     '///+<li>Errorcondition (boolean)</li>
 104     '///<ul>
 105     '///+<li>Always TRUE as no errorconditions are handled yet</li>
 106     '///</ul>
 107     '///</ol>
 108     '///<u>Description</u>:
 109     '///<ul>
 110
 111     const CFN = "hResetStandardBar::"
 112
 113     printlog( CFN & "Enter" )
 114
 115     '///+<li>Create a new document</li>
 116     hInitSingleDoc()
 117     printlog " - Standardbar"
 118
 119     kontext "standardbar"
 120     if ( Standardbar.exists() ) then
 121
 122         '///+<li>Open the context menu on Standardbar</li>
 123         Standardbar.OpenContextmenu
 124         sleep( 1 )
 125
 126         '///+<li>Click on 2. entry (Cutomize Toolbar)</li>
 127         hMenuselectNr (2)
 128         sleep( 1 )
 129
 130         kontext
 131         Active.SetPage TabCustomizeToolbars
 132         sleep( 1 )
 133
 134         '///+<li>Toggle to 'Toolbars' tab page.</li>
 135         kontext "TabCustomizeToolbars"
 136         if TabCustomizeToolbars.Exists( 2 ) then
 137             sleep( 1 )
 138
 139             '///+<li>Press in first section '... Toolbars' the 'toolbar'-button</li>
 140             MenuBtn.Click
 141             sleep( 1 )
 142
 143             '///+<li>A drop down menu will be opened.</li>
 144             '///+<li>Select the first enabled menu entry which should be 'Restore...'</li>
 145             hMenuSelectNr(1)
 146             sleep( 1 )
 147
 148             kontext
 149             if ( active.exists( 2 ) ) then
 150                 if Active.GetRT = 304 then
 151
 152                     '///+<li>Press Yes button on verification dialog.</li>
 153                     Active.Yes
 154                 end if
 155             else
 156                 warnlog( "No verification comes up if the RESET button has been pressed!" )
 157             end if
 158
 159             '///+<li>Close 'Toolbars' tab page and the dialog with OK.</li>
 160             kontext "tabcustomizetoolbars"
 161             TabCustomizeToolbars.OK
 162         else
 163             warnlog( "Cutomuze Toolbar not open (from context menu)" )
 164             'Closing the Context menu if the dialog does not come up.
 165             Menuselect(0)
 166         endif
 167
 168     else
 169         warnlog( CFN & "Could not access Standardbar" )
 170     endif
 171
 172     '///+<li>Close document.</li>
 173     hDestroyDocument()
 174     hResetStandardBar() = true
 175     printlog( CFN & "Exit" )
 176     '///</ul>
 177
 178 end function
 179
 180 '*******************************************************************************
 181
 182 function hStandardbarItemGetCount() as integer
 183
 184     '///<h3>Update test: Get the number of items in the StandardBar</h3>
 185     '///<i>Starting point: Any plain document</i><br>
 186     '///<u>Input</u>:
 187     '///<ol>
 188     '///+<li>Nothing</li>
 189     '///</ol>
 190     '///<u>Returns</u>:
 191     '///<ol>
 192     '///+<li>Number of items on the toolbar (integer)</li>
 193     '///<ul>
 194     '///+<li>No errorhandling is done. Beware.</li>
 195     '///</ul>
 196     '///</ol>
 197     '///<u>Description</u>:
 198     '///<ul>
 199
 200     dim iToolbarItemsCurrent as integer
 201     dim iToolbarItemsExpected as integer
 202         iToolbarItemsExpected = 30
 203
 204     const CFN = "hStandardbarItemGetCount::"
 205
 206     gApplication = "WRITER"
 207     printlog( CFN & "Enter" )
 208
 209     '///+<li>Look for additional icons on the standardbar (through extensions)</li>
 210     printlog( CFN & "Count all items at the Standardbar" )
 211
 212     '///+<li>Open the context menu on the Standardbar</li>
 213     Kontext "Standardbar"
 214     Standardbar.OpenContextmenu()
 215
 216     '///+<li>Select the 1. entry</li>
 217     hMenuselectNr( 1 )
 218
 219     '///+<li>Count all entries ( there must be 30 entries )</li>
 220     iToolbarItemsCurrent = 0
 221     iToolbarItemsCurrent = hMenuItemGetCount()
 222
 223     ' StarOffice/StarSuite come with a preinstalled extension beginning with build
 224     ' 9181. This extension is not shipped with the Solaris patches as this would
 225     ' violate Sun's patching policy. So StarSuite/StarOffice now have 30 or 31
 226     ' items on the standardbar, OOo and its spinoffs have 30.
 227
 228
 229     if ( iToolbarItemsCurrent = iToolbarItemsExpected ) then
 230         printlog( CFN & "Correct number of items on the StandardBar. Good" )
 231     else
 232         warnlog( CFN & "Expected: " & iToolbarItemsExpected & _
 233                 " entries, found: " & iToolbarItemsCurrent )
 234     endif
 235
 236     '///+<li>close the context menu</li>
 237     hMenuClose()
 238     hStandardbarItemGetCount() = iToolbarItemsCurrent
 239     printlog( CFN & "Exit" )
 240     '///</ul>
 241
 242 end function
 243
 244 '*******************************************************************************
 245
 246 function hToggleToolbarItem( iMenuPos as integer )
 247
 248     '///<h3>Update test: Toggle an icon on the Standardbar (on/off)</h3>
 249     '///<i>Starting point: Any plain document</i><br>
 250     '///<u>Input</u>:
 251     '///<ol>
 252     '///+<li>Position of the item in the menu (integer)</li>
 253     '///</ol>
 254     '///<u>Returns</u>:
 255     '///<ol>
 256     '///+<li>Nothing</li>
 257     '///</ol>
 258     '///<u>Description</u>:
 259     '///<ul>
 260
 261     const CFN = "hToggleToolbarItem::"
 262     dim iItemsInMenu as integer
 263
 264     printlog( CFN & "Enter with option (Menu position): " & iMenuPos )
 265
 266     '///+<li>Open the context menu of the standard bar</li>
 267     Kontext "Standardbar"
 268     Standardbar.OpenContextmenu()
 269
 270     '///+<li>Retrieve the number of items in the menu</li>
 271     iItemsInMenu = hMenuItemGetCount()
 272
 273     ' in case the toolbar does not fit into the window we have more items
 274     ' (those that are invisible will be listed as context menu entries),
 275     ' the menuitem (invisible items) is placed at position nItems - 3
 276     '///+<li>Take the number of items -3, select the entry</li>
 277     hMenuselectNr( iItemsInMenu - 3 )
 278
 279     '///+<li>Select the provided menu position</li>
 280     hMenuselectNr( iMenuPos )
 281     printlog( CFN & "Exit" )
 282     '///</ul>
 283
 284 end function
 285
 286 '*******************************************************************************
 287
 288 function hStandardbarLoadUrl() as boolean
 289
 290     '///<h3>Update test: Access the url-entryfield</h3>
 291     '///<i>Starting point: Any plain document</i><br>
 292     '///<u>Input</u>:
 293     '///<ol>
 294     '///+<li>Nothing</li>
 295     '///</ol>
 296     '///<u>Returns</u>:
 297     '///<ol>
 298     '///+<li>Nothing</li>
 299     '///</ol>
 300     '///<u>Description</u>:
 301     '///<ul>
 302
 303
 304     ' this function tries to write to the url-EntryField. This should fail,
 305     ' because the item is not visible. Then the item should be enabled,
 306     ' written to and disabled again (no use of reset toolbar here, this is
 307     ' done in another testcase
 308
 309     dim iItemMenuPos as integer
 310     iItemMenuPos = 1
 311
 312     const ITEM_MENU_POSITION = 1
 313     const CFN = "hStandardbarLoadUrl::"
 314
 315     printlog( CFN & "Enter" )
 316
 317     '///+<li>Write to URL-Filed (fails: Entryfiled is not visible)</li>
 318     try
 319         Kontext "Standardbar"
 320         URLEingabe.settext( "Should not work" )
 321         warnlog( CFN & "The Load URL EntryField is visible and active" )
 322     catch
 323         printlog( CFN & "The Load URL EntryField is not visible. Good." )
 324     endcatch
 325
 326     '///+<li>add the control to the standardbar</li>
 327     printlog( CFN & "activate load URL" )
 328     hToggleToolbarItem( ITEM_MENU_POSITION )
 329
 330     '///+<li>verify its existence by entering some text</li>
 331     Kontext "Standardbar"
 332     try
 333         URLEingabe.settext( "Should work" )
 334         printlog( CFN & "The Load URL REntryFiled is visible and active. Good." )
 335     catch
 336         warnlog( CFN & "Could not write to 'load url' control" )
 337     endcatch
 338
 339     '///+<li>remove the control from the standardbar</li>
 340     printlog( CFN & "Deactivate load URL" )
 341     hToggleToolbarItem( ITEM_MENU_POSITION )
 342     Kontext "Standardbar"
 343
 344     '///+<li>try to modify non existing object, failure expected</li>
 345     try
 346         Kontext "Standardbar"
 347         URLEingabe.settext( "Should not work" )
 348         warnlog( CFN & "The Load URL EntryField is visible and active." )
 349     catch
 350         printlog( CFN & "The Load URL EntryField is not visible. Good." )
 351     endcatch
 352     printlog( CFN & "Exit" )
 353     '///</ul>
 354
 355 end function
 356
 357 '*******************************************************************************
 358
 359 function hStandardbarNewDialog()
 360
 361     '///<h3>Update test: New from Template via StandardBar</h3>
 362     '///<i>Starting point: Plain document</i><br>
 363     '///<u>Input</u>:
 364     '///<ol>
 365     '///+<li>Nothing</li>
 366     '///</ol>
 367     '///<u>Returns</u>:
 368     '///<ol>
 369     '///+<li>Nothing</li>
 370     '///</ol>
 371     '///<u>Description</u>:
 372     '///<ul>
 373
 374     const CFN = "hStandardbarNewDialog::"
 375     const ITEM_MENU_POSITION = 3
 376
 377     printlog( CFN & "Enter" )
 378
 379     '///+<li>Click on &quot;New from Template&quot;-button (fails, it is not visible)</li>
 380     try
 381         NeuDialog.Click()
 382         warnlog( CFN & "The 'New from Template'-button should not be visible." )
 383     catch
 384         printlog( CFN & "The control is not present or active." )
 385     endcatch
 386
 387     '///+<li>add the control to the standardbar</li>
 388     printlog( CFN & "activate New from Template button" )
 389     hToggleToolbarItem( ITEM_MENU_POSITION )
 390
 391     '///+<li>click the button</li>
 392     Kontext "Standardbar"
 393     sleep( 1 )
 394     try
 395         NeuDialog.click()
 396     catch
 397     endcatch
 398
 399     '///+<li>handle possible dialogs (there should never be one)</li>
 400     kontext "Active"
 401     if ( active.exists( 1 ) ) then
 402         warnlog( CFN & "Unexpected active" )
 403         printlog( CFN & active.gettext() )
 404         try
 405             printlog( CFN & "Closing dialog" )
 406             active.ok()
 407         catch
 408             warnlog( CFN & "Unknown dialog blocks test, now crashing" )
 409         endcatch
 410     endif
 411
 412     '///+<li>close the templates and samples dialog</li>
 413     printlog( CFN & "Close templates and samples (cancel)" )
 414     Kontext "TemplateAndDocuments"
 415     if ( TemplateAndDocuments.Exists( 5 ) ) then
 416         TemplateAndDocuments.cancel()
 417     else
 418         warnlog( CFN & "The 'Template and Documents'-dialog was not activated" )
 419     endif
 420
 421     '///+<li>finally remove the button from the toolbar</li>
 422     printlog( CFN & "Deactivate New from Template button" )
 423     hToggleToolbarItem( ITEM_MENU_POSITION )
 424     Kontext "Standardbar"
 425     '///</ul>
 426
 427 end function
 428
 429 '*******************************************************************************
 430
 431 function hStandardbarSaveAs()
 432
 433     '///<h3>Update test: SaveAs button on StandardBar</h3>
 434     '///<i>Starting point: Any plain document</i><br>
 435     '///<u>Input</u>:
 436     '///<ol>
 437     '///+<li>Nothing</li>
 438     '///</ol>
 439     '///<u>Returns</u>:
 440     '///<ol>
 441     '///+<li>Nothing</li>
 442     '///</ol>
 443     '///<u>Description</u>:
 444     '///<ul>
 445
 446
 447     dim bBreakOnError as boolean
 448
 449     const ITEM_MENU_POSITION = 6
 450     const CFN = "hStandardbarSaveAs::"
 451
 452     printlog( CFN & "Enter" )
 453
 454     '///+<li>Click on SaveAs (fails, item is not visible)</li>
 455     try
 456         SpeichernAls.Click()
 457     catch
 458         printlog( CFN & "The control is not present, good." )
 459     endcatch
 460
 461     kontext "SpeichernDlg"
 462     if ( SpeichernDlg.exists( 1 ) ) then
 463         warnlog( "#i46363# (?)The 'SaveAs'-button should be invisible." )
 464         SpeichernDlg.cancel()
 465     else
 466
 467         '///+<li>Add the control to the standardbar</li>
 468         printlog( CFN & "Activate 'Save As' button" )
 469         hToggleToolbarItem( ITEM_MENU_POSITION )
 470
 471         '///+<li>Click the button</li>
 472         Kontext "Standardbar"
 473         hWaitForObject( SpeichernAls , 5000 )
 474         SpeichernAls.click()
 475
 476         '///+<li>Close the save-as dialog</li>
 477         printlog( CFN & "Close Save As (cancel)" )
 478         Kontext "SpeichernDlg"
 479         if ( SpeichernDlg.Exists( 2 ) ) then
 480             SpeichernDlg.cancel()
 481         else
 482             qaerrorlog( "Retrying" )
 483             Kontext "Standardbar"
 484             SpeichernAls.click()
 485             Kontext "SpeichernDlg"
 486             if ( SpeichernDlg.exists( 1 ) ) then
 487                 printlog( "FileSaveAs dialog is open" )
 488                 SpeichernDlg.cancel()
 489             else
 490                 warnlog( CFN & "The 'Save As'-dialog was not activated" )
 491             endif
 492         endif
 493
 494         '///+<li>Remove the button from the toolbar</li>
 495         printlog( CFN & "Deactivate 'Save as' button" )
 496         hToggleToolbarItem( ITEM_MENU_POSITION )
 497
 498     endif
 499
 500     Kontext "Standardbar"
 501     printlog( CFN & "Exit" )
 502     '///</ul>
 503
 504 end function
 505
 506
 507
 508