com.paypal.selion.configuration

Class Config

java.lang.Object

com.paypal.selion.configuration.Config

public final class Config
extends Object

A configuration object that contains properties needed throughout SeLion. These options can be configured via the TestNG formatted testng-suite.xml file. The testng-suite.xml file is used to override the default settings, so only the data you want to modify from default values should be specified in the suite configuration file. Any data not found in the testng-suite.xml file will use the built-in defaults.
Note that some configuration properties are global-only in scope. Any value set for these applies to all suite tests executed (possibly in parallel). Properties that must be specified for global use are specified below with "(GLOBAL)". These properties cannot be used in SeLionLocal configuration instances. The others can be specified for Global or Local (test) scope.

 <!-- If parameter is empty string or omitted, please see defaults -->
 
 <!-- SELENIUM CONFIGURATION -->
 
 <!-- optional, defaults to "" or localhost when runLocally is true (GLOBAL) -->
 <parameter name="seleniumhost" value="" />
 <!-- optional, defaults to 4444 (GLOBAL) -->
 <parameter name="seleniumport" value="" />
 <!-- optional, defaults to *firefox  -->
 <parameter name="browser" value="*firefox" />
 <!-- optional, defaults to false  (GLOBAL) -->
 <parameter name="runLocally" value="true" />
 <!-- optional, turns automatic screen shots for click handlers on/off, defaults to true (GLOBAL) -->
 <parameter name="autoScreenShot" value="true" />
 <!-- optional, used when runLocally is true, defaults to 'default' -->
 <parameter name="profileName" value="SeleniumProfile" />
 
 <!-- SELION FILES LOCATION -->
 
 <!-- optional, default to selionFiles (GLOBAL) -->
 <parameter name="basedir" value=""  />
 <!-- optional, default to ${selionFiles.basedir}/selionLogs (GLOBAL) -->
 <parameter name="workDir"  value="" />
 

All other configuration settings can be set in a similar fashion.

Also, system properties and/or environment variables can also be used to configure SeLion. The values used should always start with "SELION_" and end with the value you would like the set. The variable equals the Config.ConfigProperty variable name. So, for instance, to set the execution_timeout to "180000", the following system property or environment variable should be set prior to initializing SeLion:

 SELION_EXECUTION_TIMEOUT = 180000
 

The order of initialization for Configuration values is

1. System properties (Highest Precedence)
2. Environment variables
3. From a testng-suite.xml file
4. SeLion defaults

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.ConfigProperty SeLion config properties

Method Summary

Modifier and Type	Method and Description
static boolean	checkPropertyExists(String propertyName) Checks if property exists in the configuration
static boolean	getBoolConfigProperty(Config.ConfigProperty configProperty) Returns a configuration property boolean value based off the Config.ConfigProperty
static boolean	getBoolConfigProperty(String configProperty) Returns a configuration property boolean value based off the Config.ConfigProperty
static String	getConfigProperty(Config.ConfigProperty configProperty) Returns a configuration property String value based off the Config.ConfigProperty
static String	getConfigProperty(String configProperty) Returns a configuration property String value based off the Config.ConfigProperty
static int	getIntConfigProperty(Config.ConfigProperty configProperty) Returns a configuration property int value based off the Config.ConfigProperty
static int	getIntConfigProperty(String configProperty) Returns a configuration property int value based off the Config.ConfigProperty
static List<Object>	getListConfigProperty(Config.ConfigProperty configProperty) Returns a configuration property List value based off the Config.ConfigProperty
static List<Object>	getListConfigProperty(String configProperty) Returns a configuration property List value based off the Config.ConfigProperty
static void	initConfig() Reads and parses configuration file Initializes the configuration, reloading all data
static void	initConfig(org.testng.ISuite suite) Parses suite parameters and generates SeLion Config object
static void	initConfig(org.testng.ITestContext context) Parses configuration file and extracts values for test environment
static void	initConfig(Map<Config.ConfigProperty,String> initialValues) Initializes the configuration, reloading all data while adding the supplied initialValues to the configuration.
static void	printSeLionConfigValues() Prints SeLion Config Values
static void	setConfigProperty(Config.ConfigProperty configProperty, Object configPropertyValue) Sets a SeLion configuration value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initConfig

public static void initConfig(org.testng.ISuite suite)

Parses suite parameters and generates SeLion Config object

Parameters:

suite - list of parameters from configuration file within <suite></suite> tag

initConfig

public static void initConfig(org.testng.ITestContext context)

Parses configuration file and extracts values for test environment

Parameters:

context - list of parameters includes values within <suite></suite> and <test></test> tags

initConfig

public static void initConfig()

Reads and parses configuration file Initializes the configuration, reloading all data

printSeLionConfigValues

public static void printSeLionConfigValues()

Prints SeLion Config Values

initConfig

public static void initConfig(Map<Config.ConfigProperty,String> initialValues)

Initializes the configuration, reloading all data while adding the supplied initialValues to the configuration.

Parameters:

initialValues - The initial set of values used to configure SeLion

getConfigProperty

public static String getConfigProperty(Config.ConfigProperty configProperty)

Returns a configuration property String value based off the Config.ConfigProperty

Parameters:

configProperty - The configuration property value to return

Returns:

The configuration property String value.

getListConfigProperty

public static List<Object> getListConfigProperty(Config.ConfigProperty configProperty)

Returns a configuration property List value based off the Config.ConfigProperty

Parameters:

configProperty - The configuration property value to return

Returns:

The configuration property List value or an empty List.

getIntConfigProperty

public static int getIntConfigProperty(Config.ConfigProperty configProperty)

Returns a configuration property int value based off the Config.ConfigProperty

Parameters:

configProperty - The configuration property value to return

Returns:

The configuration property int value

getBoolConfigProperty

public static boolean getBoolConfigProperty(Config.ConfigProperty configProperty)

Returns a configuration property boolean value based off the Config.ConfigProperty

Parameters:

configProperty - The configuration property value to return

Returns:

The configuration property boolean value

getConfigProperty

public static String getConfigProperty(String configProperty)

Returns a configuration property String value based off the Config.ConfigProperty

Parameters:

configProperty - String Property Name

Returns:

The configuration property String value.

getListConfigProperty

public static List<Object> getListConfigProperty(String configProperty)

Returns a configuration property List value based off the Config.ConfigProperty

Parameters:

configProperty - String Property Name

Returns:

The configuration property List value or an empty List.

getIntConfigProperty

public static int getIntConfigProperty(String configProperty)

Returns a configuration property int value based off the Config.ConfigProperty

Parameters:

configProperty - String Property Name

Returns:

The configuration property int value

getBoolConfigProperty

public static boolean getBoolConfigProperty(String configProperty)

Returns a configuration property boolean value based off the Config.ConfigProperty

Parameters:

configProperty - String Property Name

Returns:

The configuration property boolean value

checkPropertyExists

public static boolean checkPropertyExists(String propertyName)

Checks if property exists in the configuration

Parameters:

propertyName - String Property Name

Returns:

true or false

setConfigProperty

public static void setConfigProperty(Config.ConfigProperty configProperty,
                                     Object configPropertyValue)

Sets a SeLion configuration value. This is useful when you want to override or set a setting.

Parameters:

configProperty - The configuration element to set

configPropertyValue - The value of the configuration element

Throws:

IllegalArgumentException - If problems occur during the set