org.safs.selenium.webdriver

Class SeleniumHook

java.lang.Object

org.safs.JavaHook

org.safs.selenium.webdriver.SeleniumHook

All Implemented Interfaces:

HookConfig

public class SeleniumHook
extends JavaHook

This class is our STAF-enabled JavaHook (Selenium WebDriver) for the "SAFS/Selenium" Engine. This is the class that registers with STAF and responds to the STAF-based SAFS Engine protocol.

The STAF name predefined for this Selenium Engine is "SAFS/Selenium".

As of this writing, this hook uses the ApacheLogUtilities subclass of LogUtilities. This allows us to use additional WebDriver and Selenium Builder/Interpreter features that require an apache.commons.logging.Log Interface.

The TestStepProcessor is the standard org.safs.TestStepProcessor.

The SAFS/Selenium engine does require Selenium-specific implementations of

• org.safs.selenium.webdriver.WebDriverGUIUtilities
• org.safs.selenium.webdriver.WDTestRecordHelper

If the engine is being launched manually or via a batch file or script then the following Java System property must be set on the Java command line:

-Dsafs.config.paths=<testpath>;<projectpath>;<driverpath>

testpath is the file path to the test configuration INI file,
projectpath is the file path to the project configuration INI file,
driverpath is the file path to the SAFS driver configuration INI file.

At least one INI file path must be specified or the engine will abort due to insufficient configuration information being provided.

The configuration file(s) can provide default target browser information:

• BROWSER=<Selenium browser id> Ex: BROWSER="explorer" or BROWSER="chrome" or BROWSER="firefox"

The configuration file(s) can optionally also contain:

• GATEWAYHOST=<web proxy domain> Ex: GATEWAYHOST=your.normal.gateway.com
• GATEWAYPORT=<web proxy port> Example: GATEWAYPORT=80 <your normal gatewory port #>
• PROXY_BYPASS_ADDRESS=<proxy bypass address> Example: PROXY_BYPASS_ADDRESS=localhost,127.0.0.1,mymachine.name
• BROWSER_REMOTE=false|true

You can refer to the [SAFS_SELENIUM] setion in SAFSDRIVER Configuration. (See Settings for Selnium2.0 WebDriver)

Assuming everything is properly CLASSPATHed and the config file(s) have proper settings then the Engine can then be launched with:

%SAFSDIR%/jre/bin/java -Dsafs.config.paths=<paths> org.safs.selenium.webdriver.SeleniumHook

JAN 16, 2007 (Carl Nagle) Initial Release.

See Also:

WebDriverGUIUtilities, WDTestRecordHelper, SPC

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SAFS_SELENIUM_SERVER_BOOTUP_READY
static java.lang.String	SAFS_USER_EXTENSIONS
static java.lang.String	SELENIUM_COMMANDS Our predefined STAF process name: "SAFS/Selenium"

Fields inherited from class org.safs.JavaHook

data, DEBUG_MESSAGE, errorText, FAILED_MESSAGE, FAILED_OK_MESSAGE, GENERIC_ERROR, GENERIC_MESSAGE, helper, hookconfig, log, PASSED_MESSAGE, PAUSE_EXECUTION, PAUSE_SWITCH_OFF, PAUSE_SWITCH_ON, process_name, processor, REQUEST_PROCEED_TESTING, REQUEST_USER_STOPPED_SCRIPT_REQUEST, RUNNING_EXECUTION, semaphore_name, SHUTDOWN_RECORD, STAF_ERROR, STEP_EXECUTION, STEP_RETRY_EXECUTION, STEPPING_EXECUTION, STEPPING_RETRY_EXECUTION, trd_name, utils, WARNING_MESSAGE, WARNING_OK_MESSAGE

Constructor Summary

Constructors

Constructor and Description
SeleniumHook() No-arg constructor for SeleniumHook Simply calls the super()
SeleniumHook(java.lang.String process_name) Constructor for SeleniumHook Simply calls super(process_name)
SeleniumHook(java.lang.String process_name, ApacheLogUtilities logs) Constructor for SeleniumHook Simply calls super(process_name, logs)
SeleniumHook(java.lang.String process_name, java.lang.String trd_name) Constructor for SeleniumHook Simply calls super(process_name, trd_name)
SeleniumHook(java.lang.String process_name, java.lang.String trd_name, LogUtilities logs) Constructor for SeleniumHook Simply calls super(process_name, trd_name, logs)
SeleniumHook(java.lang.String process_name, java.lang.String trd_name, LogUtilities logs, TestRecordHelper trd_data, DDGUIUtilities gui_utils, ProcessRequest aprocessor) Advanced Constructor for SeleniumHook.

Method Summary

Modifier and Type	Method and Description
Processor	getEngineDriverCommandProcessor() Subclasses should instantiate an engine-specific DriverCommands Processor here.
protected Processor	getEngineEngineCommandProcessor() Subclasses should instantiate an engine-specific EngineCommandProcessor Processor here, if any.
protected Processor	getEngineTestStepProcessor() Subclasses should instantiate an engine-specific TestStepProcessor Processor here, if any.
DDGUIUtilities	getGUIUtilities() Use this method to retrieve/create the current/default DDGUIUtilities instance.
LogUtilities	getLogUtilities() Use this method to retrieve/create the current/default LogUtilities instance.
ProcessRequest	getRequestProcessor() This method to retrieve/create the current/default ProcessRequest instance.
TestRecordHelper	getTRDData() Use this method to retrieve/create the current/default TestRecordHelper instance.
protected boolean	hook_shutdown() Perform final hook shutdown activities.
protected void	instantiateHookConfig() Instantiate the HookConfig, used to get settings from ConfigureInterface.
static void	main(java.lang.String[] args) Launches a default instance of the SAFS/Selenium engine.
static void	setSystemProperties(ConfigureInterface config) Deprecated. Call SeleniumHookConfig.setSystemProperties(ConfigureInterface) instead.
void	start() Insert this SAFS Engine hook into the STAF system.
void	stopJavaHOOK() Used by SPC to imitate sending a SHUTDOWN_RECORD to JavaHook who is waiting in getNextHookTestEvent() for a record-dispatched event.

Methods inherited from class org.safs.JavaHook

allowSystemExit, checkConfiguration, driverShutdownRequest, evaluateRuntimeException, getHelper, getProcessName, getSemaphoreName, getTRDName, initConfigPaths, setGUIUtilities, setHelper, setLogUtilities, setProcessName, setRequestProcessor, setSemaphoreName, setTRDData, setTRDName

Methods inherited from class java.lang.Object

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

Field Detail

SELENIUM_COMMANDS

public static final java.lang.String SELENIUM_COMMANDS

Our predefined STAF process name: "SAFS/Selenium"

See Also:

Constant Field Values

SAFS_USER_EXTENSIONS

public static final java.lang.String SAFS_USER_EXTENSIONS

See Also:

Constant Field Values

SAFS_SELENIUM_SERVER_BOOTUP_READY

public static java.lang.String SAFS_SELENIUM_SERVER_BOOTUP_READY

Constructor Detail

SeleniumHook

public SeleniumHook()

No-arg constructor for SeleniumHook Simply calls the super()

SeleniumHook

public SeleniumHook(java.lang.String process_name)

Constructor for SeleniumHook Simply calls super(process_name)

Parameters:

process_name - the ID to use when registering with STAF. Normally this would be our predefined name "SAFS/Selenium".

SeleniumHook

public SeleniumHook(java.lang.String process_name,
                    ApacheLogUtilities logs)

Constructor for SeleniumHook Simply calls super(process_name, logs)

Parameters:

process_name - the ID to use when registering with STAF. Normally this would be our predefined name "SAFS/Selenium".

logs - the LogUtilities to be used by the Engine. Currently we can use the default org.safs.LogUtilities

See Also:

org.safs.LogUtilites

SeleniumHook

public SeleniumHook(java.lang.String process_name,
                    java.lang.String trd_name)

Constructor for SeleniumHook Simply calls super(process_name, trd_name)

Parameters:

process_name - the ID to use when registering with STAF. Normally this would be our predefined name "SAFS/Selenium".

trd_name - -- The root name for specific TestRecordData to reference in STAF. This should typically be STAFHelper.SAFS_HOOK_TRD which is used by default.

See Also:

STAFHelper.SAFS_HOOK_TRD

SeleniumHook

public SeleniumHook(java.lang.String process_name,
                    java.lang.String trd_name,
                    LogUtilities logs)

Constructor for SeleniumHook Simply calls super(process_name, trd_name, logs)

Parameters:

process_name - the ID to use when registering with STAF. Normally this would be our predefined name "SAFS/Selenium".

trd_name - -- The root name for specific TestRecordData to reference in STAF. This should typically be STAFHelper.SAFS_HOOK_TRD which is used by default.

logs - the LogUtilities to be used by the Engine. Currently we can use the default org.safs.LogUtilities

See Also:

STAFHelper.SAFS_HOOK_TRD, org.safs.LogUtilites

SeleniumHook

public SeleniumHook(java.lang.String process_name,
                    java.lang.String trd_name,
                    LogUtilities logs,
                    TestRecordHelper trd_data,
                    DDGUIUtilities gui_utils,
                    ProcessRequest aprocessor)

Advanced Constructor for SeleniumHook. Simply calls super(process_name, trd_name, logs, trd_data, gui_utils, aprocessor)

Parameters:

process_name - the ID to use when registering with STAF. Normally this would be our predefined name "SAFS/Selenium".

trd_name - -- The root name for specific TestRecordData to reference in STAF. This should typically be STAFHelper.SAFS_HOOK_TRD which is used by default.

logs - the LogUtilities to be used by the Engine. Currently we can use the default org.safs.LogUtilities

trd_data - -- ATestRecordHelper to hold TestRecordData. The Selenium engine expects an instance of ATestRecordHelper.

gui_utils - -- WebDriverGUIUtilities the hook will use for handling components. The Selenium engine expects an instance of WebDriverGUIUtilities.

aprocessor - -- ProcessRequest object the hook will use for routing records. The Selenium engine uses the standard ProcessRequest class and a standard TestStepProcessor.

See Also:

STAFHelper.SAFS_HOOK_TRD, org.safs.LogUtilites, WDTestRecordHelper, WebDriverGUIUtilities, ProcessRequest, TestStepProcessor

Method Detail

getTRDData

public TestRecordHelper getTRDData()

Use this method to retrieve/create the current/default TestRecordHelper instance. If the TestRecordHelper has not been set this routine will instance a new org.safs.selenium.ATestRecordHelper and populate it with a STAFHelper via getHelper() and a DDGUIUtilities via getGUIUtilities. Note that the call to getGUIUtilities may force the instantiation of the default WebDriverGUIUtilities if one has not already been set.

Note that there is a known circular execution between getTRDData and getGUIUtilities if neither was previously set. Each routine calls the other which may result in a second call to the other. This has not been a problem.

Specified by:

getTRDData in class JavaHook

Returns:

TestRecordHelper which should be an instanceof org.safs.selenium.ATestRecordHelper

See Also:

WDTestRecordHelper, JavaHook.getHelper(), getGUIUtilities(), JavaHook.getTRDData()

getGUIUtilities

public DDGUIUtilities getGUIUtilities()

Use this method to retrieve/create the current/default DDGUIUtilities instance. If the DDGUIUtilities has not been set this routine will instance a new org.safs.selenium.webdriver.WebDriverGUIUtilities and populate it with a STAFHelper via getHelper() and a TestRecordHelper via getTRDData(). Note that the call to getTRDData() may force the instantiation of the default ATestRecordHelper if one has not already been set.

The WebDriverGUIUtilities talk with our embedded proxies over a SAFS RMI bridge. The local RMI server (AServerImpl) is instanced if not already set.

Note that there is a known circular execution between getTRDData and getGUIUtilities if neither was previously set. Each routine calls the other which may result in a second call to the other. This has not been a problem.

Specified by:

getGUIUtilities in class JavaHook

Returns:

DDGUIUtilities which should be an instanceof org.safs.selenium.webdriver.WebDriverGUIUtilities.

See Also:

JavaHook.getGUIUtilities(), JavaHook.getHelper(), getTRDData(), WebDriverGUIUtilities, SServerImpl

getLogUtilities

public LogUtilities getLogUtilities()

Use this method to retrieve/create the current/default LogUtilities instance. If the LogUtilities has not been set this routine will instance a new org.safs.logging.ApacheLogUtilities.

Specified by:

getLogUtilities in class JavaHook

Returns:

LogUtilities which should be an instanceof org.safs.logging.ApacheLogUtilities.

See Also:

JavaHook.getLogUtilities(), LogUtilities

getEngineDriverCommandProcessor

public Processor getEngineDriverCommandProcessor()

Subclasses should instantiate an engine-specific DriverCommands Processor here. Other generic SAFS DriverCommand Processors will get chained to this primary Processor.

Returns:

Engine-specific DriverCommands Processor instance, or null.

getEngineTestStepProcessor

protected Processor getEngineTestStepProcessor()

Subclasses should instantiate an engine-specific TestStepProcessor Processor here, if any. Other generic SAFS Processors, if any, will get chained to this primary Processor.

Returns:

Engine-specific TestStepProcessor Processor instance, or null.

getEngineEngineCommandProcessor

protected Processor getEngineEngineCommandProcessor()

Subclasses should instantiate an engine-specific EngineCommandProcessor Processor here, if any. Other generic SAFS Processors, if any, will get chained to this primary Processor.

Returns:

Engine-specific EngineCommandProcessor Processor instance, or null.

getRequestProcessor

public ProcessRequest getRequestProcessor()

This method to retrieve/create the current/default ProcessRequest instance. The user would not normally call or override this routine as it will be called internally.

If the ProcessRequest has not been set this routine will instance a new org.safs.ProcessRequest and populate it with the LogUtilities via getLogUtilities(), a TestRecordHelper via getTRDData(), and all Processors.

Any newly created ProcessRequest instance will invoke:

getEngineDriverCommandProcessor()
getEngineTestStepProcessor()
getEngineEngineCommandProcessor()

and attempt to initialize all Processors with the getLogUtilities() and getTRDData() calls and then chain all Processors appropriately.

Note that the first call to getTRDData() may force the instantiation of the default TestRecordHelper for the subclass, if one has not already been set.

The first call to getLogUtilities() may also force the instantiation of the default LogUtilities, if one has not already been set.

Specified by:

getRequestProcessor in class JavaHook

Returns:

ProcessRequest which should be an instanceof org.safs.ProcessRequest

See Also:

TestRecordHelper, getTRDData(), getLogUtilities(), org.safs.LogUtilities, getEngineDriverCommandProcessor(), getEngineTestStepProcessor(), getEngineEngineCommandProcessor()

setSystemProperties

@Deprecated
public static void setSystemProperties(ConfigureInterface config)

Deprecated. Call SeleniumHookConfig.setSystemProperties(ConfigureInterface) instead.

Set the configurations to System-Properties.
If the System-Properties does NOT contain the 'property', then get the value from the ConfigureInterface and set to System-Properties;
Otherwise, keep the value in the System-Properties (don't override by the value from ConfigureInterface).
The checked properties are listed as following:

• SelectBrowser.SYSTEM_PROPERTY_BROWSER_NAME
• SelectBrowser.SYSTEM_PROPERTY_BROWSER_REMOTE
• SelectBrowser.SYSTEM_PROPERTY_SELENIUM_HOST
• SelectBrowser.SYSTEM_PROPERTY_SELENIUM_PORT
• SelectBrowser.SYSTEM_PROPERTY_PROXY_HOST
• SelectBrowser.SYSTEM_PROPERTY_PROXY_PORT
• SelectBrowser.SYSTEM_PROPERTY_PROXY_BYPASS
• DriverConstant.SeleniumConfigConstant.SELENIUMSERVER_JVM_Xmx
• DriverConstant.SeleniumConfigConstant.SELENIUMSERVER_JVM_Xms
• DriverConstant.SeleniumConfigConstant.SELENIUMSERVER_JVM_OPTIONS
• DriverConstant.SeleniumConfigConstant.SELENIUMSERVER_JVM

Parameters:

config - ConfigureInterface, containing the configuration initial parameters

instantiateHookConfig

protected void instantiateHookConfig()

Description copied from class: JavaHook

Instantiate the HookConfig, used to get settings from ConfigureInterface.
Custom Hooks may override this method to provide their own HookConfig.
Note: This should be called after JavaHook.initConfigPaths().

Overrides:

instantiateHookConfig in class JavaHook

See Also:

JavaHook.initConfigPaths()

start

public void start()

Description copied from class: JavaHook

Insert this SAFS Engine hook into the STAF system. The hook will then be enabled and ready for test events from any STAF client using the correct Event protocols.

Overrides:

start in class JavaHook

stopJavaHOOK

public void stopJavaHOOK()

Used by SPC to imitate sending a SHUTDOWN_RECORD to JavaHook
who is waiting in getNextHookTestEvent() for a record-dispatched event.

hook_shutdown

protected boolean hook_shutdown()

Perform final hook shutdown activities. This is called before allowSystemExit.

Overrides:

hook_shutdown in class JavaHook

Returns:

the value returned from super.hook_shutdown()

See Also:

JavaHook.hook_shutdown(), JavaHook.allowSystemExit()

main

public static void main(java.lang.String[] args)

Launches a default instance of the SAFS/Selenium engine. The "hook" is instanced and registered with STAF--which must already be running. The hook is started and will show up as "Ready" to SAFS Drivers once initialization is complete.

Assuming everything is properly CLASSPATHed, the default SAFS/Selenium Engine can be launched simply with:

%SAFSDEV%/jre/bin/java org.safs.selenium.SeleniumHook

However, more than likely additional command-line parameters and INI config file settings would be used.

Parameters:

args - --Typically, there are no Class-specific command-line args.

These are different than the JVM Arguments passed to the JVM invocation preceding the classname on the command-line.