testautomation/framework/tools/includes/spadmin_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: spadmin_tools.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsi $ $Date: 2008-06-16 12:19:06 $
  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 : helper functions for SPAdmin
  37 '*
  38 '\******************************************************************************
  39
  40 function hGetPrinterPosition( cName as string, bWarn as boolean ) as integer
  41
  42     '///<h3>Find a printer queue in the SpAdmin list</h3>
  43     ' IN:
  44     ' cName = Name of the queue to look for
  45     ' bWarn = if TRUE we warn if the queue does not exist
  46
  47     const CFN = "hGetPrinterPosition::"
  48
  49     if ( cName = "" ) then
  50         warnlog( CFN & "Invalid Parameter passed to function: Empty String" )
  51         hGetPrinterPosition() = -1
  52         exit function
  53     endif
  54
  55     dim iCurrentQueue as integer
  56     dim bFound as boolean
  57     dim iPrinterCount as integer
  58         iPrintercount = LBPrinters.getItemCount()
  59
  60     Kontext "SpAdmin"
  61     bFound = false
  62
  63     for iCurrentQueue = 1 to iPrinterCount
  64
  65         wait( 200 )
  66
  67         LBPrinters.select( iCurrentQueue )
  68         if ( LBPrinters.getseltext() = cName ) then
  69             bFound = true
  70             exit for
  71         endif
  72
  73     next iCurrentQueue
  74
  75     ' warn if queue was not found and we requested a warning
  76     if ( not bFound and bWarn ) then
  77         iCurrentQueue = 0
  78         printlog( CFN & "The specified printer queue could not be found" )
  79     endif
  80
  81     ' print a message that the printer queue exists
  82     if ( bFound ) then
  83         printlog( CFN & "Printer Queue was found at pos " & iCurrentQueue )
  84     endif
  85
  86     Kontext "SpAdmin"
  87     hGetPrinterPosition() = iCurrentQueue
  88
  89 end function
  90
  91 '*******************************************************************************
  92
  93 function hDelPrinter( cPrinterName as string ) as integer
  94
  95     '///<h3>Delete a printer queue by its name in SpAdmin</h3>
  96
  97     const CFN = "hDelPrinter::"
  98
  99     ' delete a printer-queue from the printers-list by name. Only exact matches
 100     ' will be removed.
 101
 102     ' IN:
 103     ' - Name of the queue
 104     ' OUT:
 105     ' -1 = Bad function call
 106     '  0 = Success
 107     '  1 = Confirmation Dialog for Delete is missing
 108     '  2 = Unable to press "OK" on Confirm-Delete Dialog
 109     '  3 = Printer queue does not exist so it was not deleted
 110
 111     if ( cPrinterName = "" ) then
 112         warnlog( CFN & "Invalid Parameter passed to function: Empty String" )
 113         hDelPrinter() = -1
 114         exit function
 115     endif
 116
 117     dim iPrinterPos as integer
 118     dim iErr as integer
 119         iErr = 1
 120
 121     Kontext "SpAdmin"
 122     iPrinterPos = hGetPrinterPosition( cPrinterName , true )
 123
 124     if ( iPrinterPos > 0 ) then
 125
 126         LBPrinters.select( iPrinterPos )
 127         PBRemove.click()
 128
 129         try
 130             Kontext "Active"
 131             if ( active.exists( 2 ) ) then
 132                 Active.Yes()
 133                 printlog( CFN & "Printer Queue deleted" )
 134                 iErr = 0
 135             else
 136                 warnlog( CFN & "Confirm Delete Dialog is missing" )
 137                 iErr = 1
 138             endif
 139         catch
 140             warnlog( CFN & "Unable to confirm printer deletion" )
 141             iErr = 2
 142         endcatch
 143
 144     else
 145
 146         printlog( CFN & "The printer queue does not exist" )
 147         iErr = 3
 148
 149     endif
 150
 151     Kontext "SpAdmin"
 152     hDelPrinter() = iErr
 153
 154 end function
 155
 156 '*******************************************************************************
 157
 158 function hGetSpadminPath() as string
 159
 160     '///<h3>Retrieve the path to the SpAdmin script/binary</h3>
 161     const CFN = "hGetSpadminPath::"
 162     const C_REL_PATH = "program\spadmin"
 163
 164     dim sPath as string
 165
 166     sPath = gNetzOfficePath & C_REL_PATH
 167     sPath = convertpath( sPath )
 168
 169     printlog( CFN & "Using SPAdmin from: " & sPath
 170
 171     hGetSpadminPath() = sPath
 172
 173 end function
 174
 175 '*******************************************************************************
 176
 177 function hShutdownOffice() as integer
 178
 179     '///<h3>Shutdown the office by closing all docs and the backing window</h3>
 180     const CFN = "hShutdownOffice::"
 181
 182     dim iOpenDocs as integer
 183         iOpenDocs = getDocumentCount()
 184     dim iThisDoc as integer
 185
 186     ' close all open documents (One open document to remain)
 187     for iThisDoc = 1 to iOpenDocs
 188         call hCloseDocument()
 189     next iThisDoc
 190
 191     ' see how many documents are still open - should be exactly one
 192     iOpenDocs = getDocumentCount()
 193     if ( iOpenDocs <> 0 ) then
 194         warnlog( CFN & "No open documents expected but found: " & iOpenDocs )
 195     endif
 196
 197     ' shutdown the backing window, do not test with getDocumentCount() because
 198     ' this would inevitably restart the office
 199     ' we need some additional parameter for FileExit, this is a bug
 200     FileExit( "SynchronMode", TRUE )
 201
 202     ' wait long enough to ensure all office threads are removed from memory
 203     sleep( 5 )
 204
 205     ' Print a somehow fuzzy message, we do not know for sure whether the office
 206     ' has been shutdown or not
 207     printlog( CFN & "The office should have been closed by now." )
 208     hShutdownOffice() = iOpenDocs
 209
 210 end function
 211
 212 '*******************************************************************************
 213
 214 function hOpenSpadmin() as boolean
 215
 216     '///<h3>Execute the SpAdmin binary/Script and verify that it is open</h3>
 217     ' Return TRUE if hWaitForSpadmin() completes successfully
 218
 219     const CFN = "hOpenSpadmin::"
 220
 221     dim cSpadminPath as string
 222         cSpadminPath = hGetSpadminPath()
 223
 224     dim brc as boolean
 225
 226     ' start SPAdmin in automation mode.
 227     try
 228         start( cSpadminPath  , "-enableautomation" )
 229         printlog( CFN & "SpAdmin command executed successfully" )
 230         brc = true
 231     catch
 232         warnlog( CFN & "Failure: SpAdmin command did not succeed" )
 233         brc = false
 234     endcatch
 235
 236     hOpenSpAdmin() = brc
 237
 238 end function
 239
 240 '********************************************************************************
 241
 242 function hWaitForSpAdmin() as boolean
 243
 244     '///<h3>Wait for SpAdmin to be loaded and displayed</h3>
 245     const CFN = "hWaitForSpAdmin::"
 246
 247     dim bOpen as boolean
 248
 249     ' Wait for SpAdmin to open
 250     kontext "SpAdmin"
 251     if ( SpAdmin.exists( 10 ) ) then
 252         printlog( CFN & "SpAdmin is open. Good." )
 253         sleep( 10 )
 254         bOpen = true
 255     else
 256         warnlog( CFN & "SpAdmin is not open, the test cannot continue" )
 257         bOpen = false
 258     endif
 259
 260     hWaitForSpadmin() = bOpen
 261
 262 end function
 263
 264 '*******************************************************************************
 265
 266 function hCreateFaxDevice( cName as string ) as boolean
 267
 268     '///<h3>Open the printer creation dialog and create a fax device</h3>
 269     ' The function verifies that the device has been created and returns
 270     ' TRUE on success
 271     '///<ul>
 272
 273     const CFN = "hCreateFaxDevice::"
 274
 275     if ( cName = "" ) then
 276         warnlog( CFN & "Invalid Parmeter passed to function: Empty String" )
 277         hCreateFaxDevice() = false
 278         exit function
 279     endif
 280
 281     ' quickly greates a fax device accepting all defaults
 282     '///+<li>Click on "New Printer"</li>
 283     Kontext "SpAdmin"
 284     PBNewPrinter.click()
 285
 286     '///+<li>Click on "Next..."</li>
 287     Kontext "SpPrinterWizard"
 288     PBNext.click()
 289
 290     '///+<li>Click on "Next..."</li>
 291     Kontext "SpPrinterWizard"
 292     PBNext.click()
 293
 294     '///+<li>Enter "(PHONE)" as queue command</li>
 295     Kontext "TabPWQueueCommand"
 296     CBCommand.setText( """(PHONE)""" )
 297
 298     '///+<li>Click on "Next..."</li>
 299     Kontext "SpPrinterWizard"
 300     PBNext.click()
 301
 302     '///+<li>Enter a Fax-Printer Name</li>
 303     Kontext "TabPWPrinterName"
 304     EFFaxName.setText( cName )
 305
 306     '///+<li>Finish the wizard by pressing OK</li>
 307     Kontext "SpPrinterWizard"
 308     SpPrinterWizard.ok()
 309
 310     sleep( 1 )
 311
 312     '///+<li>Verify that the Queue has been created in SpAdmin</li>
 313     Kontext "SpAdmin"
 314     if ( hgetPrinterPosition( cName ) <> 0 ) then
 315         hCreateFaxDevice() = true
 316         printlog( CFN & "Successfully created Fax device" )
 317     else
 318         hCreateFaxDevice() = false
 319         warnlog( CFN & "Failed to create a Fax device" )
 320     endif
 321     '///</ul>
 322
 323 end function