org.safs.selenium.webdriver

Class EmbeddedSeleniumHookDriver

java.lang.Object

org.safs.JavaHook

org.safs.tools.drivers.EmbeddedHookDriver

org.safs.selenium.webdriver.EmbeddedSeleniumHookDriver

All Implemented Interfaces:

HookConfig

public class EmbeddedSeleniumHookDriver
extends EmbeddedHookDriver

Default EmbeddedHookDriver subclass for the SAFS Selenium WebDriver Engine.

This is primarily a proof-of-concept at this time. Users would use a subclass of this class for runtime execution inside the Selenium engine.

The class has the same config requirements as JSAFSDriver. However, the new implementations of the EmbeddedHookDriver will attempt to use default values (test.ini) if

Author:

Carl Nagle

See Also:

EmbeddedHookDriver, JSAFSDriver

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static boolean	enableLogs
static java.lang.String	HOOK_DRIVER_NAME

Fields inherited from class org.safs.tools.drivers.EmbeddedHookDriver

SAFS_PROJECT_CONFIG, TEST_INI_DEFAULT, TESTDESIGNER_PROJECT_CONFIG

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
EmbeddedSeleniumHookDriver() Default Constructor

Method Summary

Modifier and Type	Method and Description
Processor	getEngineDriverCommandProcessor() Subclasses should instantiate an engine-specific DriverCommands Processor here.
Processor	getEngineTestStepProcessor() Subclasses should instantiate an engine-specific TestStepProcessor Processor here, if any.
DDGUIUtilities	getGUIUtilities() Subclasses should override this method to retrieve/create the DDGUIUtilities instance needed by the specific engine subclass.
LogUtilities	getLogUtilities() Use this method to retrieve/create the current/default LogUtilities instance.
TestRecordHelper	getTRDData() Instantiates a default DCTestRecordHelper for this engine.
protected void	instantiateHookConfig() Instantiate the HookConfig, used to get settings from ConfigureInterface.
boolean	shutdown() Perform final engine hook shutdown activities AND shutdown the internal JSAFSDriver.

Methods inherited from class org.safs.tools.drivers.EmbeddedHookDriver

allowSystemExit, config, evaluateRuntimeException, getEngineEngineCommandProcessor, getRequestProcessor, initConfigPaths, initialize, jsafs, run, setHelper, setProcessName, start

Methods inherited from class org.safs.JavaHook

checkConfiguration, driverShutdownRequest, getHelper, getProcessName, getSemaphoreName, getTRDName, hook_shutdown, setGUIUtilities, setLogUtilities, setRequestProcessor, setSemaphoreName, setTRDData, setTRDName

Methods inherited from class java.lang.Object

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

Field Detail

enableLogs

static boolean enableLogs

HOOK_DRIVER_NAME

public static final java.lang.String HOOK_DRIVER_NAME

See Also:

Constant Field Values

Constructor Detail

EmbeddedSeleniumHookDriver

public EmbeddedSeleniumHookDriver()

Default Constructor

Method Detail

getTRDData

public TestRecordHelper getTRDData()

Instantiates a default DCTestRecordHelper for this engine.

Overrides:

getTRDData in class EmbeddedHookDriver

See Also:

JavaHook.getTRDData(), DCTestRecordHelper

getLogUtilities

public LogUtilities getLogUtilities()

Description copied from class: EmbeddedHookDriver

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.

Overrides:

getLogUtilities in class EmbeddedHookDriver

Returns:

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

See Also:

JavaHook.getLogUtilities(), org.safs.LogUtilities

getEngineDriverCommandProcessor

public Processor getEngineDriverCommandProcessor()

Description copied from class: EmbeddedHookDriver

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

Overrides:

getEngineDriverCommandProcessor in class EmbeddedHookDriver

Returns:

Engine-specific DriverCommands Processor instance, or null.

getEngineTestStepProcessor

public Processor getEngineTestStepProcessor()

Description copied from class: EmbeddedHookDriver

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

Overrides:

getEngineTestStepProcessor in class EmbeddedHookDriver

Returns:

Engine-specific TestStepProcessor Processor instance, or null.

getGUIUtilities

public DDGUIUtilities getGUIUtilities()

Description copied from class: EmbeddedHookDriver

Subclasses should override this method to retrieve/create the DDGUIUtilities instance needed by the specific engine subclass.

A newly instantiated DDGUIUtilities should have critical helpers set:

• utils.setSTAFHelper(getHelper());
• utils.setTestRecordData(getTRDData());

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

Overrides:

getGUIUtilities in class EmbeddedHookDriver

Returns:

DDGUIUtilities which should be an instanceof org.safs.DDGUIUtilities subclass. This default superclass implementation instantiates a DCGUIUtilities object that cannot act on GUI components.

See Also:

JavaHook.getHelper(), EmbeddedHookDriver.getTRDData(), DCGUIUtilities

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()

shutdown

public boolean shutdown()

Description copied from class: EmbeddedHookDriver

Perform final engine hook shutdown activities AND shutdown the internal JSAFSDriver. This should shutdown all SAFS logs and services started by this process.

This default implementation unregisters our STAFProcessHelper if it is not null. Subclasses may wish to provide additional functionality before calling super.shutdown().

Overrides:

shutdown in class EmbeddedHookDriver

Returns:

The default implementation will return true if no errors or exceptions are uncaught.