org.safs.android.engine.processor

Class TestStepProcessor

java.lang.Object

com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

org.safs.android.engine.processor.SAFSProcessor

org.safs.android.engine.processor.TestStepProcessor

All Implemented Interfaces:

ProcessorInterface

Direct Known Subclasses:

CheckBoxProcessor, ComboBoxProcessor, DataPickerProcessor, EditTextProcessor, GridViewProcessor, ListViewProcessor, ProgressBarProcessor, RoutingViewProcessor, ScrollBarProcessor, TabControlProcessor, TextViewProcessor, TimePickerProcessor, ViewProcessor

public abstract class TestStepProcessor
extends SAFSProcessor

Abstract class used to process ComponentFunctions in the remote (on-device) SAFSTestRunner.

Each concrete subclass will extend this class and implement the required processComponentFunction method.

The SAFSTestRunner should expect to execute from Properties with the following settings:

SAFSMessage.KEY_TARGET=SAFSMessage.target_safs_<cf_processor>
SAFSMessage.KEY_WINNAME=<window name>
SAFSMessage.KEY_WINREC=<window recognition string>
SAFSMessage.KEY_COMPNAME=<child component name>
SAFSMessage.KEY_COMPREC=<child component recognition string>
SAFSMessage.KEY_COMMAND=<cf_action>
SAFSMessage.PARAM_TIMEOUT=<seconds>

Upon a valid and complete execution the SAFSTestRunner is expected to return:

SAFSMessage.KEY_ISREMOTERESULT=true
SAFSMessage.KEY_REMOTERESULTCODE=int
SAFSMessage.KEY_REMOTERESULTINFO=String

Any command returning a REMOTERESULTINFO should format it in the exact manner documented in the SAFS Keyword Reference for that command. This processor will simply forward that info into the testRecordData used by the engine using this processor.

As specific commands require additional parameters they are sent as:

SAFSMessage.PARAM_1=val
SAFSMessage.PARAM_2=val
etc...
SAFSMessage.PARAM_9=val

Author:

Carl Nagle, SAS Institute, Inc. 26 APR, 2012 (Lei Wang) Add some methods to treat the keyword's parameters; get embedded solo, instrumentation object; log general success and failure. 19 APR, 2013 (Lei Wang) Get testObject from cache by windowName and componentName before looking by search-algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	debugPrefix

Fields inherited from class org.safs.android.engine.processor.SAFSProcessor

command_timeout, compname, compobj, comprec, dgcd, dgov, inst, KEY_COMPOBJ, params, resourceDetailMsg, resourceMsg, robot, secsWaitForComponent, secsWaitForWindow, solo, TAG, testObjectCache, testrunner, winname, winobj, winrec

Fields inherited from class com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

INITIAL_CACHE_SIZE, remoteCommand, testRunner

Constructor Summary

Constructors

Constructor and Description
TestStepProcessor(DSAFSTestRunner testrunner)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkParameterSize(int size, java.util.Properties props) To check if the parameter's size is enough. If the parameter size if not enough, we set general error with resource message. and return false.
protected boolean	checkSolo(java.util.Properties props) To check if the Solo object can be got or not. If the Solo object can be got, we set general error with resource message. and return false.
protected boolean	commandNotExecuted(java.util.Properties props) Test if the command has been executed or not.
java.lang.String[]	convertCoords(java.lang.String coords) Convert coordinates string of the formats: "x;y" "x,y" "x y" "Coords=x;y" "Coords=x,y" "Coords=x y" into a java.awt.Point object.
protected abstract void	processComponentFunction(java.util.Properties props) Called internally by processProperties after the DGOV, WIN, and COMP components have been found and are ready for action.
void	processProperties(java.util.Properties props) Implements Component Function handling initialization by first finding the necessary Window and Component objects before routing the call to processComponentFunction().
protected void	retrieveParameters(java.util.Properties props) Retrieve the parameters from the properties and put them in the global variable SAFSProcessor.params The parameters are stored in a properties object, the key is: SAFSMessage.PARAM_1 SAFSMessage.PARAM_2 and so on.
protected void	setGeneralError3(java.util.Properties props, ResourceMessageInfo detail) Set a error result and send back error message as following: Unable to perform remoteCommand on compname in winname. The parameter 'detail' of this method will contain the detail error message, and it will be also sent back
protected void	setGeneralErrorUnsupportedObjectType(java.util.Properties props) Calls SAFSProcessor.setGeneralErrorWithBundleMessage(Properties, ResourceMessageInfo, ResourceMessageInfo) issuing the general error with the additional detail that the compobj is NOT of a supported type for the action requested.
protected void	setGeneralErrorWithDetailBundle(java.util.Properties props, ResourceMessageInfo detail) Set a error result and send back error message as following: winname:compname remoteCommand processed with a negative result. The parameter 'detail' of this method will contain the detail error message, and it will be also sent back
protected void	setGeneralSuccessWithBundle(java.util.Properties props) Set a success result and send back success message as following: winname:compname remoteCommand successful.
protected void	setGenericError(java.util.Properties props, java.lang.String errorMsg) Set a error result and send back error message as following: *** ERROR *** Error Message.

Methods inherited from class org.safs.android.engine.processor.SAFSProcessor

clearTestObjectCache, extractComponentProperties, getDgcd, getInstrumentation, getParams, getSecsWaitForComponent, getSecsWaitForWindow, getSolo, getTestObject, setDgcd, setGeneralErrorWithBundleMessage, setGeneralSuccessWithBundleMessage, setParams, setSecsWaitForComponent, setSecsWaitForWindow, setSolo, setTestObject

Methods inherited from class com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

convertToKey, convertToKeys, convertToKeys, debug, getCachedItem, getStackTrace, makeUniqueCacheKey, processMessage, putCachedItem, removeCachedItem, resetExternalModeCache, setGeneralError, setGeneralError, setGeneralErrorWithSpecialInfo, setGeneralErrorWithSpecialInfo, setGeneralSuccess, setGeneralSuccess, setGeneralSuccessWithSpecialInfo, setGeneralWarningWithSpecialInfo, setRemoteCommand, stringIsMatched

Methods inherited from class java.lang.Object

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

Field Detail

debugPrefix

java.lang.String debugPrefix

Constructor Detail

TestStepProcessor

public TestStepProcessor(DSAFSTestRunner testrunner)

Method Detail

processProperties

public void processProperties(java.util.Properties props)

Implements Component Function handling initialization by first finding the necessary Window and Component objects before routing the call to processComponentFunction(). The routine will issue appropriate errors if the Window or Component names are missing, or if the recognition strings for the objects are missing. It call retrieveParameters(Properties) to initialize SAFSProcessor.params

Specified by:

processProperties in interface ProcessorInterface

Overrides:

processProperties in class AbstractProcessor

See Also:

ProcessorInterface.processProperties(Properties)

commandNotExecuted

protected boolean commandNotExecuted(java.util.Properties props)
                              throws ProcessorException

Test if the command has been executed or not.

Returns:

boolean, true if the command has not been executed.

Throws:

ProcessorException

retrieveParameters

protected void retrieveParameters(java.util.Properties props)

Retrieve the parameters from the properties and put them in the global variable SAFSProcessor.params
The parameters are stored in a properties object, the key is:
SAFSMessage.PARAM_1
SAFSMessage.PARAM_2
and so on.

Parameters:

props - Properties contain the parameters sent from 'remote control side'

checkParameterSize

protected boolean checkParameterSize(int size,
                                     java.util.Properties props)

To check if the parameter's size is enough.
If the parameter size if not enough, we set general error with resource message.
and return false. When user call this method and get a false, user is happy to return without setting the error in the properties.

Parameters:

size, - int, the minimum number of parameters

props - Properties, contains the output results

Returns:

boolean, true if SAFSProcessor.params contain engough parameters.

checkSolo

protected boolean checkSolo(java.util.Properties props)

To check if the Solo object can be got or not.
If the Solo object can be got, we set general error with resource message.
and return false. When user call this method and get a false, user is happy to return without setting the error in the properties.

Parameters:

props - Properties, contains the output results

Returns:

boolean, true if SAFSProcessor.solo is got correclty.

setGeneralSuccessWithBundle

protected void setGeneralSuccessWithBundle(java.util.Properties props)

Set a success result and send back success message as following:
winname:compname remoteCommand successful.

Parameters:

props - Properties, contains the output results

setGeneralErrorWithDetailBundle

protected void setGeneralErrorWithDetailBundle(java.util.Properties props,
                                               ResourceMessageInfo detail)

Set a error result and send back error message as following:
winname:compname remoteCommand processed with a negative result.
The parameter 'detail' of this method will contain the detail error
message, and it will be also sent back

Parameters:

props - Properties, contains the output results

detail - ResourceMessageInfo, contain the detail error message.

setGeneralError3

protected void setGeneralError3(java.util.Properties props,
                                ResourceMessageInfo detail)

Set a error result and send back error message as following:
Unable to perform remoteCommand on compname in winname.
The parameter 'detail' of this method will contain the detail error
message, and it will be also sent back

Parameters:

props - Properties, contains the output results

detail - ResourceMessageInfo, contain the detail error message.

setGenericError

protected void setGenericError(java.util.Properties props,
                               java.lang.String errorMsg)

Set a error result and send back error message as following:
*** ERROR *** Error Message.

Parameters:

props - Properties, contains the output results

errorMsg - String, the generic error message.

setGeneralErrorUnsupportedObjectType

protected void setGeneralErrorUnsupportedObjectType(java.util.Properties props)

Calls SAFSProcessor.setGeneralErrorWithBundleMessage(Properties, ResourceMessageInfo, ResourceMessageInfo) issuing the general error with the additional detail that the compobj is NOT of a supported type for the action requested.

Parameters:

props -

convertCoords

public java.lang.String[] convertCoords(java.lang.String coords)

Convert coordinates string of the formats:

• "x;y"
• "x,y"
• "x y"
• "Coords=x;y"
• "Coords=x,y"
• "Coords=x y"

into a java.awt.Point object.

Subclasses may override to convert alternative values, such as Row and Col values as is done in org.safs.rational.CFTable

Parameters:

coords, - String x;y or x,y or Coords=x;y or Coords=x,y

Returns:

String[]{x,y}, or String[0]{} if invalid

processComponentFunction

protected abstract void processComponentFunction(java.util.Properties props)

Called internally by processProperties after the DGOV, WIN, and COMP components have been found and are ready for action.

Parameters:

props -