org.safs.ios

Class IDriverCommand

java.lang.Object

org.safs.Processor

org.safs.DriverCommand

org.safs.ios.IDriverCommand

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

public class IDriverCommand
extends DriverCommand

SAFS/IOS supported Driver Commands.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.Hashtable	appids
static java.lang.String	CALLSCRIPT
static java.lang.String	CLOSEAPPLICATION
(package private) java.lang.String	command
(package private) java.lang.String	JSCRIPTS_CUSTOM_SUBDIR
(package private) java.lang.String	JSCRIPTS_DRIVERCOMMANDS_SUBDIR
(package private) java.lang.String	JSCRIPTS_ONGUIEXISTS_SCRIPT
static java.lang.String	LAUNCHAPPLICATION
static java.lang.String	ONGUIEXISTSGOTOBLOCKID
static java.lang.String	ONGUINOTEXISTGOTOBLOCKID

Fields inherited from class org.safs.DriverCommand

iterator, utils

Fields inherited from class org.safs.Processor

breakpointsOn, CASE_INSENSITIVE_FLAG, CASEINSENSITIVE_FLAG, clearProxiesAlways, commandLineBreakpoint, customStr, customText, DEBUG_MESSAGE, debugStr, debugText, DEFAULT_CUSTOM_PROCESSOR_PACKAGE, DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE, DEFAULT_PROCESSOR_PACKAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, failedStr, failedText, FAILURE_DETAIL, GENERIC_MESSAGE, genericStr, genericText, LINE_FAILURE_4, log, myBreakpointsOn, otherStr, otherText, PARAM_SIZE_1, PARAM_SIZE_2, PARAM_SIZE_3, PARAM_SIZE_4, params, PASSED_MESSAGE, passedStr, passedText, PRE_TXT_SUCCESS_4, PRE_TXT_SUCCESS_5, processorConfigSet, processorMap, recordProcessed, RECTYPE_DRIVER_COMMAND, RECTYPE_DRIVER_COMMAND_F, RECTYPE_DRIVER_COMMAND_W, RECTYPE_TEST_STEP, RECTYPE_TEST_STEP_F, RECTYPE_TEST_STEP_W, RFSMCache, RFSMOnly, RFT_FIND_SEARCH_MODE_ALGORITHM, RFT_FIND_SEARCH_MODE_CACHE, SAFS_CLEARPROXIESALWAYS_ITEM, SAFS_COMMANDLINEBREAKPOINT_ITEM, SAFS_COMMANDLINEBREAKPOINT_VARIABLE, SAFS_PARAMS_FILE, SAFS_RESBUN_NAME, SAFS_SECSWAITFORCOMPONENT_ITEM, SAFS_SECSWAITFORCOMPONENT_VARIABLE, SAFS_SECSWAITFORWINDOW_ITEM, SAFS_SECSWAITFORWINDOW_VARIABLE, SAFS_TESTDOMAINS_ITEM, SAFS_TESTDOMAINS_VARIABLE, secsWaitForComponent, secsWaitForWindow, SENT_MSG_3, testDomains, testRecordData, testrecordStackable, TXT_FAILURE_1, TXT_FAILURE_2, TXT_FAILURE_3, TXT_FAILURE_4, TXT_FAILURE_5, TXT_SUCCESS_1, TXT_SUCCESS_2, TXT_SUCCESS_2a, TXT_SUCCESS_3, TXT_SUCCESS_3a, TXT_SUCCESS_4, TXT_SUCCESS_5, unexpectedAlertBehaviour, WARNING_MESSAGE, WARNING_OK_MESSAGE, warningStr, warningText

Constructor Summary

Constructors

Constructor and Description
IDriverCommand()

Method Summary

Modifier and Type	Method and Description
protected void	doCallScript() CallScript implementation.
protected void	doCloseApplication() CloseApplication implementation.
protected void	doGUIBranching(boolean seekexists) Support for OnGuiExistsGotoBlockID and OnGuiNotExistGotoBlockID
protected void	doLaunchApplication() LaunchApplication implementation. ApplicationID: Required.
void	process() The primary method that all subclasses must implement.

Methods inherited from class org.safs.DriverCommand

checkGUIExistence, commandProcess, getStandardFailureDetail, getStandardWarningDetail, init, interpretFields, issueActionUsingNegativeMessage, issueActionWarning, issueExecutionNegativeMessage, issueFileErrorFailure, issueGenericSuccess, issueGenericSuccess, issueGenericSuccessUsing, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issueUnknownErrorFailure, isSupportedRecordType, localProcess

Methods inherited from class org.safs.Processor

activateBreakpoint, checkBreakpoints, checkMyBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAlternateParams, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcClassNames, getCustomProcInstancePath, getLogUtilities, getParams, getProcClassNames, getProcInstance, getProcInstancePath, getRequiredField, getSecsWaitForComponent, getSecsWaitForWindow, getStandardErrorMessage, getTestRecordData, getUnexpectedAlertBehaviour, getVariable, hasChainedProcessor, initProcessorAndProcess, instanceProcessorAndProcess, isBreakpointsOn, isComponentFunctionRecord, isDriverCommandRecord, isEngineCommandRecord, isMyBreakpointsOn, isRecordProcessed, isRFSMCache, isRFSMOnly, issueActionFailure, issueActionOnXFailure, issueErrorPerformingAction, issueErrorPerformingActionOnX, issueErrorPerformingActionUsing, issueInputRecordFailure, issueInputRecordFailure, issuePassedSuccess, logFailureMessage, normalizeTestFileName, paramsFailedMsg, paramsFailedMsg, popTestRecord, processCustomProcessor, processSubclassProcessor, pushTestRecord, setAtEndOfProcess, setBreakpointsOn, setChainedProcessor, setClearProxiesAlways, setCommandLineBreakpoint, setCustomProcInstancePath, setLogUtilities, setMyBreakpointsOn, setParams, setProcInstance, setProcInstancePath, setRecordProcessed, setRFSMCache, setRFSMOnly, setSecsWaitForComponent, setSecsWaitForWindow, setTestDomains, setTestRecordData, setUnexpectedAlertBehaviour, setVariable, standardFailureMessage, substituteVariable, validateParamSize, validProcessorClassName

Methods inherited from class java.lang.Object

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

Field Detail

CALLSCRIPT

public static final java.lang.String CALLSCRIPT

See Also:

Constant Field Values

CLOSEAPPLICATION

public static final java.lang.String CLOSEAPPLICATION

See Also:

Constant Field Values

LAUNCHAPPLICATION

public static final java.lang.String LAUNCHAPPLICATION

See Also:

Constant Field Values

ONGUIEXISTSGOTOBLOCKID

public static final java.lang.String ONGUIEXISTSGOTOBLOCKID

See Also:

Constant Field Values

ONGUINOTEXISTGOTOBLOCKID

public static final java.lang.String ONGUINOTEXISTGOTOBLOCKID

See Also:

Constant Field Values

command

java.lang.String command

appids

java.util.Hashtable appids

JSCRIPTS_CUSTOM_SUBDIR

java.lang.String JSCRIPTS_CUSTOM_SUBDIR

JSCRIPTS_DRIVERCOMMANDS_SUBDIR

java.lang.String JSCRIPTS_DRIVERCOMMANDS_SUBDIR

JSCRIPTS_ONGUIEXISTS_SCRIPT

java.lang.String JSCRIPTS_ONGUIEXISTS_SCRIPT

Constructor Detail

IDriverCommand

public IDriverCommand()

Method Detail

process

public void process()

Description copied from class: Processor

The primary method that all subclasses must implement. The implementation here simply checks for any chainedProcessor,
invokes chainedProcessor.setParams(this.getParams()),
invokes chainedProcessor.process(),
invokes setRecordProcessed(chainedProcessor.isRecordProcessed()).

Thus, any subclassing Processor should attempt to process it's own commands and then invoke super.process() to try any chained Processor(s).

Otherwise, by default executes setRecordProcessed(false) if no chainedProcessor is present.

Overrides:

process in class DriverCommand

doGUIBranching

protected void doGUIBranching(boolean seekexists)
                       throws SAFSObjectRecognitionException,
                              InstrumentsScriptExecutionException

Support for OnGuiExistsGotoBlockID and OnGuiNotExistGotoBlockID

Appends an variables into trd.js with:

 var timeout=seconds;
 var blockId=blockname;
 

Parameters:

seekexists - true for OnGuiExists, false for OnGuiNotExist.

Throws:

SAFSObjectRecognitionException - if window or component not in app map.

InstrumentsScriptExecutionException - if any error occurs in Instruments.

doLaunchApplication

protected void doLaunchApplication()

LaunchApplication implementation.
ApplicationID: Required. Stored for shutdown with CloseApplication. Can be ApplicationConstant.
ExecutablePath: Required. Path to *?.tracetemplate needed by Instruments. Can be relative to WorkDir, if provided. Can be ApplicationConstant.
WorkDir: Optional. Path to root Instruments Project directory. Can be ApplicationConstant.

doCloseApplication

protected void doCloseApplication()

CloseApplication implementation. Currently does not use the ApplicationID. It simply stops Instruments and any IOS Simulator since these can only test one application at a time.

doCallScript

protected void doCallScript()

CallScript implementation. The scriptname will be sought as an ApplicationConstant in the current app map. If not there, we will use the scriptname "as-is". The final name/path of the script can be relative, or absolute. If a relative path, we will first look relative to the Project jscript subdirectory. If still not found we will look relative to the jscript/custom subdirectory. The final scriptname can be with or without the ".js" extension. We will append it if missing.

The routine also will accept and parse parameters that will be appended to the trd.js as available vars. The routine will accept these in two formats:

1. varname=varvalue
2. varvalue

The 1st format will create a var entries in the JavaScript like:

var varname="varvalue"
var othername="othervalue"

The 2nd format will create a var VARn entries in the JavaScript like:

var VAR1="varvalue"
var VAR2="othervalue"
etc...