qadevOOo/runner/org/openoffice/Runner.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: Runner.java,v $
  10  * $Revision: 1.5.8.2 $
  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 package org.openoffice;
  31
  32 import java.util.Enumeration;
  33 import java.util.Properties;
  34 import java.util.StringTokenizer;
  35 import lib.TestParameters;
  36 import util.DynamicClassLoader;
  37 import base.TestBase;
  38 import helper.ClParser;
  39 import helper.CfgParser;
  40
  41 /**
  42  * The main class, will call ClParser and CfgParser to <br>
  43  * fill the TestParameters.<br>
  44  * Will then call the appropriate Testbase to run the tests.
  45  */
  46 public class Runner
  47 {
  48
  49     private static long m_nStartTime;
  50
  51     public static long getRunnerStartTime()
  52     {
  53         return m_nStartTime;
  54     }
  55     /*
  56     simple helper functions to start/stop a timer, to know how long a process need in milliseconds
  57      */
  58
  59     private static long getTime()
  60     {
  61         return System.currentTimeMillis();
  62     }
  63
  64     private static void setStartTime(long _nStartTime)
  65     {
  66         m_nStartTime = _nStartTime;
  67     }
  68
  69     /*
  70     return the time, which is done until last startTime()
  71      */
  72     public static long meanTime(long _nCurrentTimer)
  73     {
  74         if (_nCurrentTimer == 0)
  75         {
  76             System.out.println("Forgotten to initialise a start timer?");
  77             return 0;
  78         }
  79         long nMeanTime = getTime();
  80         return nMeanTime - _nCurrentTimer;
  81     }
  82
  83     private static String beautifyTime(long _nTime)
  84     {
  85         long sec = (_nTime / 1000) % 60;
  86         long min = (_nTime / (60 * 1000)) % 60;
  87         long hour = _nTime / (60 * 60 * 1000);
  88         StringBuffer aTime = new StringBuffer();
  89         aTime.append(helper.StringHelper.createValueString((int) hour, 2)).
  90                 append(':').
  91                 append(helper.StringHelper.createValueString((int) min, 2)).
  92                 append(':').
  93                 append(helper.StringHelper.createValueString((int) sec, 2));
  94         return aTime.toString();
  95     }
  96
  97     /**
  98      Helper to check if there are problems with Cygwin Path variables.
  99      */
 100     private static boolean checkVariableForCygwin(String _sVariable)
 101     {
 102         if (_sVariable == null)
 103         {
 104             return false;
 105         }
 106         if (_sVariable.startsWith("/cygdrive"))
 107         {
 108             return true;
 109         }
 110         return false;
 111     }
 112
 113     private static boolean checkPathVariable(String _sPath, String delim)
 114     {
 115         String sPath = System.getProperty(_sPath);
 116         if (sPath != null)
 117         {
 118             StringTokenizer aTokenEnum = new StringTokenizer(sPath, delim);
 119             while (aTokenEnum.hasMoreElements())
 120             {
 121                 String sToken = (String) aTokenEnum.nextElement();
 122                 if (checkVariableForCygwin(sToken))
 123                 {
 124                     System.err.println("ERROR: OOoRunner detect cygwin path in '" + _sPath + "'");
 125                     return true;
 126                 }
 127             }
 128         }
 129         return false;
 130     }
 131
 132     private static void checkAllVariablesForCygwinPath(TestParameters _aParams)
 133     {
 134         // ----- check all System.getProperty(key) variables -----
 135         String sOsName = System.getProperty("os.name");
 136         if (!sOsName.toLowerCase().startsWith("windows"))
 137         {
 138             // we need to check only on windows
 139             return;
 140         }
 141
 142         Properties aProps = System.getProperties();
 143         Enumeration aEnum = aProps.propertyNames();
 144         // Enumeration aEnum = aProps.elements();        // these are only the values
 145         boolean bEmergencyStop = false;
 146
 147         while (aEnum.hasMoreElements())
 148         {
 149             String sKey = (String) aEnum.nextElement();
 150             String sValue = System.getProperty(sKey);
 151
 152             if (checkVariableForCygwin(sValue))
 153             {
 154                 System.err.println("ERROR: OOoRunner detect cygwin path in '" + sKey + ":=" + sValue + "'");
 155                 bEmergencyStop = true;
 156             }
 157         }
 158
 159         // ----- check path variables separatly -----
 160         String sDelim = System.getProperty("path.separator");
 161         bEmergencyStop |= checkPathVariable("java.library.path", sDelim);
 162         bEmergencyStop |= checkPathVariable("java.class.path", sDelim);
 163         bEmergencyStop |= checkPathVariable("sun.boot.class.path", sDelim);
 164
 165         // ----- check all TestParameters -----
 166         aEnum = _aParams.keys();
 167         while (aEnum.hasMoreElements())
 168         {
 169             String sKey = (String) aEnum.nextElement();
 170             if (_aParams.get(sKey) instanceof String)
 171             {
 172                 String sValue = (String) _aParams.get(sKey);
 173
 174                 if (checkVariableForCygwin(sValue))
 175                 {
 176                     System.err.println("ERROR: OOoRunner detect cygwin path in '" + sKey + ":=" + sValue + "'");
 177                     bEmergencyStop = true;
 178                 }
 179             }
 180         }
 181
 182         if (bEmergencyStop)
 183         {
 184             System.exit(-1);
 185         }
 186     }
 187
 188     public static void main(String[] args)
 189     {
 190         System.out.println("OOoRunner Main() version from 20090825 (yyyymmdd)");
 191
 192         setStartTime(getTime());
 193
 194         DynamicClassLoader dcl = new DynamicClassLoader();
 195
 196         // get a class for test parameters
 197         TestParameters param = new TestParameters();
 198
 199         ClParser cli = new ClParser();
 200
 201         //parse the commandline arguments if an ini-parameter is given
 202         String iniFile = cli.getIniPath(args);
 203
 204         //initialize cfgParser with ini-path
 205         CfgParser ini = new CfgParser(iniFile);
 206
 207         //parse ConfigFile
 208         ini.getIniParameters(param);
 209
 210
 211         //parse the commandline arguments if an runnerprops-parameter is given
 212         String runnerIniFile = cli.getRunnerIniPath(args);
 213
 214         //initialize cfgParser with ini-path
 215         CfgParser runnerIni = new CfgParser(runnerIniFile);
 216
 217         //parse ConfigFile
 218         runnerIni.getIniParameters(param);
 219
 220         //parse the commandline arguments
 221         // TODO: no right error message, if no parameter given!
 222         cli.getCommandLineParameter(param, args);
 223
 224         Object tj = param.get("TestJob");
 225
 226         if (tj == null)
 227         {
 228             System.out.println("==========================================================================");
 229             System.out.println("No TestJob given, please make sure that you ");
 230             System.out.println("a.) called the OOoRunner with the paramter -o <job> or -sce <scenarioFile>");
 231             System.out.println("or");
 232             System.out.println("b.) have an entry called TestJob in your used properties file");
 233             System.out.println("==========================================================================");
 234             System.exit(-1);
 235         }
 236
 237         System.out.println("TestJob: " + tj);
 238         String sName = "base." + (String) param.get("TestBase");
 239         TestBase toExecute = (TestBase) dcl.getInstance(sName);
 240
 241         checkAllVariablesForCygwinPath(param);
 242
 243         boolean worked = toExecute.executeTest(param);
 244         long nTime = meanTime(getRunnerStartTime());
 245         String sBeautifyTime = beautifyTime(nTime);
 246
 247         System.out.println("Job run took: " + nTime + "ms " + " [" + sBeautifyTime + "]");
 248
 249         if (!worked)
 250         {
 251             System.out.println("Job " + param.get("TestJob") + " failed");
 252             System.exit(-1);
 253         }
 254         else
 255         {
 256             System.out.println("Job " + param.get("TestJob") + " done");
 257             System.exit(0);
 258         }
 259     }
 260 }