testautomation/framework/optional/includes/extras_file_open.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: extras_file_open.inc,v $
  10 '*
  11 '* $Revision: 1.4 $
  12 '*
  13 '* last change: $Author: rt $ $Date: 2008-09-04 09:15:59 $
  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 : Perform standard operations on all samples/templates etc.
  37 '*
  38 '\***********************************************************************
  39
  40 private const MAX_FILE_COUNT = 3000 ' the max number of templates or samples
  41
  42 ' NOTE: Usually we have only about a 100 templates but in multi-language
  43 '       installations there are more than 2100. You should not run these
  44 '       tests on multi language installations. Really.
  45
  46 testcase tOpenObjectsWithFileDialog( cCategory as string )
  47
  48     const CFN = "tOpenObjectsWithFileDialog::"
  49
  50     '///<h1>Open all templates using the File-Open dialog</h1>
  51     '///<i>Retrieve the templates out of ..\share\template\-directory</i><br>
  52     '///<ul>
  53
  54     dim lsFile ( MAX_FILE_COUNT ) as String ' list of all files below samples or templates
  55     dim sRootPath as String       ' rootpath, depends on cCategory
  56     dim sRootPathFallback as string
  57
  58     dim sFilter as string
  59
  60     dim sFileIn as String         ' file to open
  61     dim sFileOut as string        ' file to save, reload, delete
  62     dim sPathOut as string
  63         sPathOut = hGetWorkPath()
  64     dim sExtension as String      ' filter: determines whether to test the file
  65
  66     dim iCurrentTemplate as Integer ' increment: current template from lsFile()
  67     dim iTemplateCount as integer
  68
  69     dim bSkipFile as boolean      ' turns true if file is to be skipped
  70     dim brc as boolean            ' some multi purpose boolan returncode
  71     dim cOfficePath as string
  72
  73     ' the path where the samples/templates are located, verify function params
  74     ' note that for some time the suffixes for the different filetypes are changed,
  75     ' so we have separate names for samples and templates.
  76
  77     if ( FileExists( gOfficeBasisPath ) ) then
  78         cOfficePath = gOfficeBasisPath
  79     else
  80         cOfficePath = mid( gOfficeBasisPath, len( gNetzOfficePath ) + 1 )
  81     endif
  82     printlog( "Using: " & cOfficePath )
  83
  84     select case cCategory
  85     case "SAMPLES"    : sRootPath = cOfficePath & "share\samples\" & gISOLang
  86                         sRootPathFallback = "/opt/openoffice.org/basis3.0/share/samples/" & gISOLang
  87                         sFIlter   = "*.od*"
  88     case "TEMPLATES"  : sRootPath = cOfficePath & "share\template\" & gISOLang
  89                         sRootPathFallback = "/opt/openoffice.org/basis3.0/share/template/" & gISOLang
  90                         sFilter   = "*.ot*"
  91     case default
  92         warnlog( CFN & "Invalid category passed to function" )
  93         goto endsub
  94     end select
  95
  96     sRootPath = convertpath( sRootPath )
  97
  98     '///+<li>Get the complete list of all files below templates/samples</li>
  99     if ( dir( sRootPath ) = "" ) then
 100         qaerrorlog( "Root Path does not exist: " & sRootPath )
 101         sRootPath = sRootPathFallback
 102         if ( dir( sRootPathFallback ) = "" ) then
 103             warnlog( "No usable office root path found. Aborting test" )
 104             goto endsub
 105         printlog( "Using hard coded fallback" )
 106         endif
 107     endif
 108
 109     printlog( "Using path..: " & sRootPath )
 110     printlog( "Using filter: " & sFilter   )
 111     GetAllFileList ( sRootPath, sFilter, lsFile() )
 112     hListDelete( lsFile(), 1 )
 113
 114     ' Remove .lock-files
 115     iTemplateCount   = listCount( lsFile() )
 116     iCurrentTemplate = 1
 117     while( iCurrentTemplate <= iTemplateCount )
 118         if ( instr( lsFile( iCurrentTemplate ), "~lock." ) > 0 ) then
 119             hListDelete( lsFile(), iCurrentTemplate )
 120             iTemplateCount = iTemplateCount - 1
 121         else
 122             iCurrentTemplate = iCurrentTemplate + 1
 123         endif
 124     wend
 125
 126     ' do not test wizard related files
 127     iTemplateCount   = listCount( lsFile() )
 128     iCurrentTemplate = 1
 129     while( iCurrentTemplate <= iTemplateCount )
 130         if ( instr( lsFile( iCurrentTemplate ), "wizard" ) > 0 ) then
 131             hListDelete( lsFile(), iCurrentTemplate )
 132             iTemplateCount = iTemplateCount - 1
 133         else
 134             iCurrentTemplate = iCurrentTemplate + 1
 135         endif
 136     wend
 137
 138     hListPrint ( lsFile() , "" , "" )
 139     if ( listcount( lsfile() ) = 1 ) then
 140         if ( gProductName = "OpenOffice.org" ) then
 141             printlog( gProductName & " comes with no samples, skipping" )
 142             goto endsub
 143         else
 144             warnlog( "Filelist seems to be incomplete. GetAllFileList() failed!" )
 145             goto endsub
 146         endif
 147     endif
 148
 149     '///+<li>Go through the list of samples/templates and do things</li>
 150     '///<ul>
 151     iTemplateCount = listCount( lsFile() )
 152     for iCurrentTemplate = 1 to iTemplateCount
 153
 154         printlog( "" )
 155         printlog( "Loading file " & iCurrentTemplate & " of " & iTemplateCount )
 156
 157         ' sFileIn holds the file we currently work with
 158         sFileIn = lsFile( iCurrentTemplate )
 159
 160         '///+<li>Load the file</li>
 161         brc = hFileOpen( sFileIn )
 162         brc = hHandleActivesOnLoad( 0 , 2 )
 163
 164         '///+<li>Cancel the filterdialog if present -> bug</li>
 165         Kontext "FilterAuswahl"
 166         if ( FilterAuswahl.exists( 1 ) ) then
 167             warnlog( "Loading failed, ASCII filter dialog present" )
 168             FilterAuswahl.cancel()
 169             while( getDocumentCount > 0 )
 170                 hDestroyDocument()
 171             wend
 172         else
 173
 174             '///+<li>Close the navigator if present</li>
 175             brc = hCloseNavigator()
 176
 177             ' Build the filename
 178             sFileOut = cCategory & "_" & iCurrentTemplate
 179             sFileOut = convertpath( sPathOut & sFileOut )
 180
 181             '///+<li>Save the file, use autoextension</li>
 182             brc = hFileSaveAsKill( sFileOut )
 183
 184             '///+<li>Close possible dialogs like "Update links" etc.</li>
 185             ' note: this is delayed, because the dialogs take time to pop up
 186             '       even while the dialog is visible, we can work with the doc.
 187             brc = hHandleInitialDialogs()
 188
 189             '///+<li>Close the document</li>
 190             brc = hDestroyDocument()
 191
 192             '///+<li>Load the file, close the navigator if present</li>
 193             brc = hFileOpen( sFileOut )
 194             brc = hHandleActivesOnLoad( 0 , 2 )
 195             brc = hCloseNavigator()
 196
 197             '///+<li>Close the file</li>
 198             brc = hDestroyDocument()
 199
 200         endif
 201
 202         '///+<li>Delete the file</li>
 203         brc = hDeleteFile( sFileOut )
 204         '///</ul>
 205
 206     next iCurrentTemplate
 207     '///</ul>
 208
 209 endcase
 210
 211