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