qadevOOo/runner/lib/TestParameters.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 lib;
  20
  21 import java.util.HashMap;
  22
  23 import util.PropertyName;
  24
  25 import com.sun.star.beans.XPropertySet;
  26 import com.sun.star.lang.XMultiServiceFactory;
  27 import com.sun.star.uno.XComponentContext;
  28
  29 /**
  30  * TestParameters describes a parameters (in a form of pairs: name, value) to
  31  * be passed to tests and which may affect the test behaviour. That can be,
  32  * for example, standard paths, connection strings, etc. The TestParameters
  33  * also provides XMultiServiceFactory for the test (tests).
  34  */
  35 public class TestParameters extends HashMap<String,Object> {
  36
  37     /**
  38      * The ConnectionString for Office Connection<br>
  39      * default is 'socket,host=localhost,port=8100'
  40      */
  41     private static final String DefaultConnectionString = "socket,host=localhost,port=8100";
  42
  43     /**
  44      * The Path to the test documents that are loaded during the test <br>
  45      */
  46     private static final String DefaultTestDocumentPath = "unknown";
  47
  48     /**
  49      * 'true' is a debug information should be written, 'false' elsewhere
  50      * these will be provided by the framework.<br>
  51      * Debug information will always be written on standard out.<br>
  52      * default is true
  53      */
  54     private static final boolean DebugIsActive = false;
  55
  56     /**
  57      * Wrapper around "get()" with some debug output
  58      * @param key A key of this table.
  59      * @return The value of this key.
  60      * @see java.util.HashMap
  61      */
  62     @Override
  63     public Object get(Object key) {
  64         Object val = super.get(key);
  65         if (val == null && DebugIsActive) {
  66             System.out.print("Have been asked for key \""+key.toString());
  67             System.out.println("\" which is not part of params.");
  68         }
  69         return val;
  70     }
  71
  72     /**
  73      * Special get method for boolean values: for convenience.
  74      * Will return 'false' if the value is not of "Boolean" type.
  75      * @param key A key of this table.
  76      * @return The value of this key, cast to a boolean type.
  77      */
  78     public boolean getBool(Object key) {
  79         final Object val = super.get(key);
  80         if (val == null) {
  81             return false;
  82         }
  83         if (val instanceof String) {
  84             String sVal = (String)val;
  85             if (sVal.equalsIgnoreCase("true") ||
  86                                             sVal.equalsIgnoreCase("yes")) {
  87                 return true;
  88             }
  89             else if (sVal.equalsIgnoreCase("false") ||
  90                                             sVal.equalsIgnoreCase("no")) {
  91                 return false;
  92             }
  93         }
  94         else if (val instanceof Boolean)
  95             return ((Boolean)val).booleanValue();
  96         return false;
  97     }
  98
  99     /**
 100      * Special get method for integer values: for convenience.
 101      * Will return 0 if the value cannot be interpreted as Integer.
 102      * @param key A key of this table.
 103      * @return The value of this key, cast to an int type.
 104      */
 105     public int getInt(Object key) {
 106         Object val = super.get(key);
 107         if ( val != null ) {
 108             if (val instanceof Integer) {
 109                 return ((Integer)val).intValue();
 110             }
 111             else {
 112                 try {
 113                     if ( val instanceof String ) {
 114                         Integer nr = Integer.valueOf((String)val);
 115                         if (nr.intValue() > 0) return nr.intValue();
 116                     }
 117                 } catch ( java.lang.NumberFormatException nfe) {}
 118             }
 119         }
 120         return 0;
 121     }
 122
 123
 124     /**
 125      * Wrapper around "put()"
 126      * @param key A key of this table.
 127      * @param val The value of the key.
 128      * @return The value of this key.
 129      * @see java.util.HashMap
 130      */
 131     @Override
 132     public Object put(String key, Object val) {
 133         return super.put(key,val);
 134     }
 135
 136     /**
 137      * Constructor, defaults for Parameters are set.
 138      */
 139     public TestParameters() {
 140         //fill the propertyset
 141         String user = System.getProperty("user.name");
 142         if ( user != null)
 143         {
 144             String PipeConnectionString = "pipe,name=" + user;
 145             put(PropertyName.PIPE_CONNECTION_STRING,PipeConnectionString);
 146             put(PropertyName.USE_PIPE_CONNECTION, Boolean.TRUE);
 147         }
 148         put(PropertyName.CONNECTION_STRING, DefaultConnectionString);
 149         put(PropertyName.TEST_BASE, "java_fat");
 150         put(PropertyName.TEST_DOCUMENT_PATH, DefaultTestDocumentPath);
 151         put(PropertyName.LOGGING_IS_ACTIVE, Boolean.TRUE);
 152         put(PropertyName.DEBUG_IS_ACTIVE, Boolean.valueOf(DebugIsActive));
 153         put(PropertyName.OUT_PRODUCER, "stats.SimpleOutProducer");
 154         put(PropertyName.OFFICE_PROVIDER, "helper.OfficeProvider");
 155         put(PropertyName.LOG_WRITER, "stats.SimpleLogWriter");
 156         put(PropertyName.APP_EXECUTION_COMMAND, "");
 157         put(PropertyName.TIME_OUT, Integer.valueOf(3000000));
 158         put(PropertyName.THREAD_TIME_OUT, Integer.valueOf(3000000));
 159         put(PropertyName.AUTO_RESTART, Boolean.FALSE);
 160
 161         // get the operating system
 162         put(PropertyName.UNORC_NAME, getUnoRcName());
 163
 164         //For compatibility Reasons
 165         System.setProperty("DOCPTH", DefaultTestDocumentPath);
 166     }
 167
 168     /**
 169      * @return a XMultiServiceFactory to be used by a test (tests).
 170      */
 171     public XMultiServiceFactory getMSF() {
 172         Object ret = null;
 173         ret = get("ServiceFactory");
 174         return (XMultiServiceFactory) ret;
 175     }
 176
 177     public XComponentContext getComponentContext() {
 178         Object context = get( "ComponentContext" );
 179         if ( context == null )
 180         {
 181             XPropertySet factoryProps = com.sun.star.uno.UnoRuntime.queryInterface(
 182                 XPropertySet.class, getMSF() );
 183             try
 184             {
 185                 context = com.sun.star.uno.UnoRuntime.queryInterface(
 186                     XComponentContext.class, factoryProps.getPropertyValue( "DefaultContext" ) );
 187                 put( "ComponentContext", context );
 188             }
 189             catch( com.sun.star.beans.UnknownPropertyException e ) { }
 190             catch( com.sun.star.lang.WrappedTargetException e ) { }
 191         }
 192         return (XComponentContext)context;
 193     }
 194
 195     /**
 196      * @return The uno rc file name uno.ini for windows and unorc for everything else
 197      */
 198     private String getUnoRcName() {
 199         String osname = System.getProperty ("os.name").toLowerCase ();
 200         if (osname.indexOf ("windows")>-1) {
 201             return "uno.ini";
 202         }
 203         return "unorc";
 204     }
 205
 206 }// finish class TestParameters