qadevOOo/runner/convwatch/ConvWatchStarter.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 package convwatch;
  20
  21 // imports
  22 import java.util.ArrayList;
  23 import java.io.File;
  24 import java.io.FileFilter;
  25
  26 import convwatch.EnhancedComplexTestCase;
  27 import com.sun.star.lang.XMultiServiceFactory;
  28
  29 import convwatch.ConvWatchException;
  30 import convwatch.DirectoryHelper;
  31 import convwatch.GraphicalTestArguments;
  32 import convwatch.HTMLOutputter;
  33 import helper.OfficeProvider;
  34 import helper.OfficeWatcher;
  35 import helper.OSHelper;
  36 import convwatch.PerformanceContainer;
  37
  38 /**
  39  * The following Complex Test will test
  40  * an already created document and it's postscript output (by an older office version)
  41  * with a new office version.
  42  * This test use Ghostscript for the jpeg export and graphically compare tools from ImageMagick.
  43  * Read the manual for more information.
  44  *
  45  * this is only the starter program
  46  * more is found in qadevOOo/runner/convwatch/*
  47  */
  48
  49 public class ConvWatchStarter extends EnhancedComplexTestCase
  50 {
  51     // The first of the mandatory functions:
  52     /**
  53      * Return the name of the test.
  54      * In this case it is the actual name of the service.
  55      * @return The tested service.
  56      */
  57     // public String getTestObjectName() {
  58     //     return "ConvWatch runner";
  59     // }
  60
  61     // The second of the mandatory functions: return all test methods as an
  62     // array. There is only one test function in this example.
  63     /**
  64      * Return all test methods.
  65      * @return The test methods.
  66      */
  67     public String[] getTestMethodNames() {
  68         return new String[]{"compareGraphicalDiffs"};
  69     }
  70
  71     String m_sInputPath = "";
  72     String m_sReferencePath = "";
  73     String m_sOutputPath = "";
  74     String m_sDiffPath = null;
  75
  76     private void initMember()
  77         {
  78             // MUST PARAMETER
  79             // INPUTFILE ----------
  80             String sINPATH = (String)param.get( PropertyName.DOC_COMPARATOR_INPUT_PATH );
  81             boolean bQuit = false;
  82             if (sINPATH == null || sINPATH.length() == 0)
  83             {
  84                 log.println("Please set input path (path to documents) " + PropertyName.DOC_COMPARATOR_INPUT_PATH + "=path.");
  85                 bQuit = true;
  86             }
  87             else
  88             {
  89                 log.println("found " + PropertyName.DOC_COMPARATOR_INPUT_PATH + " " + sINPATH);
  90                 m_sInputPath = sINPATH;
  91             }
  92
  93             // REFERENCE_PATH ----------
  94             String sREF = (String)param.get( PropertyName.DOC_COMPARATOR_REFERENCE_PATH );
  95             if (sREF == null || sREF.length() == 0)
  96             {
  97                 // log.println("Please set reference file (path to good documents) REFERENCEFILE=path.");
  98                 log.println("Assumtion, reference directory and input directory are the same.");
  99                 m_sReferencePath = m_sInputPath;
 100             }
 101             else
 102             {
 103                 log.println("found " + PropertyName.DOC_COMPARATOR_REFERENCE_PATH + " " + sREF);
 104                 m_sReferencePath = sREF;
 105             }
 106
 107             // OUTPUT_PATH ----------
 108             String sOUT = (String)param.get( PropertyName.DOC_COMPARATOR_OUTPUT_PATH );
 109             if (sOUT == null || sOUT.length() == 0)
 110             {
 111                 log.println("Please set output path (path to a temp directory) " + PropertyName.DOC_COMPARATOR_OUTPUT_PATH + "=path.");
 112                 bQuit = true;
 113             }
 114             else
 115             {
 116                 log.println("found " + PropertyName.DOC_COMPARATOR_OUTPUT_PATH + " " + sOUT);
 117                 m_sOutputPath = sOUT;
 118             }
 119
 120             if (bQuit == true)
 121             {
 122                 // log.println("must quit.");
 123                 assure("Must quit", false);
 124             }
 125
 126
 127             // DIFF_PATH ----------
 128             String sDIFF = (String)param.get( PropertyName.DOC_COMPARATOR_DIFF_PATH );
 129             if (sDIFF == null || sDIFF.length() == 0)
 130             {
 131             }
 132             else
 133             {
 134                 log.println("found " + PropertyName.DOC_COMPARATOR_DIFF_PATH + " " + sDIFF);
 135                 m_sDiffPath = sDIFF;
 136             }
 137
 138             if (m_sInputPath.startsWith("file:") ||
 139                 m_sReferencePath.startsWith("file:") ||
 140                 m_sOutputPath.startsWith("file:"))
 141             {
 142                 assure("We can't handle file: URL right, use system path instead.", false);
 143             }
 144
 145         }
 146
 147
 148     /**
 149      *
 150      * @return a List of software which must accessible as an external executable
 151      */
 152     protected String[] mustInstalledSoftware()
 153         {
 154             ArrayList<String> aList = new ArrayList<String>();
 155             // Tools from ImageMagick
 156             if (! OSHelper.isWindows())
 157             {
 158             aList.add( "composite -version" );
 159             aList.add( "identify -version" );
 160
 161             // Ghostscript
 162             aList.add( "gs -version" );
 163             }
 164             else
 165             {
 166                 aList.add( "composite.exe -version" );
 167                 aList.add( "identify.exe -version" );
 168
 169                 // Ghostscript
 170                 aList.add( "gswin32c.exe -version" );
 171             }
 172
 173             return aList.toArray(new String[aList.size()]);
 174         }
 175
 176
 177     /**
 178      * The test method itself.
 179      * Don't try to call it from outside, it is started only from qadevOOo runner
 180      */
 181
 182     /* protected */
 183     public void compareGraphicalDiffs()
 184         {
 185             GlobalLogWriter.set(log);
 186             String sDBConnection = (String)param.get( PropertyName.DB_CONNECTION_STRING );
 187             // check if all need software is installed and accessible
 188             checkEnvironment(mustInstalledSoftware());
 189
 190             GraphicalTestArguments aGTA = getGraphicalTestArguments();
 191             if (aGTA == null)
 192             {
 193                 assure("Must quit", false);
 194             }
 195             if (aGTA.cancelRequest())
 196             {
 197                 return;
 198             }
 199
 200             initMember();
 201
 202             aGTA.allowStore();
 203
 204             String sBuildID = aGTA.getBuildID();
 205             log.println("Current Office has buildid: " + sBuildID);
 206
 207             // LLA: sample code, how to access all parameters
 208             // for (Enumeration e = param.keys() ; e.hasMoreElements() ;)
 209             // {
 210             //     System.out.println(e.nextElement());
 211             // }
 212
 213             String fs = System.getProperty("file.separator");
 214
 215             String sHTMLName = "index.html";
 216             File aInputPathTest = new File(m_sInputPath);
 217             if (!aInputPathTest.isDirectory())
 218             {
 219                 int n = m_sInputPath.lastIndexOf(fs);
 220                 sHTMLName = m_sInputPath.substring(n + 1);
 221                 sHTMLName += ".html";
 222             }
 223             HTMLOutputter HTMLoutput = HTMLOutputter.create(m_sOutputPath, sHTMLName, "", "");
 224             HTMLoutput.header( m_sOutputPath );
 225             HTMLoutput.indexSection( m_sOutputPath );
 226             LISTOutputter LISToutput = LISTOutputter.create(m_sOutputPath, "allfiles.txt");
 227
 228             DB.init(aGTA.getDBInfoString() + "," + sDBConnection);
 229
 230             File aInputPath = new File(m_sInputPath);
 231             if (aInputPath.isDirectory())
 232             {
 233                 // check a whole directory
 234                 // a whole directory
 235                 FileFilter aFileFilter = FileHelper.getFileFilter();
 236
 237                 Object[] aList = DirectoryHelper.traverse(m_sInputPath, aFileFilter, aGTA.includeSubDirectories());
 238                 if (aList.length == 0)
 239                 {
 240                     log.println("Nothing to do, there are no document files found.");
 241                 }
 242                 else
 243                 {
 244                     for (int i=0;i<aList.length;i++)
 245                     {
 246                         String sEntry = (String)aList[i];
 247                         log.println("- next file is: ------------------------------");
 248                         log.println(sEntry);
 249
 250                         String sNewSubDir = FileHelper.removeFirstDirectorysAndBasenameFrom(sEntry, m_sInputPath);
 251
 252                         String sNewReferencePath = m_sReferencePath;
 253                         String sNewOutputPath = m_sOutputPath;
 254                         String sNewDiffPath = m_sDiffPath;
 255                         if (sNewSubDir.length() > 0)
 256                         {
 257                             if (sNewReferencePath != null)
 258                                 sNewReferencePath = sNewReferencePath + fs + sNewSubDir;
 259                             // String sNameNoSuffix = FileHelper.getNameNoSuffix(FileHelper.getBasename(sEntry));
 260                             // sNewReferenceFile = sNewReferencePath + fs + sNameNoSuffix + ".prn";
 261
 262                             sNewOutputPath = sNewOutputPath + fs + sNewSubDir;
 263                             if (sNewDiffPath != null)
 264                                 sNewDiffPath = sNewDiffPath + fs + sNewSubDir;
 265                         }
 266
 267                         // NameHelper aNameContainer = new NameHelper(m_sOutputPath, sNewSubDir, FileHelper.getBasename(sEntry));
 268                         // aNameContainer.print();
 269
 270                         if (aGTA.checkIfUsableDocumentType(sEntry))
 271                         {
 272                             runGDCWithStatus(HTMLoutput, LISToutput, sEntry, sNewOutputPath, sNewReferencePath, sNewDiffPath, sNewSubDir);
 273                         }
 274                         if (aGTA.cancelRequest())
 275                         {
 276                             break;
 277                         }
 278                     }
 279                 }
 280             }
 281             else
 282             {
 283                 // check exact name
 284                 if (aGTA.checkIfUsableDocumentType(m_sInputPath))
 285                 {
 286                     runGDCWithStatus(HTMLoutput, LISToutput, m_sInputPath, m_sOutputPath, m_sReferencePath, m_sDiffPath, "");
 287                 }
 288             }
 289
 290             LISToutput.close();
 291             HTMLoutput.close();
 292             log.println("The file '" + HTMLoutput.getFilename() + "' shows a html based status.");
 293             DB.writeHTMLFile(HTMLoutput.getFilename());
 294         }
 295
 296
 297     // -----------------------------------------------------------------------------
 298     void runGDCWithStatus(HTMLOutputter _aHTMLoutput, LISTOutputter _aLISToutput, String _sInputFile, String _sOutputPath, String _sReferencePath, String _sDiffPath, String _sNewSubDir )
 299         {
 300             // start a fresh Office
 301             GraphicalTestArguments aGTA = getGraphicalTestArguments();
 302
 303             OfficeProvider aProvider = null;
 304             // SimpleFileSemaphore aSemaphore = new SimpleFileSemaphore();
 305             if (aGTA.shouldOfficeStart())
 306             {
 307                 // if (OSHelper.isWindows())
 308                 // {
 309                 //     aSemaphore.P(aSemaphore.getSemaphoreFile());
 310                 // }
 311
 312                 aGTA.getPerformance().startTime(PerformanceContainer.OfficeStart);
 313                 aProvider = new OfficeProvider();
 314                 XMultiServiceFactory xMSF = (XMultiServiceFactory) aProvider.getManager(param);
 315                 param.put("ServiceFactory", xMSF);
 316                 aGTA.getPerformance().stopTime(PerformanceContainer.OfficeStart);
 317
 318                 long nStartTime = aGTA.getPerformance().getTime(PerformanceContainer.OfficeStart);
 319                 aGTA = getGraphicalTestArguments(); // get new TestArguments
 320                 aGTA.getPerformance().setTime(PerformanceContainer.OfficeStart, nStartTime);
 321             }
 322
 323             // Watcher Object is need in log object to give a simple way to say if a running office is alive.
 324             // As long as a log comes, it pings the Watcher and says the office is alive, if not an
 325             // internal counter increase and at a given point (300 seconds) the office is killed.
 326             GlobalLogWriter.get().println("Set office watcher");
 327             OfficeWatcher aWatcher = (OfficeWatcher)param.get("Watcher");
 328             GlobalLogWriter.get().setWatcher(aWatcher);
 329             // initializeWatcher(param);
 330
 331             String sStatusRunThrough = "";
 332             String sStatusMessage = "";
 333             try
 334             {
 335                 DB.destination_start();
 336                 // better was:
 337                 // load document
 338                 // create postscript from document
 339                 // check file
 340                 GraphicalDifferenceCheck.checkOneFile(_sInputFile, _sOutputPath, _sReferencePath, _sDiffPath, aGTA);
 341                 sStatusRunThrough = "PASSED, OK";
 342                 DB.destination_finished();
 343             }
 344             catch(ConvWatchCancelException e)
 345             {
 346                 assure(e.getMessage(), false, true);
 347                 sStatusRunThrough = "CANCELLED, FAILED";
 348                 sStatusMessage = e.getMessage();
 349                 DB.destination_failed(sStatusRunThrough, sStatusMessage);
 350             }
 351             catch(ConvWatchException e)
 352             {
 353                 assure(e.getMessage(), false, true);
 354                 sStatusMessage = e.getMessage();
 355                 sStatusRunThrough = "PASSED, FAILED";
 356                 DB.destination_failed(sStatusRunThrough, sStatusMessage);
 357             }
 358             catch(com.sun.star.lang.DisposedException e)
 359             {
 360                 assure(e.getMessage(), false, true);
 361                 sStatusMessage = e.getMessage();
 362                 sStatusRunThrough = "FAILED, FAILED";
 363                 DB.destination_failed(sStatusRunThrough, sStatusMessage);
 364             }
 365
 366             GlobalLogWriter.get().println("Watcher count is: " + aWatcher.getPing());
 367
 368             // Office shutdown
 369             if (aProvider != null)
 370             {
 371                 aProvider.closeExistingOffice(param, true);
 372                 // if (OSHelper.isWindows())
 373                 // {
 374                 //     aSemaphore.V(aSemaphore.getSemaphoreFile());
 375                 //     aSemaphore.sleep(2);
 376                 //     // wait some time maybe an other process will take the semaphore
 377                 //     // I know, this is absolutly dirty, but the whole convwatch is dirty and need a big cleanup.
 378                 // }
 379             }
 380
 381             // -------------------- Status --------------------
 382             String fs = System.getProperty("file.separator");
 383             String sBasename = FileHelper.getBasename(_sInputFile);
 384             String sFilenameNoSuffix = FileHelper.getNameNoSuffix(sBasename);
 385
 386             // -------------------- List of all files -----------------
 387             String sListFile;
 388             if (_sNewSubDir.length() > 0)
 389             {
 390                 sListFile = _sNewSubDir + fs + sFilenameNoSuffix + ".ini";
 391             }
 392             else
 393             {
 394                 sListFile = sFilenameNoSuffix + ".ini";
 395             }
 396             _aLISToutput.writeValue(sListFile);
 397
 398             // -------------------- HTML --------------------
 399             String sLink;
 400             String sLinkDD;
 401             String sLinkName;
 402             String sLinkDDName;
 403             String sHTMLPrefix = aGTA.getHTMLOutputPrefix();
 404
 405             GlobalLogWriter.get().println("----------------------------------------------------------------------");
 406             GlobalLogWriter.get().println(" OutputPath: " + _sOutputPath);
 407             GlobalLogWriter.get().println("    NewPath: " + _sNewSubDir);
 408             GlobalLogWriter.get().println("----------------------------------------------------------------------");
 409
 410 //             if (_sNewSubDir.length() > 0)
 411 //             {
 412 //                 sLink   = sHTMLPrefix /* + "/cw.php?inifile=" */ + _sOutputPath + fs + _sNewSubDir + fs + sFilenameNoSuffix + ".ini";
 413 //                 sLinkDD = sHTMLPrefix /* + "/cw.php?inifile=" */ + _sOutputPath + fs + _sNewSubDir + fs + "DiffDiff_" + sFilenameNoSuffix + ".ini";
 414 //             }
 415 //             else
 416 //             {
 417             sLink = sHTMLPrefix   /* + "/cw.php?inifile=" */ + _sOutputPath + fs + sFilenameNoSuffix + ".ini";
 418                 // sLinkDD = sHTMLPrefix /* + "/cw.php?inifile=" */ + _sOutputPath + fs + _sNewSubDir + fs + "DiffDiff_" + sFilenameNoSuffix + ".ini";
 419             sLinkDD = sHTMLPrefix /* + "/cw.php?inifile=" */ + _sOutputPath + fs + "DiffDiff_" + sFilenameNoSuffix + ".ini";
 420 //             }
 421             sLinkName = sFilenameNoSuffix;
 422             sLinkDDName = sFilenameNoSuffix + " (DiffDiff)";
 423
 424             if (_sDiffPath != null && _sDiffPath.length() > 0)
 425             {
 426                 _aHTMLoutput.indexLine( sLinkDD, sLinkDDName, sLink, sLinkName, sStatusRunThrough, sStatusMessage );
 427             }
 428             else
 429             {
 430                 _aHTMLoutput.indexLine( sLink, sLinkName, "", "", sStatusRunThrough, sStatusMessage );
 431             }
 432
 433         }
 434
 435
 436 }