org.safs.android

Class DDriverCommand

java.lang.Object

org.safs.Processor

org.safs.DriverCommand

org.safs.android.DDriverCommand

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

public class DDriverCommand
extends DriverCommand

SAFS/DROID supported Driver Commands.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable	appids
static java.lang.String	CALLSCRIPT
static java.lang.String	CLOSEAPPLICATION
protected java.lang.String	command
protected SAFSRemoteControl	control
protected DTestRecordHelper	droiddata
static java.lang.String	LAUNCHAPPLICATION
protected java.util.Properties	props
protected STAFHelper	staf
protected static java.lang.String	TEMP_PROP_APP_ROTATABLE
protected static java.lang.String	TEMP_PROP_BLOCKID
protected static java.lang.String	TEMP_PROP_COMPNAME
protected static java.lang.String	TEMP_PROP_ENCODING
protected static java.lang.String	TEMP_PROP_FILENAME
protected static java.lang.String	TEMP_PROP_SUBAREA
protected static java.lang.String	TEMP_PROP_TIMEOUT
protected static java.lang.String	TEMP_PROP_VARIABLENAME
protected static java.lang.String	TEMP_PROP_WINDOWNAME
protected java.util.Properties	temp_props used to pass values locally between process methods, and processResults

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

Method Summary

Modifier and Type	Method and Description
protected void	doClipboardCommand() Process clipboard related keywords: AssignClipboardVariable ClearClipboard SaveClipboardToFile SetClipboard VerifyClipboardToFile
protected void	doClipboardResults(RemoteResults results) Process result of clipboard related keywords: AssignClipboardVariable ClearClipboard SaveClipboardToFile SetClipboard VerifyClipboardToFile
protected void	doCommandWithoutPrameter(int timeout) This method is used to execute a keyword without parameter: HideSoftKeyboard ShowSoftKeyboard
protected void	doCommandWithoutPrameterResults(RemoteResults results) This method is used to handle result of a keyword without parameter: HideSoftKeyboard ShowSoftKeyboard
protected void	doGUIBranching() OnGuiExistsGotoBlockID and OnGuiNotExistGotoBlockID commands setup.
protected void	doGuiBranchingResults(RemoteResults results) OnGuiExistsGotoBlockID and OnGuiNotExistGotoBlockID commands remote results.
protected void	doTakeScreenShotCommand() This method is used to check the parameter of keyword TakeScreenShot. Filename is the required parameter. Rotatable is the optional parameter.
protected void	doTakeScreenShotResults(RemoteResults results) Process result of keyword TakeScreenShot. The remote device side will return the rotate degree of the device. The ScreenShot will be got through API of the AndroidDebugBridger at computer side. The returned image is always that you put your device at the default direction. We should rotate that returned image back if the tested android application is rotatable.
protected void	doWaitForGui() WaitForGui and WaitForGuiGone commands setup.
protected void	doWaitForGuiResults(RemoteResults results) WaitForGui and WaitForGuiGone commands remote results.
protected java.util.Collection	interpretFields() Calls the default processing of interpretFields and then prepares the droiddata (testRecordData) with the initial KeywordProperties of:
protected void	logResourceMessageFailure() Log a FAILED_MESSAGE using whatever ResourceMessageInfo data is returned in droiddata.
void	process() The primary method that all subclasses must implement.
protected void	processProperties(int param_timeout) Sets Property PARAM_TIMEOUT and then processes the completed remote control action properties.
protected boolean	processResourceMessageInfoResults(int msgType) Logs any message or message with detail that might be captured in the current droiddata.
protected void	processResults(RemoteResults results) called internally by processProperties(int) AFTER the remote execution has completed.
void	setTestRecordData(TestRecordHelper data)

Methods inherited from class org.safs.DriverCommand

checkGUIExistence, commandProcess, getStandardFailureDetail, getStandardWarningDetail, init, 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, 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

TEMP_PROP_BLOCKID

protected static final java.lang.String TEMP_PROP_BLOCKID

See Also:

Constant Field Values

TEMP_PROP_WINDOWNAME

protected static final java.lang.String TEMP_PROP_WINDOWNAME

See Also:

Constant Field Values

TEMP_PROP_COMPNAME

protected static final java.lang.String TEMP_PROP_COMPNAME

See Also:

Constant Field Values

TEMP_PROP_TIMEOUT

protected static final java.lang.String TEMP_PROP_TIMEOUT

See Also:

Constant Field Values

TEMP_PROP_VARIABLENAME

protected static final java.lang.String TEMP_PROP_VARIABLENAME

See Also:

Constant Field Values

TEMP_PROP_FILENAME

protected static final java.lang.String TEMP_PROP_FILENAME

See Also:

Constant Field Values

TEMP_PROP_ENCODING

protected static final java.lang.String TEMP_PROP_ENCODING

See Also:

Constant Field Values

TEMP_PROP_APP_ROTATABLE

protected static final java.lang.String TEMP_PROP_APP_ROTATABLE

See Also:

Constant Field Values

TEMP_PROP_SUBAREA

protected static final java.lang.String TEMP_PROP_SUBAREA

See Also:

Constant Field Values

command

protected java.lang.String command

appids

protected java.util.Hashtable appids

droiddata

protected DTestRecordHelper droiddata

props

protected java.util.Properties props

control

protected SAFSRemoteControl control

staf

protected STAFHelper staf

temp_props

protected java.util.Properties temp_props

used to pass values locally between process methods, and processResults

Constructor Detail

DDriverCommand

public DDriverCommand()

Method Detail

setTestRecordData

public void setTestRecordData(TestRecordHelper data)

Overrides:

setTestRecordData in class Processor

interpretFields

protected java.util.Collection interpretFields()
                                        throws SAFSException

Calls the default processing of interpretFields and then prepares the droiddata (testRecordData) with the initial KeywordProperties of:

KEY_COMMAND=non-null
KEY_PARAM_1-N (param1 - paramN, even if > 9)

Keyword implementations will need to add to these properties:

KEY_TARGET
KEY_PARAM_TIMEOUT (may be different for each keyword)

Overrides:

interpretFields in class DriverCommand

Returns:

Collection of the parameter(s)

Throws:

SAFSException

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

processProperties

protected void processProperties(int param_timeout)
                          throws java.lang.IllegalThreadStateException,
                                 RemoteException,
                                 java.util.concurrent.TimeoutException,
                                 ShutdownInvocationException

Sets Property PARAM_TIMEOUT and then processes the completed remote control action properties. This method is called internally by individual keyword implementations. After returning from remote processing the routine updates the droiddata via DUtilities.captureRemoteResultsProperties(RemoteResults, DTestRecordHelper). This routine then calls processResults(RemoteResults).

Throws:

java.util.concurrent.TimeoutException - if the Ready, Running, or Results signals timeout.

java.lang.IllegalThreadStateException - if sockets communications failed.

ShutdownInvocationException - if sockets communication signals a shutdown has commenced.

RemoteException - if the remote client has issued an Exception.

See Also:

DUtilities.captureRemoteResultsProperties(RemoteResults, DTestRecordHelper)

processResults

protected void processResults(RemoteResults results)

called internally by processProperties(int) AFTER the remote execution has completed.

processResourceMessageInfoResults

protected boolean processResourceMessageInfoResults(int msgType)

Logs any message or message with detail that might be captured in the current droiddata. The routine does not set or change any statusCode or statusInfo information.

If a message was found and logged, the routine returns TRUE. This means the caller does NOT have to log any success or failure message.

If no message was found, then the routine will return FALSE and the caller will need to log an appropriate message.

Parameters:

msgType - -- int message type identifier constant as defined in AbstractLogFacility.

Returns:

true if we did find and handle a ResoureMessageInfo result. false otherwise.

logResourceMessageFailure

protected void logResourceMessageFailure()

Log a FAILED_MESSAGE using whatever ResourceMessageInfo data is returned in droiddata. The command does not change any statusCode or statusInfo information. Calls processResourceMessageInfoResults(int) to attempt the logging. If there was no ResourceMessageInfo, we still log a generic failed message via Processor.issueActionFailure(String).

doGUIBranching

protected void doGUIBranching()
                       throws java.lang.IllegalThreadStateException,
                              RemoteException,
                              java.util.concurrent.TimeoutException,
                              ShutdownInvocationException

OnGuiExistsGotoBlockID and OnGuiNotExistGotoBlockID commands setup.

Validates the presence of:
BLOCKID (PARAM_1)
WINDOWID (PARAM_2 and KEY_WINNAME)
COMPID (PARAM_3 and KEY_COMPNAME)
and the optional TIMEOUT parameter (PARAM_4 && PARAM_TIMEOUT)

Through DUtilities.getAppMapRecognition(DTestRecordHelper) adds:
KEY_WINREC
KEY_COMPREC

The current implementation does expect recognition strings to exist in the App Map. If none are found, the command will issue a failure without making a remote call.

Upon successful execution of the command, the remote process should return:

StatusCode = NO_SCRIPT_FAILURE (condition met) allow the branching to occur.
StatusCode = SCRIPT_WARNING (condition not met) but no failures occurred -- do not branch.
StatusCode = anything else will expect RemoteMessageInfo(s) to report the failure.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

doGuiBranchingResults

protected void doGuiBranchingResults(RemoteResults results)

OnGuiExistsGotoBlockID and OnGuiNotExistGotoBlockID commands remote results.

Upon successful execution of the command, the remote process should return:

StatusCode = NO_SCRIPT_FAILURE (condition met) allow the branching to occur.
StatusCode = SCRIPT_WARNING (condition not met) but no failures occurred -- do not branch.
StatusCode = anything else will expect RemoteMessageInfo(s) to report the failure.

Parameters:

results - -- returned from the processProperties call.

doWaitForGui

protected void doWaitForGui()
                     throws java.lang.IllegalThreadStateException,
                            RemoteException,
                            java.util.concurrent.TimeoutException,
                            ShutdownInvocationException

WaitForGui and WaitForGuiGone commands setup.

Validates the presence of:
WINDOWID (PARAM_1 && KEY_WINNAME)
COMPID (PARAM_2 && KEY_COMPNAME)
and the optional TIMEOUT parameter (PARAM_3 && PARAM_TIMEOUT)

Through DUtilities.getAppMapRecognition(DTestRecordHelper) adds:
KEY_WINREC
KEY_COMPREC

The current implementation does expect recognition strings to exist in the App Map. If none are found, the command will issue a failure without making a remote call.

Upon successful execution of the command, the remote process should return:

StatusCode = NO_SCRIPT_FAILURE -- condition met in timeout period.
StatusCode = SCRIPT_WARNING -- condition not met in timeout period.
StatusCode = anything else will expect RemoteMessageInfo(s) to report the failure.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

doWaitForGuiResults

protected void doWaitForGuiResults(RemoteResults results)

WaitForGui and WaitForGuiGone commands remote results.

Upon successful execution of the command, the remote process should return:

StatusCode = NO_SCRIPT_FAILURE -- condition met in timeout period.
StatusCode = SCRIPT_WARNING -- condition not met in timeout period.
StatusCode = anything else will expect RemoteMessageInfo(s) to report the failure.

Parameters:

results - -- returned from the processProperties call.

doClipboardCommand

protected void doClipboardCommand()
                           throws java.lang.IllegalThreadStateException,
                                  RemoteException,
                                  java.util.concurrent.TimeoutException,
                                  ShutdownInvocationException

Process clipboard related keywords:
AssignClipboardVariable
ClearClipboard
SaveClipboardToFile
SetClipboard
VerifyClipboardToFile

Validates the presence of:
FileName (PARAM_1) for keyword SaveClipboardToFile and VerifyClipboardToFile
ContentToSet (PARAM_1) for keyword SetClipboard
VariableName (PARAM_1) for keyword AssignClipboardVariable

Then pass the command to the remote side to be processed.

Upon successful execution of the command, the remote process should return:

StatusCode = NO_SCRIPT_FAILURE -- condition met in timeout period.
StatusCode = anything else will expect RemoteMessageInfo(s) to report the failure.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

doTakeScreenShotCommand

protected void doTakeScreenShotCommand()
                                throws java.lang.IllegalThreadStateException,
                                       RemoteException,
                                       java.util.concurrent.TimeoutException,
                                       ShutdownInvocationException

This method is used to check the parameter of keyword TakeScreenShot.
Filename is the required parameter.
Rotatable is the optional parameter.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

doTakeScreenShotResults

protected void doTakeScreenShotResults(RemoteResults results)

Process result of keyword TakeScreenShot.
The remote device side will return the rotate degree of the device.
The ScreenShot will be got through API of the AndroidDebugBridger at computer side.
The returned image is always that you put your device at the default direction.
We should rotate that returned image back if the tested android application is rotatable.

Parameters:

results - RemoteResults, returned from the processProperties call.

doClipboardResults

protected void doClipboardResults(RemoteResults results)

Process result of clipboard related keywords:
AssignClipboardVariable
ClearClipboard
SaveClipboardToFile
SetClipboard
VerifyClipboardToFile

Upon successful execution of the command, the remote process should return:

StatusCode = NO_SCRIPT_FAILURE -- remote execution succeed. We need continue process at local side.
StatusCode = anything else will expect RemoteMessageInfo(s) to report the failure.

Parameters:

results - -- returned from the processProperties call.

doCommandWithoutPrameter

protected void doCommandWithoutPrameter(int timeout)
                                 throws java.lang.IllegalThreadStateException,
                                        RemoteException,
                                        java.util.concurrent.TimeoutException,
                                        ShutdownInvocationException

This method is used to execute a keyword without parameter:

• HideSoftKeyboard
• ShowSoftKeyboard

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

doCommandWithoutPrameterResults

protected void doCommandWithoutPrameterResults(RemoteResults results)

This method is used to handle result of a keyword without parameter:

• HideSoftKeyboard
• ShowSoftKeyboard

Parameters:

results - RemoteResults, returned from the processProperties call.