testautomation/global/tools/includes/optional/t_docfuncs.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: t_docfuncs.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsk $ $Date: 2008-06-20 07:57:47 $
  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 : misc functions to handle documents
  37 '*
  38 '\******************************************************************************
  39
  40 private const VERBOSE = FALSE
  41
  42 function hUseImpressAutopilot( bEnable as boolean ) as boolean
  43
  44     '///<h3>Enable/disable the Impress Autopilot in Tools/Options</h3>
  45     '///<i>Starting point: Any plain document</i>
  46     '///<ul>
  47     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hUseImpressAutopilot::"
  48
  49     if ( VERBOSE ) then printlog( CFN & "Enter" )
  50
  51     '///+<li>Create a new IMPRESS document</li>
  52     gApplication = "IMPRESS"
  53     hCreateDocument()
  54
  55     '///+<li>Open Tools/Options, go to Presentataion/General page</li>
  56     ToolsOptions
  57     hToolsOptions( gApplication , "General" )
  58
  59     '///+<li>Check or uncheck to start with autopilot</li>
  60     Kontext "TabSonstigesDraw"
  61     if ( mitAutopilotStarten.exists( 2 ) ) then
  62
  63         if ( bEnable ) then
  64             mitAutopilotStarten.check()
  65             printlog( CFN & "Enable Impress Autopilot" )
  66         else
  67             mitAutopilotStarten.uncheck()
  68             printlog( CFN & "Disable Impress Autopilot" )
  69         endif
  70
  71         '///+<li>Return Status of Checkbox (checked=TRUE)</li>
  72         hUseImpressAutopilot() = mitAutopilotStarten.isChecked()
  73
  74     else
  75
  76         warnlog( CFN & "Cannot find Autopilot Checkbox" )
  77
  78     endif
  79
  80     '///+<li>Close Tools/Options</li>
  81     Kontext "OptionenDlg"
  82     OptionenDlg.OK()
  83
  84     '///+<li>Close IMPRESS document</li>
  85     hDestroyDocument()
  86
  87     '///+<li>Returncode is undefined</li>
  88     if ( VERBOSE ) then printlog( CFN & "Exit" )
  89     '///</ul>
  90
  91 end function
  92
  93 '*******************************************************************************
  94
  95 function hCloseNavigator() as boolean
  96
  97     '///<h3>Function to close the navigator</h3>
  98     '///<i>Starting point: Any document</i>
  99     '///<ul>
 100     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hCloseNavigator::"
 101
 102     if ( VERBOSE ) then printlog( CFN & "Enter" )
 103
 104     '///+<li>close the navigator if found</li>
 105     Kontext "Navigator"
 106     if ( Navigator.Exists() ) then
 107         Navigator.Close()
 108         printlog( CFN & "Closed Navigator" )
 109     else
 110         printlog( CFN & "Navigator not present" )
 111     endif
 112
 113     '///+<li>verify that the navigator is indeed closed, return true on success</li>
 114     Kontext "Navigator"
 115     if ( Navigator.exists() ) then
 116         hCloseNavigator() = false
 117         warnlog( CFN & "Failed to close Navigator, it is still open." )
 118     else
 119         hCloseNavigator() = true
 120     endif
 121
 122     if ( VERBOSE ) then printlog( CFN & "Exit" )
 123     '///</ul>
 124
 125 end function
 126
 127 '*******************************************************************************
 128
 129 function hNumericDocType( doctype as integer ) as string
 130
 131     '///<h3>Convert a numeric expression to a gApplication</h3>
 132     '///<i>BEWARE: This is a core function used by many testcases!</i><br>
 133     '///<u>Using file: global/input/applications.txt as reference</u>
 134     '///<ul>
 135
 136     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hNumericDocType::"
 137
 138     dim sFile as string
 139         sFile = gTesttoolPath & "global\input\applications.txt"
 140         sFile = convertpath( sFile )
 141
 142     dim sList( 100 ) as string
 143     dim iDocTypes as integer
 144
 145     if ( VERBOSE ) then printlog( CFN & "Enter" )
 146
 147     '///+<li>Retrieve matching list from file</li>
 148     hGetDataFileSection( sFile , sList() , "application" , "" , "" )
 149     iDocTypes = val( sList( 0 ) )
 150
 151     '///+<li>Verify that the functionparameter (documenttype) is valid</li>
 152     if ( ( doctype < 0 ) or ( doctype > iDocTypes ) ) then
 153         warnlog( CFN & "Undefined numeric doctype: " & doctype )
 154         hNumericDocType() = ""
 155         exit function
 156     endif
 157
 158     '///+<li>Set gApplication to the requested document type</li>
 159     gApplication = hGetValueForKeyAsString( sList() , doctype )
 160
 161     '///+<li>Set a plain text name as returnvalue for the function</li>
 162     hGetDataFileSection( sFile , sList() , "application_names" , "" , "" )
 163     hNumericDocType() = hGetValueForKeyAsString( sList() , gApplication )
 164     if ( VERBOSE ) then printlog( CFN & "Exit" )
 165     '///</ul>
 166
 167 end function
 168
 169 '*******************************************************************************
 170
 171 function hChangeDoc() as string
 172
 173     '///<h3>Function to modify all documenttypes to set  the "changed" flag</h3>
 174     '///<i>Starting point: Any plain document</i><br>
 175     '///<u>Input</u>:
 176     '///<ol>
 177     '///+<li>Nothing</li>
 178     '///</ol>
 179     '///<u>Returns</u>:
 180     '///<ol>
 181     '///+<li>String, ready to use in printlog</li>
 182     '///<ul>
 183     '///+<li>&quot;Changed &lt;Documenttype&gt;&quot;</li>
 184     '///</ul>
 185     '///</ol>
 186     '///<u>Description</u>:
 187     '///<ul>
 188
 189     sleep()
 190
 191     select case gApplication
 192
 193       '///+<li>WRITER: Type some text</li>
 194       case "WRITER", "HTML", "MASTERDOCUMENT"
 195                       Kontext "DocumentWriter"
 196                       DocumentWriter.TypeKeys "<Return>This doc is changed!"
 197                       hChangeDoc() = "Changed WRITER/HTML/MASTERDOC"
 198
 199       '///+<li>CALC: Write some text into the current location (usually A1)</li>
 200       case "CALC"   : Kontext "DocumentCalc"
 201                       DocumentCalc.TypeKeys "<Down>This doc is changed!<Return>"
 202                       hChangeDoc() = "Changed CALC"
 203
 204       '///+<li>DRAW: Draw a rectangle</li>
 205       case "DRAW"   : Kontext "DocumentDraw"
 206                       hRechteckErstellen ( 20, 20, 25, 25 )
 207                       gMouseClick ( 1, 1 )
 208                       hChangeDoc() = "Changed DRAW"
 209
 210       '///+<li>IMPRESS: Draw a rectangle</li>
 211       case "IMPRESS": Kontext "DocumentImpress"
 212                       hRechteckErstellen ( 20, 20, 25, 25 )
 213                       gMouseClick ( 1, 1 )
 214                       hChangeDoc() = "Changed IMPRESS"
 215
 216       '///+<li>MATH: Create a simple formaula</li>
 217       case "MATH"   : SchreibenInMathdok( "b over c" )
 218                       hChangeDoc() = "Changed MATH"
 219
 220    end select
 221    '///</ul>
 222
 223 end function
 224
 225 '*******************************************************************************
 226
 227 function hIdentifyWriterDoc( cString as string, bWarn as boolean ) as boolean
 228
 229     '///<h3>Function to validate that the expected WRITER doc has the focus</h3>
 230     '///<i>Starting point: Any WRITER document containing some text</i>
 231     '///<ul>
 232
 233     use "global\tools\includes\optional\t_stringtools.inc"
 234
 235     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hIdentifyWriterDoc::"
 236     dim cIdentifier as string
 237     dim irc as integer ' some temporary returnvalue
 238
 239     if ( VERBOSE ) then printlog( CFN & "Enter" )
 240
 241     '///+<li>Test the function parameter</li>
 242     if ( cString = "" ) then
 243         qaerrorlog( CFN & "Function parameter is empty string. Aborting" )
 244         hIdentifyWriterDoc() = false
 245         exit function
 246     endif
 247
 248     '///+<li>Verify function prerequisites</li>
 249     kontext "DocumentWriter"
 250     if ( not DocumentWriter.exists() ) then
 251         printlog( CFN & "There is no Writer document. Aborting" )
 252         hIdentifyWriterDoc() = false
 253         exit function
 254     endif
 255
 256     hIdentifyWriterDoc() = true
 257
 258     '///+<li>Go to the very beginning of the current writer document</li>
 259     kontext "DocumentWriter"
 260     DocumentWriter.typeKeys( "<MOD1 HOME>" )
 261
 262     '///+<li>Select the entire line</li>
 263     DocumentWriter.typeKeys( "<SHIFT END>" )
 264
 265     '///+<li>copy the string to the clipboard and store it into a variable</li>
 266     try
 267             editcopy
 268             cIdentifier = getClipboardText()
 269         catch
 270             warnlog( "EditCopy failed. Probably the document is empty" )
 271             cIdentifier = "**** invalid ****"
 272         endcatch
 273
 274
 275     '///+<li>compare the string to the reference (given as parameter)</li>
 276     irc = hCompareSubstrings( cIdentifier, cString )
 277
 278     '///+<li>Write the result to the printlog if desired</li>
 279     if ( irc = 0 ) then
 280
 281         if ( bWarn ) then
 282             warnlog ( CFN & "The focus is not on the expected document" )
 283         else
 284             printlog( CFN & "The focus is not on the expected document" )
 285         endif
 286
 287         printlog( CFN & "Expected: " & cString )
 288         printlog( CFN & "Found...: " & cIdentifier )
 289         hIdentifyWriterDoc() = false
 290
 291     else
 292         printlog( CFN & "OK: The document contains the requested string" )
 293     endif
 294     '///+<li>Return TRUE only if the current document is the expected one</li>
 295
 296     if ( VERBOSE ) then printlog( CFN & "Exit" )
 297     '///</ul>
 298
 299 end function
 300
 301 '*******************************************************************************
 302
 303 function hCreateDocument() as boolean
 304
 305     '///<h3>Create anew document, extends hNewDocument()</h3>
 306     '///<i>Starting point: Any document</i><br>
 307     '///<i>Note: When calling this function with gApplication "BACKGROUND" the
 308     '///+ function will actually close one document to get to the backing window</i><br>
 309     '///<u>Input</u>:
 310     '///<ol>
 311     '///+<li>Nothing, valid gApplication must be set</li>
 312     '///</ol>
 313     '///<u>Returns</u>:
 314     '///<ol>
 315     '///+<li>Errorstatus (boolean)</li>
 316     '///<ul>
 317     '///+<li>TRUE if a new document was created successfully</li>
 318     '///+<li>FALSE if anything went wrong</li>
 319     '///</ul>
 320     '///</ol>
 321     '///<u>Description</u>:
 322     '///<ul>
 323
 324
 325     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hCreateDocument::"
 326
 327     dim iDocCountBefore as integer
 328     dim iDocCountAfter as integer
 329
 330     '///+<li>Retrieve the number of open documents</li>
 331     iDocCountBefore = getDocumentCount
 332     if ( VERBOSE ) then printlog( CFN & "Number of open documents before: " & iDocCountBefore )
 333
 334     '///+<li>Special treatment if gApplication = BACKGROUND (virtual gApplication)</li>
 335     if ( ucase( gApplication ) = "BACKGROUND" ) then
 336         do while( getDocumentCount > 0 )
 337             hCloseDocument()
 338         loop
 339         hCreateDocument() = true
 340     else
 341
 342         '///+<li>Open a new document using hNewDocument()</li>
 343         call hNewDocument()
 344
 345         '///+<li>Retrieve the number of open documents</li>
 346         iDocCountAfter = getDocumentCount()
 347
 348         '///+<li>Verify that there is exactly one more document than before</li>
 349         if ( iDocCountAfter = ( iDocCountBefore + 1 ) ) then
 350             hCreateDocument() = true
 351         else
 352             hCreateDocument() = false
 353         endif
 354     endif
 355     printlog( CFN & "New document created. Open: " & iDocCountAfter )
 356     '///</ul>
 357
 358 end function
 359
 360 '*******************************************************************************
 361
 362 function hDocumentTypeKeys( cString as string ) as boolean
 363
 364     '///<h3>Type a string to a document</h3>
 365     '///<i>The documenttype is determined by gApplication.<br>
 366     '///See hNumericDocType for details and number/gApplication matching</i><br>
 367     '///<u>Input</u>:
 368     '///<ol>
 369     '///+<li>Keystrokes to be sent to the document (string), e.g.</li>
 370     '///<ul>
 371     '///+<li>&quot;&lt;SHIFT HOME&gt;&quot;</li>
 372     '///+<li>&quot;&lt;MOD1 A&gt;&quot;</li>
 373     '///+<li>&quot;&lt;MOD2 Q&gt;&quot;</li>
 374     '///+<li>&quot;Hello&quot;</li>
 375     '///</ul>
 376     '///</ol>
 377     '///<u>Returns</u>:
 378     '///<ol>
 379     '///+<li>Errorstatus (boolean)</li>
 380     '///<ul>
 381     '///+<li>TRUE if all went well</li>
 382     '///+<li>FALSE on any error</li>
 383     '///</ul>
 384     '///</ol>
 385     '///<u>Description</u>:
 386     '///<ul>
 387
 388     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hDocumentTypeKeys::"
 389     dim brc as boolean
 390         brc = true
 391
 392     if ( VERBOSE ) then printlog( CFN & "Enter" )
 393
 394     '///+<li>Set focus to the current documenttype determined by gApplication</li>
 395     '///+<li>Type the string passed as function parameter</li>
 396     select case gApplication
 397     case "WRITER"   :   kontext "DocumentWriter"
 398                         DocumentWriter.typeKeys( cString )
 399     case "CALC"     :   kontext "DocumentCalc"
 400                         DocumentCalc.typeKeys( cString )
 401     case "IMPRESS"  :   kontext "DocumentImpress"
 402                         DocumentImpress.typeKeys( cString )
 403     case "DRAW"     :   kontext "DocumentDraw"
 404                         DocumentDraw.typeKeys( cString )
 405     case "MATH"     :   kontext "DocumentMath"
 406                         DocumentMath.typeKeys( cString )
 407     case "MASTERDOCUMENT":   kontext "DocumentWriter"
 408                         DocumentWriter.typeKeys( cString )
 409     case "HTML"     :   kontext "DocumentWriter"
 410                         DocumentWriter.typeKeys( cString )
 411     case else
 412         warnlog( CFN & "Exit: Unknown gApplication: " & gApplication )
 413         brc = false
 414     end select
 415
 416     '///+<li>Print some message to the log on success</li>
 417     if ( brc ) then
 418         printlog( CFN & "Exit: Sent keystroke to " & gApplication )
 419     endif
 420
 421     hDocumentTypeKeys() = brc
 422     '///</ul>
 423
 424 end function
 425
 426
 427 '*******************************************************************************
 428
 429 function hDestroyDocument() as boolean
 430
 431     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hDestroyDocument: "
 432     dim iDocCount as integer : iDocCount = getDocumentCount()
 433     hDestroyDocument() = false
 434
 435     if ( iDocCount = 0 ) then exit function
 436     if ( VERBOSE ) then printlog( CFN & "In.: Open: " & iDocCount )
 437
 438     hUseAsyncSlot( "FileClose" )
 439
 440     Kontext "Active"
 441     if ( Active.Exists( 2 ) ) then
 442         printlog( "Msgbox: " & Active.getText() )
 443         try
 444             Active.No
 445         catch
 446             Active.Click ( 202 )
 447         endcatch
 448         wait( 1000 )
 449     end if
 450
 451     if ( getDocumentCount() = iDocCount ) then hCloseDocument()
 452     if ( getDocumentCount() = iDocCount - 1 ) then hDestroyDocument() = true
 453     if ( VERBOSE ) then printlog( CFN & "Out: Open: " & getDocumentCount() )
 454
 455 end function
 456
 457 '*******************************************************************************
 458
 459 function hInitSingleDoc() as boolean
 460
 461     '///<h3>Make sure exactly one single writer document is open</h3>
 462     '///<i>The wizards cannot be triggered correctly from the backing window.
 463     '///+ As a workaround this function checks the amount of open documents and
 464     '///+ creates exactly one unchanged Writer document</i><br><br>
 465
 466     '///<u>Parameter(s):</u><br>
 467     '///<ol>
 468     '///+<li>No input parameters</li>
 469     '///</ol>
 470
 471
 472     '///<u>Returns:</u><br>
 473     '///<ol>
 474     '///+<li>Errorcondition (Boolean)</li>
 475     '///<ul>
 476     '///+<li>TRUE: Exactly one Writer document is open</li>
 477     '///+<li>FALSE: Any error</li>
 478     '///</ul>
 479     '///</ol>
 480
 481     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hInitSingleDoc::"
 482     dim cOldApplication as string
 483
 484     '///<u>Description:</u>
 485     '///<ul>
 486     '///+<li>Close all documents until we are on the backing window</li>
 487     do while ( getDocumentCount > 0 )
 488         call hCloseDocument()
 489     loop
 490
 491     '///+<li>Save the previous gApplication</li>
 492     cOldApplication = gApplication
 493
 494     '///+<li>Set gApplication to WRITER</li>
 495     gApplication = "WRITER"
 496
 497     '///+<li>Open one new Writer document</li>
 498     call hNewDocument()
 499
 500     '///+<li>Verify that exactly one document is open</li>
 501     if ( getDocumentCount = 1 ) then
 502         printlog( CFN & "A single unchanged writer document is open" )
 503         hInitSingleDoc() = true
 504     else
 505         printlog( CFN & "Failed to open just one single writer document" )
 506         hInitSingleDoc() = false
 507     endif
 508
 509     '///+<li>Restore gApplication</li>
 510     gApplication = cOldApplication
 511     '///</ul>
 512
 513 end function
 514
 515 '*******************************************************************************
 516
 517 function hInitBackingMode() as boolean
 518
 519     '///<h3>Make that we are on the backing window (no open documents)</h3>
 520     '///<i>Close all open documents</i><br><br>
 521
 522     '///<u>Parameter(s):</u><br>
 523     '///<ol>
 524     '///+<li>No input parameters</li>
 525     '///</ol>
 526
 527
 528     '///<u>Returns:</u><br>
 529     '///<ol>
 530     '///+<li>Errorcondition (Boolean)</li>
 531     '///<ul>
 532     '///+<li>TRUE: No open documents are present</li>
 533     '///+<li>FALSE: Any error</li>
 534     '///</ul>
 535     '///</ol>
 536
 537     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hInitBackingMode::"
 538
 539     '///<u>Description:</u>
 540     '///<ul>
 541     '///+<li>Close all documents until we are on the backing window</li>
 542     do while ( getDocumentCount > 0 )
 543         hCloseDocument()
 544     loop
 545
 546     '///+<li>verify that we do not have any open documents left (redundant check)</li>
 547     if ( getDocumentCount = 0 ) then
 548         printlog( CFN & "Office is in backing mode." )
 549         hInitBackingMode() = true
 550     else
 551         printlog( CFN & "Office is in undefined state." )
 552         hInitBackingMode() = false
 553     endif
 554     '///</ul>
 555
 556 end function
 557
 558 '*******************************************************************************
 559
 560 function hInitWriteDocIdentifier( cString as string ) as boolean
 561
 562
 563     '///<h3>Write a specific string to an open writer document</h3>
 564     '///<i>This function verifies that exactly one document is open, that this is a
 565     '///+ Writer document and writes the string to the document</i><br><br>
 566
 567     '///<u>Parameter(s):</u><br>
 568     '///<ol>
 569
 570     '///+<li>A free form string (String) which serves as identifier for the document</li>
 571     '///<ul>
 572     '///+<li>The first character should be uppercase</li>
 573     '///</ul>
 574
 575     '///</ol>
 576
 577
 578     '///<u>Returns:</u><br>
 579     '///<ol>
 580     '///+<li>Errorcondition (Boolean)</li>
 581     '///<ul>
 582     '///+<li>TRUE: The string was written correctly</li>
 583     '///+<li>FALSE: Too many open documents</li>
 584     '///+<li>FALSE: Not a Writer document</li>
 585     '///+<li>FALSE: Any other error</li>
 586     '///</ul>
 587     '///</ol>
 588
 589     const CFN = "global::tools::includes::optional::t_docfuncs.inc::hInitWriteDocIdentifier::"
 590
 591     '///<u>Description:</u>
 592     '///<ul>
 593     '///+<li>Verify number of open documents</li>
 594     if ( getDocumentCount <> 1 ) then
 595         printlog( CFN & "Incorrect document count" )
 596         hInitWriteDocIdentifier() = false
 597         exit function
 598     endif
 599
 600     '///+<li>Verify that it is a writer document</li>
 601     kontext "DocumentWriter"
 602     if ( not DocumentWriter.exists() ) then
 603         printlog( CFN & "Open document is not a text document" )
 604         hInitWriteDocIdentifier() = false
 605         exit function
 606     endif
 607
 608     '///+<li>Write the string</li>
 609     kontext "DocumentWriter"
 610     DocumentWriter.typeKeys( "<MOD1 END>" )
 611     DocumentWriter.typeKeys( "<MOD1 SHIFT HOME>" )
 612     DocumentWriter.typeKeys( "<DELETE>" )
 613     DocumentWriter.typekeys( cString )
 614
 615     '///+<li>Verify the string</li>
 616     DocumentWriter.typeKeys( "<MOD1 END>" )
 617     DocumentWriter.typeKeys( "<MOD1 SHIFT HOME>" )
 618     EditCopy
 619     if ( getClipboardText = cString ) then
 620         printlog( CFN & "Document has been successfully modified." )
 621         hInitWriteDocIdentifier() = true
 622     else
 623         printlog( CFN & "Could not verify document identification string" )
 624         hInitWriteDocIdentifier() = false
 625     endif
 626     '///</ul>
 627
 628 end function