testautomation/dbaccess/tools/reporttools.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 2000, 2010 Oracle and/or its affiliates.
   6 '
   7 ' OpenOffice.org - a multi-platform office productivity suite
   8 '
   9 ' This file is part of OpenOffice.org.
  10 '
  11 ' OpenOffice.org is free software: you can redistribute it and/or modify
  12 ' it under the terms of the GNU Lesser General Public License version 3
  13 ' only, as published by the Free Software Foundation.
  14 '
  15 ' OpenOffice.org is distributed in the hope that it will be useful,
  16 ' but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ' GNU Lesser General Public License version 3 for more details
  19 ' (a copy is included in the LICENSE file that accompanied this code).
  20 '
  21 ' You should have received a copy of the GNU Lesser General Public License
  22 ' version 3 along with OpenOffice.org.  If not, see
  23 ' <http://www.openoffice.org/license.html>
  24 ' for a copy of the LGPLv3 License.
  25 '
  26 '/************************************************************************
  27 '*
  28 '* owner : marc.neumann@oracle.com
  29 '*
  30 '* short description : Report Helper Routines for Base tests.
  31 '*
  32 '***************************************************************************************
  33 '*
  34 '* #1 fOpenNewReoprtDesign
  35 '* #1 fCloseReportDesign
  36 '* #1 fCloseReportView
  37 '* #1 fSaveReport
  38 '* #1 fOpenReport
  39 '* #1 fFindREport
  40 '* #1 fOpenReportNavigator
  41 '* #1 fCloseReportNavigator
  42 '* #1 fSwitchPageheader
  43 '* #1 fExecutereport
  44 '* #1 fCloseAddFieldDialog
  45 '* #1 tools_reporttools_InstallExtension
  46 '*
  47 '\***********************************************************************************
  48 '-------------------------------------------------------------------------
  49 function fOpenNewReportDesign()
  50     '/// open a a new report design from an open database
  51     '/// <u>parameter:</u>
  52
  53     Kontext "DATABASE"
  54             if ( Database.NotExists(3) ) then
  55                 fOpenNewReportDesign = false
  56                 exit function
  57             end if
  58
  59         Database.MouseDown(50,50)
  60         Database.MouseUp(50,50)
  61
  62     sleep(1)
  63
  64     ViewReports
  65     NewReportDesign
  66
  67     sleep(5)
  68
  69    ' Kontext "ReportDesign"
  70    '     ReportDesign.MouseDown(50,50)
  71    '     ReportDesign.MouseUp(50,50)
  72
  73    ' sleep(1)
  74
  75     fOpenNewReportDesign = true
  76
  77 end function
  78 '--------------------------------------------------------------------
  79 function fCloseReportDesign( optional bSave )
  80     '/// close an open Report
  81     '/// <u>parameter:</u>
  82     '/// <b><i>optional</i> bSave:</b> if true the Report shall be saved, if false the changes are lost
  83
  84     sleep(1)
  85
  86     Kontext "ReportDesign"
  87         ReportDesign.UseMenu
  88         hMenuSelectNr(1) ' the file menu
  89         hMenuSelectNr(5) ' the Close Window
  90
  91     'when issue 30401 is fixed this has to be changed
  92     Kontext "Messagebox"
  93         if Messagebox.Exists(3) then
  94             if ( IsMissing( bSave ) ) then
  95                 Messagebox.No
  96             else
  97                 if bSave then
  98                     Messagebox.Yes
  99                 else
 100                     Messagebox.No
 101                 endif
 102             endif
 103         end if
 104
 105     sleep(1)
 106
 107     fCloseReportDesign = true
 108
 109 end function
 110 '--------------------------------------------------------------------
 111 function fCloseReportView()
 112     '/// close an open Report View
 113     '/// <u>parameter:</u>
 114
 115     sleep(1)
 116
 117     Kontext "DocumentWriter"
 118         DocumentWriter.UseMenu
 119         hMenuSelectNr(1) ' the file menu
 120         hMenuSelectNr(5) ' the Close Window
 121
 122     sleep(1)
 123
 124     fCloseReportView = true
 125
 126 end function
 127 '--------------------------------------------------------------------
 128 function fSaveReport( sReportName as string, optional bCloseReport as boolean )
 129     '/// save an open Report with the given name
 130     '/// <u>parameter:</u>
 131     '/// <b>sReportName:</b> the name under which the Report shall be saved. If the file allready exists, then the file will be overwritten
 132     '/// <b><i>optional</i> bCloseReport:</b> if true the Report shall be closed after saving, if false Report stay open
 133     sleep(1)
 134
 135     Kontext "DocumentWriter"
 136         DocumentWriter.UseMenu
 137         hMenuSelectNr(1) ' the file menu
 138         hMenuSelectNr(6) ' the Save
 139
 140     Kontext "ReportSaveDialog"
 141         if FormSaveDialog.exists(3) then
 142             FormName.setText(sReportName)
 143             SaveBtn.Click
 144             'click yes in the overwrite messages box
 145             Kontext "MessageBox"
 146                 if MessageBox.exists(1) then
 147                     MessageBox.Yes
 148                 endif
 149             fSaveReport = true
 150         else
 151             fSaveReport = false
 152         end if
 153
 154      if ( IsMissing( bCloseReport ) ) then
 155         ' nothing
 156      else
 157         call fCloseReportDesign()
 158      end if
 159
 160 end function
 161 '--------------------------------------------------------------------
 162 function fOpenReport(sReportName as string)
 163     '/// open a Report with the given name
 164     '/// <u>parameter:</u>
 165     '/// <b>sReportName:</b> the name of the Report which shall be open
 166
 167     if ( fFindReport(sReportName) = true ) then
 168         printlog "Report found -> open"
 169         Kontext "ContainerView"
 170             OpenForm ' uno-Slot .uno:DB/Open
 171             sleep(1)
 172         fOpenReport = true
 173     else
 174         printlog "Report not found."
 175         fOpenReport = false
 176     end if
 177
 178 end function
 179 '--------------------------------------------------------------------
 180 function fOpenReportInDesign(sReportName as string)
 181     '/// open a Report with the given name in the design mode
 182     '/// <u>parameter:</u>
 183     '/// <b>sReportName:</b> the name of the Report which shall be open
 184
 185     if ( fFindReport(sReportName) = true ) then
 186         printlog "Report found -> open"
 187         Kontext "ContainerView"
 188             EditReport ' uno-Slot .uno:DB/Edit
 189             sleep(1)
 190         fOpenReportInDesign = true
 191     else
 192         printlog "Report not found."
 193         fOpenReportInDesign = false
 194     end if
 195
 196 end function
 197 '--------------------------------------------------------------------
 198 function fFindReport(sReportName as string)
 199     '/// select a Report with the given name
 200     '/// <u>parameter:</u>
 201     '/// <b>sReportName:</b> the name of the Report which shall be selected
 202
 203     Dim iNumbersOfReports as integer
 204         Dim i as integer
 205
 206     Kontext "DATABASE"
 207
 208         ViewReports
 209
 210         fFindReport = false
 211
 212         if ( Not DatabaseReportsView.exists(1) ) then
 213             warnlog "The Report tree doesn't exists"
 214             exit function
 215         end if
 216
 217         iNumbersOfReports = DatabaseReportsView.getItemCount()
 218
 219         ' this select the first entry
 220         DatabaseReportsView.TypeKeys "<HOME>"
 221         DatabaseReportsView.TypeKeys "<UP>"
 222
 223
 224         for i = 1 to iNumbersOfReports
 225
 226             DatabaseReportsView.TypeKeys "<ADD>"
 227             'printlog "i = " + i
 228             'printlog "ReportName.getItemCount = " + ReportTree.getItemCount
 229             if DatabaseReportsView.getItemCount >  iNumbersOfReports then
 230                 iNumbersOfReports = DatabaseReportsView.getItemCount()
 231             endif
 232             'printlog "ReportName.getSeltext = " + ReportTree.getSeltext
 233             if DatabaseReportsView.getSeltext = sReportName then
 234                 fFindReport = true
 235                 exit for
 236             endif
 237             DatabaseReportsView.TypeKeys "<DOWN>"
 238         next
 239         sleep(1)
 240
 241 end function
 242 '--------------------------------------------------------------------
 243 function fOpenReportNavigator
 244     '/// open the report navigator
 245     '/// <u>parameter:</u>
 246     printlog "open report navigator"
 247     Kontext "ReportDesign"
 248         ReportDesign.UseMenu
 249         hMenuSelectNr(3)
 250         if (hMenuItemIsChecked(5) = false) then
 251             hMenuSelectNr(5)
 252         else
 253             'nothing
 254         endif
 255
 256     sleep(1)
 257
 258 end function
 259 '--------------------------------------------------------------------
 260 function fCloseReportNavigator
 261     '/// open the report navigator
 262     '/// <u>parameter:</u>
 263     printlog "open report navigator"
 264     Kontext "ReportDesign"
 265         ReportDesign.UseMenu
 266         hMenuSelectNr(3)
 267         if (hMenuItemIsChecked(5) = true) then
 268             hMenuSelectNr(5)
 269         else
 270             'nothing
 271         endif
 272
 273     sleep(1)
 274
 275 end function
 276 '--------------------------------------------------------------------
 277 function fExecuteReport
 278     '/// execute the report via the menu
 279     '/// <u>parameter:</u>
 280
 281     Kontext "ReportDesign"
 282         ReportDesign.UseMenu
 283         hMenuSelectNr(2)
 284         hMenuSelectNr(14)
 285
 286 end function
 287 '--------------------------------------------------------------------
 288 function fSwitchPageHeader
 289     '/// delete or insert the Page Header via the menu
 290     '/// <u>parameter:</u>
 291
 292     Kontext "ReportDesign"
 293         ReportDesign.UseMenu
 294         hMenuSelectNr(2)
 295         hMenuSelectNr(8)
 296
 297 end function
 298 '--------------------------------------------------------------------
 299 function fCloseAddFieldDialog
 300     '/// close the Add Field Dialog via the slot or menu
 301     '/// <u>parameter:</u>
 302
 303     Kontext "ReportAddField"
 304         if (ReportAddField.exists(3)) then
 305             ReportAddField.close
 306         else
 307             ' check if the dialog is really not there
 308             ' sometimes the focus is wrong. So I try a second way to disable the dialog
 309             Kontext "ReportDesign"
 310                 ReportDesign.UseMenu
 311                 hMenuSelectNr(3)
 312                 if (hMenuItemIsChecked(3)) then
 313                     hMenuSelectNr(3)
 314                 else
 315                     warnlog "there should be the Add field dialog. But there is none."
 316                 endif
 317         endif
 318 end function
 319 '--------------------------------------------------------------------
 320 function fOpenAddFieldDialog
 321     '/// open the Add Field Dialog via the slot or menu
 322     '/// <u>parameter:</u>
 323
 324     Kontext "ReportAddField"
 325         if (ReportAddField.exists(3)) then
 326             ' do nothing
 327         else
 328             Kontext "ReportDesign"
 329                 ReportDesign.UseMenu
 330                 hMenuSelectNr(3)
 331                 if (hMenuItemIsChecked(3)) then
 332                     hMenuSelectNr(3)
 333                     ReportDesign.UseMenu
 334                         hMenuSelectNr(3)
 335                     hMenuSelectNr(3)
 336                     printlog "1"
 337                 else
 338                     hMenuSelectNr(4)
 339                     printlog "2"
 340                 endif
 341             Kontext "ReportAddField"
 342             ReportAddField
 343             if (ReportAddField.exists(3)) then
 344                 ' do nothing
 345             else
 346                 warnlog "there should be the Add field dialog. But there is none."
 347             endif
 348         endif
 349
 350 end function
 351 '--------------------------------------------------------------------
 352 function tools_reporttools_InstallExtension
 353     '/// install the report designer extension
 354     '/// <u>parameter:</u>
 355     '/// <u>Return Value:</u><br>
 356
 357     '/// <ol>
 358     '/// +<li>Errorcode (Integer)</li>
 359     '/// <ul>
 360     '/// <li>0 = No errors, extension was added correctly</li>
 361     '/// <li> not 0 = an error occure see hExtensionAddGUI for more info </li>
 362     '/// </ul>
 363     '/// </ol>
 364
 365     dim i as integer
 366     use "global/tools/includes/optional/t_extension_manager_tools.inc"
 367     if (not hIsExtensionAlreadyInstalled("Report Builder")) then
 368         i = hExtensionAddGUI( gTesttoolPath + "dbaccess/required/input/oracle-report-builder.oxt", "AcceptLicense,InstallForUser" )
 369         if (i > 0) then
 370             tools_reporttools_InstallExtension = 0
 371         else
 372             if (i = -5) then
 373                 warnlog "Report extension was not installed due to unsatisfied dependencies."
 374                 tools_reporttools_InstallExtension = 5
 375             else
 376                 warnlog "Report extension was not installed. Error Code = " + i
 377                 tools_reporttools_InstallExtension = i
 378             endif
 379         endif
 380     else
 381         tools_reporttools_InstallExtension = 0
 382     endif
 383
 384     ' restart the office
 385     call ExitRestartTheOffice
 386
 387 end function