org.safs.ios

Class IJavaHook

java.lang.Object

org.safs.JavaHook

org.safs.ios.IJavaHook

All Implemented Interfaces:

HookConfig

public class IJavaHook
extends JavaHook

This class is our STAF-enabled JavaHook for the SAFS "IOS" 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 IOS Engine is "SAFS/IOS".

As of this writing, this hook uses standard org.safs.LogUtilities.

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

• org.safs.ios.ITestRecordHelper
• org.safs.ios.IGUIUtilities

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:

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.

 -Dsafs.config.paths=<testpath>:<projectpath>:<driverpath>
 
 Example: 
 -Dsafs.config.paths=/Library/safs/Project/iostest.ini:/Library/safs/Project/safstid.ini:/Library/safs/safstid.ini
 

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:

• PROJECT=<path to SAFS IOS Instruments project space>

The configuration file(s) can also provide the following:

• TEMPLATE=path to IOS Instruments tracetemplate (not used)

• ASCRIPTS=root dir for SAFS AppleScript (Ex: /Libary/SAFS/IOS/ascript/)
• ASINSTRUMENTS_LAUNCH=relative path to Instruments launch script (Ex: Instruments/launchInstrumentsTemplate.scpt)
• ASINSTRUMENTS_START=relative path to Instruments Record Trace (Ex: Instruments/startInstrumentsTrace.scpt)
• ASINSTRUMENTS_RESTART=relative path to Instruments StartScript (Ex: Instruments/restartInstrumentsScript.scpt)
• ASINSTRUMENTS_STOP=relative path to Instruments shutdown script (Ex: Instruments/stopInstrumentsTrace.scpt)

• INSTRUMENTS_APPSUPPORT=root dir for Instruments app data
  (Ex:/Users/[username]/Library/Application Support/Instruments/)
• INSTRUMENTS_PREFS=root dir for SAFS Instruments Assets (Ex: /Library/SAFS/IOS/instruments/)
• INSTRUMENTS_RUNTIME_PREFS=relative path to Instruments SAFSRuntime Prefs (Ex: recent/SAFSRuntime)
• INSTRUMENTS_PROCESSCONTAINER_PREFS=relative path to Instruments ProcessContainer Prefs (Ex: recent/ProcessContainer)

• INSTRUMENTS_PREVIOUSSCRIPT_FILE=name of active Instruments Prefs file (Ex: PreviousScripts)
• INSTRUMENTS_SAFSBACKUP_FILE=name of SAFS Prefs backup file (Ex: SAFSBackupScripts)

• JSCRIPTS=root dir for IOS UIAutomation JavaScript (Ex: /Library/SAFS/IOS/jscript/)
• JSRUNTIME=relative path to main SAFS JavaScript Wrapper/Hook (Ex: SAFSRuntime.js)
• JSPROCESSCONTAINER=relative path to SAFS ProcessContainer JS (Ex: ProcessContainer.js)
• JSTARTUP=relative path to SAFS JS startup import (Ex: Utilities/startup.js)

• IBTIMAGES=root dir for SAFS internal IBT images (Ex: /Libary/SAFS/IOS/ibt/images/)
• IBTSTARTSCRIPT=relative path to StartScript image(s) (Ex: startscript/StartScript.bmp)

The configuration file(s) can optionally also contain other relevant information as described in the SAFSIOS Java Engine. Also see SAFSTID Config Files for more information.

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.ios.IJavaHook

JUN 30, 2011 (Carl Nagle) Original Release.

See Also:

SeleniumGUIUtilities, STestRecordHelper, JVMAgentTestStepProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IOS_COMMANDS Our predefined STAF process name: "SAFS/IOS"

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

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/IOS 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

IOS_COMMANDS

public static final java.lang.String IOS_COMMANDS

Our predefined STAF process name: "SAFS/IOS"

See Also:

Constant Field Values

Constructor Detail

IJavaHook

public IJavaHook()

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

IJavaHook

public IJavaHook(java.lang.String process_name)

Constructor for IJavaHook Simply calls super(process_name)

Parameters:

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

IJavaHook

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

Constructor for IJavaHook 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/IOS".

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

See Also:

org.safs.LogUtilites

IJavaHook

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

Constructor for IJavaHook 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/IOS".

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

IJavaHook

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

Constructor for IavaHook 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/IOS".

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

IJavaHook

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

Advanced Constructor for IJavaHook. 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/IOS".

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.

trd_data - -- ITestRecordHelper to hold TestRecordData. The IOS engine expects an instance of ITestRecordHelper.

gui_utils - -- IGuiUtilities the hook will use for handling components. The IOS engine expects an instance of IGUIUtilities.

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

See Also:

STAFHelper.SAFS_HOOK_TRD, org.safs.LogUtilites, ITestRecordHelper, IGUIUtilities, 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.ios.ITestRecordHelper 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 IGUIUtilities 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.ios.ITestRecordHelper

See Also:

ITestRecordHelper, 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.ios.IGUIUtilities 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 ITestRecordHelper 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:

getGUIUtilities in class JavaHook

Returns:

DDGUIUtilities which should be an instanceof org.safs.ios.IGUIUtilities.

See Also:

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

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 new IDriverCommand and ITestStepProcessor processors.

Note that the call to getTRDData() may force the instantiation of the default ITestRecordHelper 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, IDriverCommand, ITestStepProcessor

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

start

public void start()

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

main

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

Launches a default instance of the SAFS/IOS 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