com.paypal.selion.configuration

Enum Config.ConfigProperty

java.lang.Object

java.lang.Enum<Config.ConfigProperty>

com.paypal.selion.configuration.Config.ConfigProperty

All Implemented Interfaces:

Serializable, Comparable<Config.ConfigProperty>

Enclosing class:

Config

public static enum Config.ConfigProperty
extends Enum<Config.ConfigProperty>

SeLion config properties

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANDROID_APP_MAIN_ACTIVITY This parameter represents the main activity of Android mobile appplication.
ANDROID_APP_PACKAGE This parameter represents the package of Android mobile application.
AUTO_SCREEN_SHOT Automatically take screen shots.
BASE_DIR The base directory for SeLion files Default is set to selionFiles
BROWSER Browser specified by user. Default is set to firefox
BROWSER_CAPABILITY_PLATFORM platform is specified by user. Default is set to ANY Supporting values are: ANDROID, ANY, LINUX, MAC, UNIX, VISTA, WINDOWS, XP.
BROWSER_CAPABILITY_SUPPORT_JAVASCRIPT Should javascript capability be enabled on the browser for the AUT.
BROWSER_CAPABILITY_VERSION version specified by user when working with custom browser needs.
BROWSER_HEIGHT Set the Height of the Browser Window Should be a whole number
BROWSER_WIDTH Set the Width of the Browser Window Should be a whole number
DOWNLOAD_DEPENDENCIES Automatically attempt to download various webdriver dependencies (chromedriver, etc) if they are not available.
DOWNLOAD_TIMEOUT Timeout for downloading dependencies, in milliseconds. Used in SeLion to configure the download timeout Default is set to 600000
ELEMENT_EVENT_LISTENER Use this parameter to provide SeLion with a custom element listener that implements ElementEventListener.
ENABLE_GUI_LOGGING Turn this flag ON to see GUI actions such as loading a URL, click/setting text etc., being logged into the test reports that get generated by SeLion.
EXECUTION_TIMEOUT Timeout for an execution command, in milliseconds. Used in SeLion to configure Selenium timeouts Default is set to 120000
GUI_DATA_DIR Directory with page asset files to read info about GUI controls from. Default is set to GUIData in resources
LOG_PAGES Automatically log pages source code. Used in conjunction with AUTO_SCREEN_SHOT. Default is set to true
MOBILE_APP_FOLDER This parameter represents the folder which would contain the mobile app.
MOBILE_APP_LANGUAGE This parameter represents the language to be used.
MOBILE_APP_LOCALE This parameter represents the locale to be used.
MOBILE_APP_NAME This parameter represents the name of the app that is to be spawned.
MOBILE_APP_PATH This parameter represents the fully qualified path of the app that is to be spawned.
MOBILE_DEVICE This parameter represents device.
MOBILE_DEVICE_TYPE This parameter represents the device type.
MOBILE_DRIVER_SESSION_TIMEOUT Maximum duration of a session duration in milliseconds.
MOBILE_NODE_TYPE Use this parameter to execute mobile test cases using respective mobile driver.
MOBILE_PLATFORM mobile platform test suite is designed for (iOS or Android) Default is set to undefined
PRINT_DEBUG_INFO To print debug info (about Browser/Selenium Version/Client OS) for user. Default is set to true
SAUCELAB_API_KEY This parameter is used to pass SauceLabs user name
SAUCELAB_TUNNEL_ID This parameter is used to pass SauceLabs tunnel identifier
SAUCELAB_TUNNEL_USER_ID This parameter is used to pass SauceLabs parent tunnel user id
SAUCELAB_USER_NAME This parameter is used to pass SauceLabs user name
SELENDROID_DEVICE_SERIAL Device Serial to use. Default is selected automatically by Selendroid
SELENDROID_EMULATOR_START_TIMEOUT Timeout that will be used to start Android emulators. The value for this parameter is used as the value of timeoutEmulatorStart for selendroid. This configuration affects LOCAL EXECUTION RUNS only i.e., when SELENIUM_RUN_LOCALLY is set to true. The unit is milliseconds. Default is set to 300000 milliseconds.
SELENDROID_SERVER_FORCE_REINSTALL Force Reinstall the Selendroid Server and AUT. Default is set to false
SELENDROID_SERVER_PORT Selendroid Server port to use. Defaults to the value used by Selendroid (8080)
SELENDROID_SERVER_START_TIMEOUT Maximum time in milliseconds to wait for the selendroid-server to come up on the device. The value for this parameter is used as the value of serverStartTimeout for selendroid. This configuration affects LOCAL EXECUTION RUNS only i.e., when SELENIUM_RUN_LOCALLY is set to true. The unit is milliseconds. Default is set to 20000 milliseconds.
SELENIUM_CHROMEDRIVER_PATH The path to the chromedriver executable on the local machine.
SELENIUM_CUSTOM_CAPABILITIES_PROVIDER Use this parameter to provide SeLion with a custom capabilities provider.
SELENIUM_EDGEDRIVER_PATH The path to the EdgeDriver executable on the local machine.
SELENIUM_FIREFOX_PROFILE The firefox profile that is to be used for local/remote runs.
SELENIUM_GECKODRIVER_PATH The path to the Gecko/Marionette driver executable file on the local machine.
SELENIUM_HOST Selenium host might be localhost or another location where a Selenium server is running.
SELENIUM_IEDRIVER_PATH The path to the IEDriver executable on the local machine.
SELENIUM_PHANTOMJS_PATH The path to the PhantomJS executable on the local machine.
SELENIUM_PORT Selenium port, any port where Selenium is running.
SELENIUM_PROXY_HOST Use this parameter to set the Proxy server name to be used.
SELENIUM_PROXY_PORT Use this parameter to set the Proxy server port to be used.
SELENIUM_RUN_LOCALLY Flip this parameter to true if you would like a browser to be spawned locally on your machine and run automation tests there.
SELENIUM_SAUCELAB_GRID_CONFIG_FILE The name of the JSON file that contains the configuration customization info needed for saucelabs.
SELENIUM_USE_GECKODRIVER Flip this parameter to true to enable the use of Gecko/marionette driver (PKA wires) with Firefox.
SELENIUM_USE_SAUCELAB_GRID Use this parameter to indicate if your remote runs are to be run against the sauce lab grid or against your own grid.
SELENIUM_USERAGENT Use this parameter to set the user agent for firefox when working with Mobile version.
SELENIUM_WEBDRIVER_EVENT_LISTENER Use this parameter to provide SeLion with a custom listener which can be plugged into RemoteWebDriver CommandExecutor.
SITE_LOCALE Site will show country used for tests. Default is set to US
WORK_DIR The work directory of SeLion

Method Summary

Modifier and Type	Method and Description
static Config.ConfigProperty	find(String name) Find the Enum for the specified property name.
String	getDefaultValue() Returns the default value for this configuration property
String	getName() Returns the name of this configuration property
boolean	isGlobalScopeOnly() Answer if the property is a global only property (i.e only Suite scope param / System / Env Property)
static Config.ConfigProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static Config.ConfigProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTO_SCREEN_SHOT

public static final Config.ConfigProperty AUTO_SCREEN_SHOT

Automatically take screen shots.

SELENIUM_HOST

public static final Config.ConfigProperty SELENIUM_HOST

Selenium host might be localhost or another location where a Selenium server is running. Used when SELENIUM_RUN_LOCALLY is false.
Default is set to ""

SELENIUM_PORT

public static final Config.ConfigProperty SELENIUM_PORT

Selenium port, any port where Selenium is running. Used when SELENIUM_RUN_LOCALLY is false
Default is set to 4444

SELENIUM_FIREFOX_PROFILE

public static final Config.ConfigProperty SELENIUM_FIREFOX_PROFILE

The firefox profile that is to be used for local/remote runs.
Use this when you would like to have firefox work with your custom firefox profile.
You can either specify the name of the profile or you can specify the directory location of your firefox profile.
The framework internally first assumes it to be a profile name. If that assumption fails we fail-over to assuming it to be the firefox profile directory. If that also fails we will work with an anonymous firefox profile.

WARNING:
Please be aware that if your firefox profile directory is very huge (above ~10 MB) then there are chances that it can crash your local JVM (be it your desktop or your fusion build job).

SELENIUM_SAUCELAB_GRID_CONFIG_FILE

public static final Config.ConfigProperty SELENIUM_SAUCELAB_GRID_CONFIG_FILE

The name of the JSON file that contains the configuration customization info needed for saucelabs. By default, the configurations specified at Sauce labs Configurations are applicable.

SELENIUM_CHROMEDRIVER_PATH

public static final Config.ConfigProperty SELENIUM_CHROMEDRIVER_PATH

The path to the chromedriver executable on the local machine. This parameter is taken into consideration for local runs involving the Google Chrome browser.

SELENIUM_PHANTOMJS_PATH

public static final Config.ConfigProperty SELENIUM_PHANTOMJS_PATH

The path to the PhantomJS executable on the local machine. This parameter is taken into consideration for local runs involving the PhantomJS browser.

SELENIUM_IEDRIVER_PATH

public static final Config.ConfigProperty SELENIUM_IEDRIVER_PATH

The path to the IEDriver executable on the local machine. This parameter is taken into consideration for local runs involving the IE browser.

SELENIUM_EDGEDRIVER_PATH

public static final Config.ConfigProperty SELENIUM_EDGEDRIVER_PATH

The path to the EdgeDriver executable on the local machine. This parameter is taken into consideration for local runs involving the Edge browser.

SELENIUM_USE_GECKODRIVER

public static final Config.ConfigProperty SELENIUM_USE_GECKODRIVER

Flip this parameter to true to enable the use of Gecko/marionette driver (PKA wires) with Firefox. This is used for local as well as remote grid executions using Firefox browser.

SELENIUM_GECKODRIVER_PATH

public static final Config.ConfigProperty SELENIUM_GECKODRIVER_PATH

The path to the Gecko/Marionette driver executable file on the local machine. This parameter is taken into consideration for local runs only with the Firefox browser.

SELENIUM_USERAGENT

public static final Config.ConfigProperty SELENIUM_USERAGENT

Use this parameter to set the user agent for firefox when working with Mobile version. This parameter should be set in conjunction with the parameter BROWSER

SELENIUM_PROXY_HOST

public static final Config.ConfigProperty SELENIUM_PROXY_HOST

Use this parameter to set the Proxy server name to be used.

SELENIUM_PROXY_PORT

public static final Config.ConfigProperty SELENIUM_PROXY_PORT

Use this parameter to set the Proxy server port to be used.

SELENIUM_USE_SAUCELAB_GRID

public static final Config.ConfigProperty SELENIUM_USE_SAUCELAB_GRID

Use this parameter to indicate if your remote runs are to be run against the sauce lab grid or against your own grid. This flag is required when running against the Sauce lab grid because we need to disable fetching of the WebDriver node IP and Port details.

MOBILE_NODE_TYPE

public static final Config.ConfigProperty MOBILE_NODE_TYPE

Use this parameter to execute mobile test cases using respective mobile driver. The valid values are MobileNodeType

SELENIUM_CUSTOM_CAPABILITIES_PROVIDER

public static final Config.ConfigProperty SELENIUM_CUSTOM_CAPABILITIES_PROVIDER

Use this parameter to provide SeLion with a custom capabilities provider. The value for this parameter would be the fully qualified class name which is a sub-class of DefaultCapabilitiesBuilder. If more than one custom capabilities providers are required, please separate their fully qualified class names with commas.

SELENIUM_WEBDRIVER_EVENT_LISTENER

public static final Config.ConfigProperty SELENIUM_WEBDRIVER_EVENT_LISTENER

Use this parameter to provide SeLion with a custom listener which can be plugged into RemoteWebDriver CommandExecutor. If the fully qualified class implements EventListener then SeLion will invoke the custom implementation provided by you as and when the relevant events happen. If more than one custom listeners are required, please separate the fully qualified class names with commas.

SELENIUM_RUN_LOCALLY

public static final Config.ConfigProperty SELENIUM_RUN_LOCALLY

Flip this parameter to true if you would like a browser to be spawned locally on your machine and run automation tests there. Default is set to false which means your tests are always going to be run against a Remote Grid environment as pointed to by SELENIUM_HOST.

MOBILE_APP_FOLDER

public static final Config.ConfigProperty MOBILE_APP_FOLDER

This parameter represents the folder which would contain the mobile app. This parameter is currently only useful for local runs. This is the folder from which applications would be searched for by SeLion when it comes to mobile automation in local runs. Please ensure that all the built applications reside in this folder. If no value is provided, SeLion assumes that the application is available under a directory named "Applications" in the current working directory.

MOBILE_APP_NAME

public static final Config.ConfigProperty MOBILE_APP_NAME

This parameter represents the name of the app that is to be spawned. Specifying the name of the mobile app should suffice. Note: Use of this parameter is not recommended for test suites which test different mobile applications or different versions of the same mobile applications.

MOBILE_APP_PATH

public static final Config.ConfigProperty MOBILE_APP_PATH

This parameter represents the fully qualified path of the app that is to be spawned. For app exist in the local disk this should be an absolute path, for app exist in the remote location it should be http URL and for app exist in sauce cloud it can be sauce storage like "sauce-storage:testApp.apk".

MOBILE_APP_LANGUAGE

public static final Config.ConfigProperty MOBILE_APP_LANGUAGE

This parameter represents the language to be used. By default it is always English represented as en

MOBILE_APP_LOCALE

public static final Config.ConfigProperty MOBILE_APP_LOCALE

This parameter represents the locale to be used. By default it is always US English represented as en_US

ANDROID_APP_MAIN_ACTIVITY

public static final Config.ConfigProperty ANDROID_APP_MAIN_ACTIVITY

This parameter represents the main activity of Android mobile appplication. By default it is always empty.

ANDROID_APP_PACKAGE

public static final Config.ConfigProperty ANDROID_APP_PACKAGE

This parameter represents the package of Android mobile application. By default it is always empty.

MOBILE_DEVICE

public static final Config.ConfigProperty MOBILE_DEVICE

This parameter represents device.

MOBILE_DEVICE_TYPE

public static final Config.ConfigProperty MOBILE_DEVICE_TYPE

This parameter represents the device type.

ELEMENT_EVENT_LISTENER

public static final Config.ConfigProperty ELEMENT_EVENT_LISTENER

Use this parameter to provide SeLion with a custom element listener that implements ElementEventListener. SeLion will invoke the custom implementation when the relevant events happen. If more than one custom listeners is needed, please separate the fully qualified class names with commas.

SAUCELAB_USER_NAME

public static final Config.ConfigProperty SAUCELAB_USER_NAME

This parameter is used to pass SauceLabs user name

SAUCELAB_API_KEY

public static final Config.ConfigProperty SAUCELAB_API_KEY

This parameter is used to pass SauceLabs user name

SAUCELAB_TUNNEL_USER_ID

public static final Config.ConfigProperty SAUCELAB_TUNNEL_USER_ID

This parameter is used to pass SauceLabs parent tunnel user id

SAUCELAB_TUNNEL_ID

public static final Config.ConfigProperty SAUCELAB_TUNNEL_ID

This parameter is used to pass SauceLabs tunnel identifier

GUI_DATA_DIR

public static final Config.ConfigProperty GUI_DATA_DIR

Directory with page asset files to read info about GUI controls from.
Default is set to GUIData in resources

SITE_LOCALE

public static final Config.ConfigProperty SITE_LOCALE

Site will show country used for tests.
Default is set to US

MOBILE_PLATFORM

public static final Config.ConfigProperty MOBILE_PLATFORM

mobile platform test suite is designed for (iOS or Android)
Default is set to undefined

BROWSER

public static final Config.ConfigProperty BROWSER

Browser specified by user.
Default is set to firefox

BROWSER_CAPABILITY_VERSION

public static final Config.ConfigProperty BROWSER_CAPABILITY_VERSION

version specified by user when working with custom browser needs.

ENABLE_GUI_LOGGING

public static final Config.ConfigProperty ENABLE_GUI_LOGGING

Turn this flag ON to see GUI actions such as loading a URL, click/setting text etc., being logged into the test reports that get generated by SeLion.

BASE_DIR

public static final Config.ConfigProperty BASE_DIR

The base directory for SeLion files
Default is set to selionFiles

WORK_DIR

public static final Config.ConfigProperty WORK_DIR

The work directory of SeLion

BROWSER_CAPABILITY_PLATFORM

public static final Config.ConfigProperty BROWSER_CAPABILITY_PLATFORM

platform is specified by user.
Default is set to ANY Supporting values are: ANDROID, ANY, LINUX, MAC, UNIX, VISTA, WINDOWS, XP.

BROWSER_CAPABILITY_SUPPORT_JAVASCRIPT

public static final Config.ConfigProperty BROWSER_CAPABILITY_SUPPORT_JAVASCRIPT

Should javascript capability be enabled on the browser for the AUT. By default javascript will be enabled on the client browser, but this flag can be used to toggle this setting.

BROWSER_HEIGHT

public static final Config.ConfigProperty BROWSER_HEIGHT

Set the Height of the Browser Window
Should be a whole number

BROWSER_WIDTH

public static final Config.ConfigProperty BROWSER_WIDTH

Set the Width of the Browser Window
Should be a whole number

EXECUTION_TIMEOUT

public static final Config.ConfigProperty EXECUTION_TIMEOUT

Timeout for an execution command, in milliseconds.

Used in SeLion to configure Selenium timeouts
Default is set to 120000

DOWNLOAD_DEPENDENCIES

public static final Config.ConfigProperty DOWNLOAD_DEPENDENCIES

Automatically attempt to download various webdriver dependencies (chromedriver, etc) if they are not available.
Default is set to false

DOWNLOAD_TIMEOUT

public static final Config.ConfigProperty DOWNLOAD_TIMEOUT

Timeout for downloading dependencies, in milliseconds.

Used in SeLion to configure the download timeout
Default is set to 600000

LOG_PAGES

public static final Config.ConfigProperty LOG_PAGES

Automatically log pages source code.
Used in conjunction with AUTO_SCREEN_SHOT.
Default is set to true

MOBILE_DRIVER_SESSION_TIMEOUT

public static final Config.ConfigProperty MOBILE_DRIVER_SESSION_TIMEOUT

Maximum duration of a session duration in milliseconds. Session will be forcefully terminated if it takes longer.
The value of this parameter is used as the value of sessionTimeout for ios-driver and selendroid.
This configuration affects LOCAL EXECUTION RUNS only i.e., when SELENIUM_RUN_LOCALLY is set to true.
The unit is milliseconds.
Default is set to 1800000 milliseconds.

SELENDROID_SERVER_PORT

public static final Config.ConfigProperty SELENDROID_SERVER_PORT

Selendroid Server port to use.
Defaults to the value used by Selendroid (8080)

SELENDROID_DEVICE_SERIAL

public static final Config.ConfigProperty SELENDROID_DEVICE_SERIAL

Device Serial to use.
Default is selected automatically by Selendroid

SELENDROID_SERVER_FORCE_REINSTALL

public static final Config.ConfigProperty SELENDROID_SERVER_FORCE_REINSTALL

Force Reinstall the Selendroid Server and AUT.
Default is set to false

SELENDROID_EMULATOR_START_TIMEOUT

public static final Config.ConfigProperty SELENDROID_EMULATOR_START_TIMEOUT

Timeout that will be used to start Android emulators.
The value for this parameter is used as the value of timeoutEmulatorStart for selendroid.
This configuration affects LOCAL EXECUTION RUNS only i.e., when SELENIUM_RUN_LOCALLY is set to true.
The unit is milliseconds.
Default is set to 300000 milliseconds.

SELENDROID_SERVER_START_TIMEOUT

public static final Config.ConfigProperty SELENDROID_SERVER_START_TIMEOUT

Maximum time in milliseconds to wait for the selendroid-server to come up on the device.
The value for this parameter is used as the value of serverStartTimeout for selendroid.
This configuration affects LOCAL EXECUTION RUNS only i.e., when SELENIUM_RUN_LOCALLY is set to true.
The unit is milliseconds.
Default is set to 20000 milliseconds.

PRINT_DEBUG_INFO

public static final Config.ConfigProperty PRINT_DEBUG_INFO

To print debug info (about Browser/Selenium Version/Client OS) for user.
Default is set to true

Method Detail

values

public static Config.ConfigProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Config.ConfigProperty c : Config.ConfigProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Config.ConfigProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Returns the name of this configuration property

Returns:

The name of this configuration property

getDefaultValue

public String getDefaultValue()

Returns the default value for this configuration property

Returns:

The default String value for this configuration property

find

public static Config.ConfigProperty find(String name)

Find the Enum for the specified property name.

Returns:

The ConfigProperty Enum for the specified name if found or null if not found.

isGlobalScopeOnly

public boolean isGlobalScopeOnly()

Answer if the property is a global only property (i.e only Suite scope param / System / Env Property)

Returns:

true if the property is only supported as a global property.