testautomation/framework/optional/includes/basic_modulenames.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: basic_modulenames.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsi $ $Date: 2008-06-16 12:18:13 $
  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 modulenames on the tabbar
  37 '*
  38 '\******************************************************************************
  39
  40 testcase tBasicIdeModuleNames
  41
  42     '///<h1>Naming conventions in BASIC-IDE module-/dialog-tabs</h1>
  43
  44     dim rc as integer
  45     dim brc as boolean
  46     dim i as integer
  47     dim iCurrentName as integer
  48     const CMODULE = "TModuleNames"
  49     dim cTabName as string
  50
  51     gApplication = "WRITER"
  52     hCreateDocument()
  53
  54     ' ------ prerequisites ---------
  55
  56     '///<ul>
  57     '///+<li>Create a new module for the current (writer) document</li>
  58     brc = hInitBasicIde( CMODULE )
  59
  60
  61     brc = hInsertMacro( 1 )
  62     if ( rc <> 0 ) then
  63        warnlog( "Failed to insert macro" )
  64     endif
  65
  66     '///+<li>Verify that the name makes it to the BASIC macro organizer</li>
  67     cTabName = hGetTabNameFromOrganizer()
  68
  69     '///+<li>Try to name the tab something containing invalid characters (should fail)</li>
  70     Randomize
  71     iCurrentName = Int( 24 * RND ) + 1 ' Range from 1 to 24
  72
  73     cTabName = hCreateInvalidModuleName( iCurrentName )
  74     rc = hRenameTab( cTabName )
  75     if ( rc = 1 ) then
  76         hHandleInvalidNameWarning( cTabname )
  77     else
  78         warnlog( "Warning missing" )
  79     endif
  80
  81     '///+<li>Try to name the tab to the current name (should work)</li>
  82     cTabname = CMODULE
  83     rc = hRenameTab( cTabname )
  84     if ( rc <> 0 ) then
  85         brc = hHandleInvalidNameWarning( cTabname )
  86         if ( brc ) then
  87             warnlog( "Failed to set valid name" )
  88         endif
  89     endif
  90
  91
  92     '///+<li>Finally try to give the tab a valid name (should work)</li>
  93     cTabname = hCreateInvalidModuleName( 0 )
  94     rc = hRenameTab( cTabName )
  95     if ( rc <> 0 ) then
  96         brc = hHandleInvalidNameWarning( cTabname )
  97         if ( brc ) then
  98             warnlog( "Failed to set valid name" )
  99         endif
 100     endif
 101
 102
 103     '///+<li>Verify that we are still in the same IDE-Window</li>
 104     rc = hTestMacro( 1 )
 105     if ( rc <> 1 ) then
 106         warnlog( "The open macro-module is not the one that was expected" )
 107     endif
 108
 109     '///+<li>Close IDE and document</li>
 110     hCloseBasicIDE()
 111
 112     hDestroyDocument()
 113     '///</ul>
 114
 115 endcase
 116
 117 '*******************************************************************************
 118
 119 testcase tInvalidModuleNames
 120
 121     '///<h1>Module naming conventions: Forbidden characters in module names</h1>
 122
 123     dim brc as boolean
 124     dim cMsg as string
 125     dim iCurrentName as Integer
 126
 127     dim sSeparator as String
 128     dim cModuleName as string
 129
 130     '///<ul>
 131     '///+<li>Open a new writer document</li>
 132     '///+<li>Open the BASIC Macro Organizer</li>
 133     '///+<li>Select the last module (Document BASIC)</li>
 134     '///+<li>Click the &quot;New&quot; button</li>
 135     hBasicModuleCreateNew()
 136
 137     '///+<li>Try a couple of names including '-', '+', '!', '(' ... <br>
 138     '///+ -&gt; Invalid name warnings are expected for all of these names</li>
 139
 140     Randomize
 141     iCurrentName = Int( 24 * RND ) + 1 ' Range from 1 to 24
 142
 143     cModuleName = hCreateInvalidModuleName( iCurrentName )
 144     printlog( "" )
 145     printlog( "Trying module name: " & cModuleName )
 146
 147     brc = hNameBasicModule( cModuleName )
 148
 149     '///+<li>Check if the Basic-Ide is open (should not be)</li>
 150     if ( brc ) then
 151         warnlog( "Basic-Ide should not open for invalid module names" )
 152
 153         ' try to recover and continue for other names
 154         brc = hCloseBasicIde()
 155         brc = hDestroyDocument
 156         brc = hBasicModuleCreateNew()
 157
 158         ' if we cannot recover, exit the test
 159         if ( not brc ) then
 160             goto endsub
 161         endif
 162     endif
 163
 164
 165     '///+<li>Close the naming dialog</li>
 166     printlog( "Close the naming dialog (cancel)" )
 167     kontext "neuesmodul"
 168     if ( NeuesModul.Exists() ) then
 169         NeuesModul.Cancel()
 170     endif
 171
 172     '///+<li>Close the macro dialog</li>
 173     printlog( "Clsoe macro dialog (if it exists)" )
 174     kontext "makro"
 175     if ( Makro.Exists() ) then
 176         Makro.Close()
 177     endif
 178
 179     '///+<li>Close the last document</li>
 180     printlog( "Close the document" )
 181     brc = hDestroyDocument()
 182     '///</ul>
 183
 184 endcase
 185
 186 '*******************************************************************************
 187
 188 testcase tValidModuleNames
 189
 190     '///<h1>Module naming conventions: Basic keywords, underscores, long names</h1>
 191
 192     dim brc as boolean
 193     dim cMsg as string
 194     dim iCurrentName as Integer
 195
 196     dim sKeyword as String
 197
 198     '///<ul>
 199     '///+<li>Open a new writer document</li>
 200     '///+<li>Open the BASIC Macro Organizer</li>
 201     '///+<li>Select the last module (Document BASIC)</li>
 202     '///+<li>Click the &quot;New&quot; button</li>
 203     hBasicModuleCreateNew()
 204
 205     '///+<li>Try a couple of basic keywords as module names such as
 206     '///+ open, print, select, function etc.</li>
 207     Randomize
 208     iCurrentName = Int( 8 * RND ) + 1 ' Range from 1 to 8
 209
 210     select case iCurrentName
 211         case 1  : sKeyword = "option"
 212         case 2  : sKeyword = "sub"
 213         case 3  : sKeyword = "function"
 214         case 4  : sKeyword = "end"
 215         case 5  : sKeyword = "exit"
 216         case 6  : sKeyword = "_underscore1"
 217         case 7  : sKeyword = "underscore_2"
 218         case 8  : sKeyWord = "ThisIsQuiteALongNameForAModuleDontYouThink"
 219     end select
 220
 221     printlog( "" )
 222     printlog( "Trying module name: " & sKeyword )
 223
 224     brc = hNameBasicModule( sKeyword )
 225
 226     '///+<li>Check if the Basic-Ide is open (should not be)</li>
 227     if ( brc ) then
 228
 229         ' try to recover and continue for other names
 230         brc = hCloseBasicIde()
 231         brc = hDestroyDocument
 232         brc = hBasicModuleCreateNew()
 233
 234         ' if we cannot recover, exit the test
 235         if ( not brc ) then
 236             goto endsub
 237         endif
 238     endif
 239
 240     '///+<li>Close the naming dialog</li>
 241     printlog( "Close the naming dialog (cancel)" )
 242     kontext "neuesmodul"
 243     if ( NeuesModul.Exists() ) then
 244         NeuesModul.Cancel()
 245     endif
 246
 247     '///+<li>Close the macro dialog</li>
 248     printlog( "Clsoe macro dialog (if it exists)" )
 249     kontext "makro"
 250     if ( Makro.Exists() ) then
 251         Makro.Close()
 252     endif
 253
 254     '///+<li>Close the last document</li>
 255     printlog( "Close the document" )
 256     brc = hDestroyDocument()
 257     '///</ul>
 258
 259 endcase
 260
 261 '*******************************************************************************
 262
 263 function hBasicModuleCreateNew() as boolean
 264
 265     '///<h3>Create a new doc, open Basic organizer, select last module, click New...</h3>
 266     '///<i>Starting point: The first doc!</i><br>
 267     '///<u>Input</u>:
 268     '///<ol>
 269     '///+<li>Nothing</li>
 270     '///</ol>
 271     '///<u>Returns</u>:
 272     '///<ol>
 273     '///+<li>Errorcode (boolean) </li>
 274     '///<ul>
 275     '///+<li>True if module naming dialog is open</li>
 276     '///+<li>False on any other condition</li>
 277     '///</ul>
 278     '///</ol>
 279     '///<u>Description</u>:
 280     '///<ul>
 281
 282     dim brc as boolean
 283         brc = false
 284
 285     dim iPos as integer
 286
 287     const CFN = "hBasicModuleCreateNew::"
 288
 289     '///+<li>Open a new writer document</li>
 290     gApplication = "WRITER"
 291     brc = hCreateDocument()
 292
 293     '///+<li>Open the BASIC Macro Organizer</li>
 294     brc = hOpenBasicOrganizerFromDoc()
 295     if ( not brc ) then
 296         warnlog( CFN & "Could not open the BASIC Macro Organizer, aborting" )
 297         hDestroyDocument()
 298     endif
 299
 300     '///+<li>Select the last module (Document BASIC)</li>
 301     if ( brc ) then
 302         iPos = hSelectTheLastNode( MakroAus )
 303         if ( not Neu.isEnabled() ) then
 304             warnlog( CFN & "New button is disabled for the current module, aborting" )
 305             kontext "Makro"
 306             Makro.cancel()
 307             brc = hDestroyDocument()
 308         endif
 309     endif
 310
 311     '///+<li>Click the &quot;New&quot; button</li>
 312     '///+<li>Verify that the renaming dialog is open</li>
 313     if ( brc ) then
 314
 315         printlog( "Click 'New'" )
 316         Neu.Click()
 317
 318         kontext "NeuesModul"
 319         if ( Neuesmodul.exists() ) then
 320             brc = true
 321             printlog( CFN & "Naming dialog is open"
 322         endif
 323     endif
 324
 325     hBasicModuleCreateNew() = brc
 326     '///</ul>
 327
 328 end function
 329
 330 '*******************************************************************************
 331
 332 function hHandleInvalidNameWarning( cTabName as string ) as boolean
 333
 334     '///<h3>Handle the &quot;Invalid name&quot; dialog when renaming a module</h3>
 335     '///<u>Input</u>:
 336     '///<ol>
 337     '///+<li>Name of the tab</li>
 338     '///<ul>
 339     '///+<li>Used for debugging purpose (printlogs only)</li>
 340     '///</ul>
 341     '///</ol>
 342     '///<u>Returns</u>:
 343     '///<ol>
 344     '///+<li>Errorcondition (boolean)</li>
 345     '///<ul>
 346     '///+<li>TRUE if warning was displayed and closed correctly</li>
 347     '///+<li>FALSE on any other condition</li>
 348     '///</ul>
 349     '///</ol>
 350     '///<u>Description</u>:
 351     '///<ul>
 352
 353     dim brc as boolean : brc = false
 354     dim iTry as integer
 355
 356     const CFN = "hHandleInvalidNameWarning::"
 357
 358     '///+<li>Test for a messagebox (Invalid name warning), warn if missing</li>
 359     kontext "Active"
 360     for iTry = 1 to 5
 361
 362         if ( active.exists( 1 ) ) then
 363
 364             if ( brc ) then
 365                 warnlog( CFN & "Too many invalid name warnings" )
 366             endif
 367
 368                 '///+<li>Retrieve the text from the messagebox, printlog</li>
 369             printlog( CFN & "Message: " & active.getText() )
 370
 371                 '///+<li>Click OK on the messagebox</li>
 372                 active.ok()
 373             brc = true
 374
 375         else
 376
 377                 if ( not brc ) then
 378                         warnlog( CFN & "Invalid name warning missing" )
 379             endif
 380
 381         endif
 382
 383     next iTry
 384
 385     '///+<li>Return to Basic Ide, take focus from Tabbar</li>
 386     kontext "basicide"
 387     tabbar.typekeys( "<ESCAPE>" , true )
 388     hHandleInvalidNameWarning() = brc
 389     '///</ul>
 390
 391 end function
 392
 393 '*******************************************************************************
 394
 395 function hCreateInvalidModuleName( iName as integer ) as string
 396
 397     '///<h3>Retrieve an invalid module name for Basic IDE by index</h3>
 398     '///<u>Input</u>:
 399     '///<ol>
 400     '///+<li>Index (integer)</li>
 401     '///<ul>
 402     '///+<li>0 = insert underscore which creates a valid name</li>
 403     '///+<li>1 ... 23 = insert characters like &, +, i, ;, etc. (invalid)</li>
 404     '///+<li>&gt; 23 = no character will be definde</li>
 405     '///</ul>
 406     '///</ol>
 407     '///<u>Returns</u>:
 408     '///<ol>
 409     '///+<li>Name for a module (string)</li>
 410     '///<ul>
 411     '///+<li>Name of type &quot;ttModule&lt;Char&gt;X&quot;</li>
 412     '///</ul>
 413     '///</ol>
 414     '///<u>Description</u>:
 415     '///<ul>
 416
 417     dim sSeparator as string
 418
 419     ' Note: We cannot test for "<" and ">" because these are the characters
 420     '       that identify keystrokes for the .typeKeys() method.
 421
 422     '///+<li>Assign a character by index</li>
 423     select case iName
 424         case 0  : sSeparator = "_"
 425         case 1  : sSeparator = "-"
 426         case 2  : sSeparator = "."
 427         case 3  : sSeparator = ","
 428         case 4  : sSeparator = "+"
 429         case 5  : sSeparator = ":"
 430         case 6  : sSeparator = "!"
 431         case 7  : sSeparator = "$"
 432         case 8  : sSeparator = "("
 433         case 9  : sSeparator = ")"
 434         case 10 : sSeparator = "="
 435         case 11 : sSeparator = "?"
 436         case 12 : sSeparator = "*"
 437         case 13 : sSeparator = " "
 438         case 14 : sSeparator = "&"
 439         case 15 : sSeparator = "\"
 440         case 16 : sSeparator = "/"
 441         case 17 : sSeparator = "§"
 442         case 18 : sSeparator = """"
 443         case 19 : sSeparator = "'"
 444         case 20 : sSeparator = "@"
 445         case 21 : sSeparator = "["
 446         case 22 : sSeparator = "]"
 447         case 23 : sSeparator = "%"
 448         case 24 : sSeparator = CHR$( 387 )
 449         case else : sSeparator = ""
 450     end select
 451
 452     '///+<li>Build a string containing the character</li>
 453     hCreateInvalidModuleName() = "ttModule" & sSeparator & "X"
 454     '///</ul>
 455
 456 end function