qadevOOo/runner/convwatch/GfxCompare.java

   1 /*************************************************************************
   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: GfxCompare.java,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package convwatch;
  32
  33 import java.util.ArrayList;
  34 import convwatch.EnhancedComplexTestCase;
  35 import convwatch.PRNCompare;
  36 import convwatch.GraphicalTestArguments;
  37 import helper.URLHelper;
  38 import convwatch.OfficePrint;
  39 import java.io.File;
  40
  41 public class GfxCompare extends EnhancedComplexTestCase
  42 {
  43     // The first of the mandatory functions:
  44     /**
  45      * Return the name of the test.
  46      * In this case it is the actual name of the service.
  47      * @return The tested service.
  48      */
  49     // public String getTestObjectName() {
  50     //     return "ConvWatch runner";
  51     // }
  52
  53     // The second of the mandatory functions: return all test methods as an
  54     // array. There is only one test function in this example.
  55     /**
  56      * Return all test methods.
  57      * @return The test methods.
  58      */
  59
  60     public String[] getTestMethodNames() {
  61         return new String[]{"gfxcompare"};
  62     }
  63
  64     /**
  65      *
  66      * @return a List of software which must accessable as an external executable
  67      */
  68     protected Object[] mustInstalledSoftware()
  69         {
  70             ArrayList aList = new ArrayList();
  71             // Tools from ImageMagick
  72             aList.add( "composite -version" );
  73             aList.add( "identify -version" );
  74
  75             // Ghostscript
  76             aList.add( "gs -version" );
  77             return aList.toArray();
  78         }
  79
  80
  81     GraphicalTestArguments m_aArguments = null;
  82     /**
  83      * The test method itself.
  84      * Don't try to call it from outside, it is started only from qadevOOo runner
  85      */
  86
  87     /* protected */
  88     public void gfxcompare()
  89         {
  90             GlobalLogWriter.set(log);
  91
  92             // check if all need software is installed and accessable
  93             checkEnvironment(mustInstalledSoftware());
  94
  95             m_aArguments = getGraphicalTestArguments();
  96
  97             String sFile1 = (String)param.get("FILE1");
  98             String sFile2 = (String)param.get("FILE2");
  99             compare(sFile1, sFile2);
 100         }
 101
 102     // -----------------------------------------------------------------------------
 103
 104     String createJPEG(String _sFile, String _sAdditional)
 105         {
 106             String sJPEGFile = "";
 107             if (_sFile.startsWith("file:///"))
 108             {
 109                 _sFile = FileHelper.getSystemPathFromFileURL(_sFile);
 110             }
 111             File aFile = new File(_sFile);
 112             if (aFile.exists())
 113             {
 114                 String sAbsFile = aFile.getAbsolutePath();
 115                 if (!sAbsFile.equals(_sFile))
 116                 {
 117                     _sFile = sAbsFile;
 118                 }
 119             }
 120             else
 121             {
 122                 GlobalLogWriter.get().println("File: '" + _sFile + "' doesn't exist.");
 123                 return "";
 124             }
 125             String sFileDir = FileHelper.getPath(_sFile);
 126             String sBasename = FileHelper.getBasename(_sFile);
 127             String sNameNoSuffix = FileHelper.getNameNoSuffix(sBasename);
 128
 129             String fs = System.getProperty("file.separator");
 130             String sTmpDir = util.utils.getUsersTempDir();
 131             if (m_aArguments.getOutputPath() != null)
 132             {
 133                 sTmpDir = m_aArguments.getOutputPath();
 134             }
 135
 136             if (_sFile.toLowerCase().endsWith("ps") ||
 137                 _sFile.toLowerCase().endsWith("prn") ||
 138                 _sFile.toLowerCase().endsWith("pdf"))
 139             {
 140                 // seems to be a Postscript of PDF file
 141
 142                 String[] aList = PRNCompare.createJPEGFromPostscript(sTmpDir, sFileDir, sBasename, m_aArguments.getResolutionInDPI());
 143                 sJPEGFile = aList[0];
 144             }
 145             else if (_sFile.toLowerCase().endsWith("jpg") ||
 146                      _sFile.toLowerCase().endsWith("jpeg"))
 147             {
 148                 // do nothing, it's already a picture.
 149                 return _sFile;
 150             }
 151             else
 152             {
 153                 // we assume it's an office document.
 154                 String sInputURL;
 155                 String sOutputURL;
 156                 String sPrintFileURL;
 157
 158                 String sInputFile = sFileDir + fs + sBasename;
 159                 sInputURL = URLHelper.getFileURLFromSystemPath(sInputFile);
 160
 161                 String sOutputFile = sTmpDir + fs + sBasename;
 162                 sOutputURL = URLHelper.getFileURLFromSystemPath(sOutputFile);
 163
 164                 String sPrintFile = sTmpDir + fs + sNameNoSuffix + _sAdditional + ".ps";
 165                 sPrintFileURL = URLHelper.getFileURLFromSystemPath(sPrintFile);
 166
 167                 try
 168                 {
 169                     OfficePrint.printToFile(m_aArguments, sInputURL, sOutputURL, sPrintFileURL);
 170                     sJPEGFile = createJPEG(sPrintFile, _sAdditional);
 171                 }
 172                 catch (ConvWatchCancelException e)
 173                 {
 174                     GlobalLogWriter.get().println("Exception caught, can't create:" + sPrintFileURL);
 175                 }
 176             }
 177             return sJPEGFile;
 178         }
 179
 180
 181     public String compare(String _sFile1, String _sFile2)
 182         {
 183             String sJPEGFile1 = createJPEG(_sFile1, "-1");
 184             String sJPEGFile2 = createJPEG(_sFile2, "-2");
 185
 186             if (sJPEGFile1.length() > 0 && sJPEGFile2.length() > 0)
 187             {
 188                 String sDiffFile = PRNCompare.compareJPEGs(sJPEGFile1, sJPEGFile2);
 189
 190                 if (sDiffFile.length() > 0)
 191                 {
 192                     GlobalLogWriter.get().println("Difference created: " + sDiffFile);
 193                 }
 194                 return sDiffFile;
 195             }
 196             return "";
 197         }
 198
 199 }