org.safs.selenium

Class SeleniumJavaHook

java.lang.Object

org.safs.JavaHook

org.safs.selenium.SeleniumJavaHook

All Implemented Interfaces:

HookConfig

public class SeleniumJavaHook
extends JavaHook

This class is our STAF-enabled JavaHook for the "SAFS/Selenium" Engine. This is the class that registers with STAF and responds to the STAF-based SAFS Engine protocol defined at http://sourceforge.net/docman/display_doc.php?docid=17505&group_id=56751

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

As of this writing, this hook uses standard org.safs.LogUtilities. The TestStepProcessor is the "standard" org.safs.TestStepProcessor.

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

• org.safs.selenium.SeleniumGuiUtilities
• org.safs.selenium.STestRecordHelper

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) must minimally provide the following information:

• BROWSER=<Selenium browser id> Ex: BROWSER="*piiexplore" or BROWSER="*pifirefox"

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 #>
• SELENIUMPORT=<selenium server port> Example: SELENIUMPORT=4444 (default)
• DEBUGLOG=<full_path_to>\ASeleniumDebugLog.txt

(PROXY and PORT options previously supported have been deprecated in favor of the GATEWAYHOST and GATEWAYPORT options. However, PROXY and PORT still work.)

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

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

java -Dsafs.config.paths=<paths> org.safs.selenium.SeleniumJavaHook

There is also the ability to launch the engine in a "Process Container" mode by adding a single command-line argument, "SPC" as in:

java -Dsafs.config.paths=<paths> org.safs.selenium.SeleniumJavaHook SPC

JAN 16, 2007 (Carl Nagle) Graceful abort when no config provided.
JAN 16, 2007 (Carl Nagle) Update of use documentation.
AUG 01, 2007 (Carl Nagle) Update documentation and faulty shutdown activities.
FEB 19, 2008 (Carl Nagle) Support alternate Selenium Server ports and Selenium Debug Log.
APR 18, 2008 (Carl Nagle) Primarily updated documentation.
MAY 27, 2008 (Carl Nagle) Documented the "SPC" argument for Selenium Process Container.
MAR 31, 2011 (Lei Wang) Modify to fit Selenium 1.0
AUG 08, 2012 (Lei Wang) Modify method stopJavaHOOK(): release the mutex "SAFS/Hook/TRD"

See Also:

SeleniumGUIUtilities, STestRecordHelper, SPC

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INT_SELENIUMPORT 4444
static java.lang.String	DEFAULT_SELENIUMPORT "4444"
static int	DEFAULT_SELENIUMTIMEOUT 1000*60*5
static boolean	RUNNING_SPC
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"
static java.io.File	temp_user_extensions

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
SeleniumJavaHook() No-arg constructor for SeleniumJavaHook Simply calls the super()
SeleniumJavaHook(java.lang.String process_name) Constructor for SeleniumJavaHook Simply calls super(process_name)
SeleniumJavaHook(java.lang.String process_name, LogUtilities logs) Constructor for SeleniumJavaHook Simply calls super(process_name, logs)
SeleniumJavaHook(java.lang.String process_name, java.lang.String trd_name) Constructor for SeleniumJavaHook Simply calls super(process_name, trd_name)
SeleniumJavaHook(java.lang.String process_name, java.lang.String trd_name, LogUtilities logs) Constructor for SeleniumJavaHook Simply calls super(process_name, trd_name, logs)
SeleniumJavaHook(java.lang.String process_name, java.lang.String trd_name, LogUtilities logs, TestRecordHelper trd_data, DDGUIUtilities gui_utils, ProcessRequest aprocessor) Advanced Constructor for SeleniumJavaHook.

Method Summary

Modifier and Type	Method and Description
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() Use 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.
static void	main(java.lang.String[] args) Launches a default instance of the SAFS/Selenium engine.
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, instantiateHookConfig, 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

temp_user_extensions

public static java.io.File temp_user_extensions

SAFS_SELENIUM_SERVER_BOOTUP_READY

public static java.lang.String SAFS_SELENIUM_SERVER_BOOTUP_READY

DEFAULT_SELENIUMPORT

public static final java.lang.String DEFAULT_SELENIUMPORT

"4444"

See Also:

Constant Field Values

DEFAULT_INT_SELENIUMPORT

public static final int DEFAULT_INT_SELENIUMPORT

4444

See Also:

Constant Field Values

DEFAULT_SELENIUMTIMEOUT

public static final int DEFAULT_SELENIUMTIMEOUT

1000*60*5

See Also:

Constant Field Values

RUNNING_SPC

public static boolean RUNNING_SPC

Constructor Detail

SeleniumJavaHook

public SeleniumJavaHook()

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

SeleniumJavaHook

public SeleniumJavaHook(java.lang.String process_name)

Constructor for SeleniumJavaHook 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".

SeleniumJavaHook

public SeleniumJavaHook(java.lang.String process_name,
                        LogUtilities logs)

Constructor for SeleniumJavaHook 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

SeleniumJavaHook

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

Constructor for SeleniumJavaHook 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

SeleniumJavaHook

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

Constructor for SeleniumJavaHook 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

SeleniumJavaHook

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

Advanced Constructor for SeleniumJavaHook. 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 - -- SeleniumGuiUtilities the hook will use for handling components. The Selenium engine expects an instance of SeleniumGuiUtilities.

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, STestRecordHelper, SeleniumGUIUtilities, 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 SeleniumGuiUtilities 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:

STestRecordHelper, 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.SeleniumGUIUtilities 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 SeleniumGUIUtilities 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.SeleniumGUIUtilities.

See Also:

JavaHook.getGUIUtilities(), JavaHook.getHelper(), getTRDData(), SeleniumGUIUtilities, 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.LogUtilities.

Specified by:

getLogUtilities in class JavaHook

Returns:

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

See Also:

JavaHook.getLogUtilities(), org.safs.LogUtilities

getRequestProcessor

public ProcessRequest getRequestProcessor()

Use this method to retrieve/create the current/default ProcessRequest instance. 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 a new TestStepProcessor. Note that the call to getTRDData() may force the instantiation of the default ATestRecordHelper if one has not already been set. A 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:

JavaHook.getRequestProcessor(), ProcessRequest, STestRecordHelper, getTRDData(), getLogUtilities(), org.safs.LogUtilities, TestStepProcessor

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:

java org.safs.selenium.SeleniumJavaHook