org.safs

Class DriverCommand

java.lang.Object

org.safs.Processor

org.safs.DriverCommand

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

AutoItComponent.AutoItDriverCommand, DCDriverCommand, DCDriverCommand, DCDriverCommand, DCDriverCommand, DCDriverDatabaseCommands, DCDriverFileCommands, DCDriverFlowCommands, DCDriverMiscCommands, DCDriverStringCommands, DCDriverTimerCommands, DDriverCommand, IDriverCommand, TIDDriverRestCommands.RESTDriverCommand

public abstract class DriverCommand
extends Processor

Purpose: abstract DriverCommand, enforces that the 'process' method be implemented

• DRIVER COMMANDS (so far...):
  • DCDriverCommand
    • callScript
      • 1st param: RobotJ script to call
      • Example: C,CallScript,TestScript2

Since:

JUN 14, 2003

Author:

Doug Bauman

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	command The current command keyword being executed.
protected java.util.Iterator<java.lang.String>	iterator Used to iterate over any params provided for a command.
protected DDGUIUtilities	utils Provide the GUI Utilities, sub-class may has its own implementation.

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
DriverCommand() Purpose: constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	checkGUIExistence(boolean expectedExist, java.lang.String mapNam, java.lang.String window, java.lang.String component, int timeoutInSeconds) Check the existence of the window/component and return the satisfaction of the existence. The satisfaction depends on component's existence and our expectation of its existence. Subclass only need to implement this method to get the following keywords work.
protected void	commandProcess() Process the driver command specifically.
protected java.lang.String	getStandardFailureDetail() Uses testRecordData to create standard failure text.
protected java.lang.String	getStandardWarningDetail() Uses testRecordData to create standard warning text.
protected void	init() Initialize test record, utilities.
protected java.util.Collection	interpretFields() Purpose: Interprets the fields of the driver command record and puts the appropriate values into the fields of testRecordData.
protected void	issueActionUsingNegativeMessage(java.lang.String x, java.lang.String detail) "[Action] using [x] finished with a negative result." "[detail]" * @param detail -- a detail message already properly localized, if necessary.
protected void	issueActionWarning(java.lang.String warning) Issue [command] was not successful.
protected void	issueExecutionNegativeMessage(java.lang.String detail) "Action processed with a negative result." "[detail]" Purpose: set failure status and log a simple failure message when a test record got processed with negative result.
protected void	issueFileErrorFailure(java.lang.String filename) Issue a file error and failure message Filename does not need to be localized.
protected void	issueGenericSuccess(java.lang.String comment) issue OK status and generic message (not a PASSED message) [action] successful.
protected void	issueGenericSuccess(java.lang.String comment, java.lang.String detail) issue OK status and generic message (not a PASSED message): [action] successful.
protected void	issueGenericSuccessUsing(java.lang.String x, java.lang.String comment) issue OK status and Generic message (not a PASSED message): [action] successful using [x].
protected void	issueParameterCountFailure() Issue parameter count error and failure message
protected void	issueParameterCountFailure(java.lang.String detail) Issue parameter count error and failure message
protected void	issueParameterValueFailure(java.lang.String paramName) Issue parameter value error and failure message along with a failure status.
protected void	issuePassedSuccess(java.lang.String comment) issue OK status and PASSED message. [action] successful.
protected void	issueUnknownErrorFailure(java.lang.String cause) Issue a generic error and failure message The cause parameter is expected to already be localized.
boolean	isSupportedRecordType(java.lang.String recordType) Supports standard DRIVER COMMAND record types (C, CW, CF)
protected void	localProcess() This superclass implementation does absolutely nothing.
void	process() The primary method that all subclasses must implement.

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

command

protected java.lang.String command

The current command keyword being executed.

iterator

protected java.util.Iterator<java.lang.String> iterator

Used to iterate over any params provided for a command.

utils

protected DDGUIUtilities utils

Provide the GUI Utilities, sub-class may has its own implementation.

Constructor Detail

DriverCommand

public DriverCommand()

Purpose: constructor

Method Detail

isSupportedRecordType

public boolean isSupportedRecordType(java.lang.String recordType)

Supports standard DRIVER COMMAND record types (C, CW, CF)

Specified by:

isSupportedRecordType in class Processor

Parameters:

recordType - -- String text of record type to match (ignoring case).

Returns:

'true' if the provided recordType is one this Processor can execute. Note, that SAFS record types are normally not case-sensitive. So the comparison to match the provided recordType should ignore case.

interpretFields

protected java.util.Collection interpretFields()
                                        throws SAFSException

Purpose: Interprets the fields of the driver command record and puts the appropriate values into the fields of testRecordData.
Side Effects: Processor.testRecordData fields are set from the inputRecord.
State Read: Processor.testRecordData, the inputRecord field
Assumptions: The following order:

Field #1: The DRIVER COMMAND record type (C).

Subsequent fields would be as follows (with a separator between each field):
Field: #2 #3 - N
============== ===============
COMMAND, [PARAMETER(S),]

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 Processor

init

protected void init()
             throws SAFSException

Initialize test record, utilities. Subclass may override to provide more specific implementation.

Throws:

SAFSException

localProcess

protected void localProcess()

This superclass implementation does absolutely nothing. Subclasses should implement this to provide their new or overriding functionality.

commandProcess

protected void commandProcess()

Process the driver command specifically. Here an empty implementation is provided, sub-class will give the detail.

issueGenericSuccess

protected void issueGenericSuccess(java.lang.String comment,
                                   java.lang.String detail)

issue OK status and generic message (not a PASSED message):
[action] successful. [comment]
[detail]
string comment and detail are expected to already be localized, but can be null.

issueGenericSuccessUsing

protected void issueGenericSuccessUsing(java.lang.String x,
                                        java.lang.String comment)

issue OK status and Generic message (not a PASSED message):
[action] successful using [x]. [Comment]
Comment is expected to already be localized if present, but can be null.

issuePassedSuccess

protected void issuePassedSuccess(java.lang.String comment)

issue OK status and PASSED message.
[action] successful. [comment]
string comment is expected to already be localized, but can be null.

issueGenericSuccess

protected void issueGenericSuccess(java.lang.String comment)

issue OK status and generic message (not a PASSED message)
[action] successful. [comment]
string comment is expected to already be localized, but can be null.

getStandardFailureDetail

protected java.lang.String getStandardFailureDetail()

Uses testRecordData to create standard failure text.

Returns:

[command] failure in table [filename] at line [n]. Called by other routines.

getStandardWarningDetail

protected java.lang.String getStandardWarningDetail()

Uses testRecordData to create standard warning text.

Returns:

[command] warning in table [filename] at line [n]. Called by other routines.

issueActionWarning

protected void issueActionWarning(java.lang.String warning)

Issue [command] was not successful. [warning].
[command warning in table filename at line n].

Sets status to WARNING and issues a WARNING message. string warning is expected to already be localized.

issueParameterCountFailure

protected void issueParameterCountFailure()

Issue parameter count error and failure message

issueParameterCountFailure

protected void issueParameterCountFailure(java.lang.String detail)

Issue parameter count error and failure message

Parameters:

detail - detail about specific missing params or command format

issueParameterValueFailure

protected void issueParameterValueFailure(java.lang.String paramName)

Issue parameter value error and failure message along with a failure status.

Parameters:

paramName - -- the Name of the action parameter in error.

issueFileErrorFailure

protected void issueFileErrorFailure(java.lang.String filename)

Issue a file error and failure message Filename does not need to be localized.

issueUnknownErrorFailure

protected void issueUnknownErrorFailure(java.lang.String cause)

Issue a generic error and failure message The cause parameter is expected to already be localized.

issueExecutionNegativeMessage

protected void issueExecutionNegativeMessage(java.lang.String detail)

"Action processed with a negative result."
"[detail]"
Purpose: set failure status and log a simple failure message when a test record got processed with negative result. When an action intends to make a judgment, a negative result is gotten if the logical result of the judgment is false; the test step will be logged as 'FAIL' although it got executed correctly. Called by some comparing actions. * @param detail -- a detail message already properly localized, if necessary.

issueActionUsingNegativeMessage

protected void issueActionUsingNegativeMessage(java.lang.String x,
                                               java.lang.String detail)

"[Action] using [x] finished with a negative result."
"[detail]" * @param detail -- a detail message already properly localized, if necessary.

checkGUIExistence

protected boolean checkGUIExistence(boolean expectedExist,
                                    java.lang.String mapNam,
                                    java.lang.String window,
                                    java.lang.String component,
                                    int timeoutInSeconds)
                             throws SAFSException

Check the existence of the window/component and return the satisfaction of the existence.
The satisfaction depends on component's existence and our expectation of its existence.
Subclass only need to implement this method to get the following keywords work.

• OnGUIExistsGotoBlockID
• OnGUINotExistGotoBlockID

Parameters:

expectedExist - boolean, the expected existence of the window/component.
when true is provided, if the component is present within timeout, then it return true; otherwise return false;
when false is provided, if the component is not present or disappears within timeout, then it return true; otherwise return false;

mapNam - String, the map name

window - String, the window's name

component - String, the component's name

timeoutInSeconds - int, the timeout in seconds

Returns:

boolean, true if the expected presence is satisfied

Throws:

SAFSException - is thrown out if there is something wrong.

See Also:

onGUIGotoCommands(boolean)