public class DDDriverFlowCommands
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CALLCYCLE_KEYWORD
"CallCycle"
|
static java.lang.String |
CALLJUNIT_KEYWORD
"CallJUnit"
|
static java.lang.String |
CALLSCRIPT_KEYWORD
"CallScript"
|
static java.lang.String |
CALLSTEP_KEYWORD
"CallStep"
|
static java.lang.String |
CALLSUITE_KEYWORD
"CallSuite"
|
static java.lang.String |
CALLTESTNG_KEYWORD
"CallTestNG"
|
static java.lang.String |
EXITCYCLE_KEYWORD
"ExitCycle"
|
static java.lang.String |
EXITSUITE_KEYWORD
"ExitSuite"
|
static java.lang.String |
EXITTABLE_KEYWORD
"ExitTable"
|
static java.lang.String |
GOTOBLOCKID_KEYWORD
"GotoBlockID"
|
static java.lang.String |
ONCONTAINSGOTOBLOCKID_KEYWORD
"OnContainsGotoBlockID"
|
static java.lang.String |
OnDirectoryExistGotoBlockID_KEYWORD
"OnDirectoryExistGotoBlockID"
|
static java.lang.String |
ONDIRECTORYNOTEXISTGOTOBLOCKID_KEYWORD
"OnDirectoryNotExistGotoBlockID"
|
static java.lang.String |
ONEQUALGOTOBLOCKID_KEYWORD
"OnEqualGotoBlockID"
|
static java.lang.String |
ONFILEEOFGOTOBLOCKID_KEYWORD
"OnFileEOFGotoBlockID"
|
static java.lang.String |
ONFILEEXISTGOTOBLOCKID_KEYWORD
"OnFileExistGotoBlockID"
|
static java.lang.String |
ONFILENOTEXISTGOTOBLOCKID_KEYWORD
"OnFileNotExistGotoBlockID"
|
static java.lang.String |
ONGREATERTHANGOTOBLOCKID_KEYWORD
"OnGreaterThanGotoBlockID"
|
static java.lang.String |
ONGUIEXISTSGOTOBLOCKID_KEYWORD
"OnGUIExistsGotoBlockID"
|
static java.lang.String |
ONGUINOTEXISTGOTOBLOCKID_KEYWORD
"OnGUINotExistGotoBlockID"
|
static java.lang.String |
ONINRANGEGOTOBLOCKID_KEYWORD
"OnInRangeGotoBlockID"
|
static java.lang.String |
ONLESSTHANGOTOBLOCKID_KEYWORD
"OnLessThanGotoBlockID"
|
static java.lang.String |
ONMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD
"OnMenuItemContainsStateGotoBlockID"
|
static java.lang.String |
ONNOTCONTAINSGOTOBLOCKID_KEYWORD
"OnNotContainsGotoBlockID"
|
static java.lang.String |
ONNOTEQUALGOTOBLOCKID_KEYWORD
"OnNotEqualGotoBlockID"
|
static java.lang.String |
ONNOTGREATERTHANGOTOBLOCKID_KEYWORD
"OnNotGreaterThanGotoBlockID"
|
static java.lang.String |
ONNOTINRANGEGOTOBLOCKID_KEYWORD
"OnNotInRangeGotoBlockID"
|
static java.lang.String |
ONNOTLESSTHANGOTOBLOCKID_KEYWORD
"OnNotLessThanGotoBlockID"
|
static java.lang.String |
ONPARTIALMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD
"OnPartialMenuItemContainsStateGotoBlockID"
|
static java.lang.String |
ONREGISTRYKEYEXISTGOTOBLOCKID_KEYWORD
"OnRegistryKeyExistGotoBlockID"
|
static java.lang.String |
ONREGISTRYKEYNOTEXISTGOTOBLOCKID_KEYWORD
"OnRegistryKeyNotExistGotoBlockID"
|
static java.lang.String |
SETEXITTABLEBLOCK_KEYWORD
"SetExitTableBlock"
|
static java.lang.String |
SETGENERALSCRIPTFAILUREBLOCK_KEYWORD
"SetGeneralScriptFailureBlock"
|
static java.lang.String |
SETINVALIDFILEIOBLOCK_KEYWORD
"SetInvalidFileIOBlock"
|
static java.lang.String |
SETNOSCRIPTFAILUREBLOCK_KEYWORD
"SetNoScriptFailureBlock"
|
static java.lang.String |
SETSCRIPTNOTEXECUTEDBLOCK_KEYWORD
"SetScriptNotExecutedBlock"
|
static java.lang.String |
SETSCRIPTWARNINGBLOCK_KEYWORD
"SetScriptWarningBlock"
|
static java.lang.String |
USELOCALFLOWCONTROL_KEYWORD
"UseLocalFlowControl"
|
Modifier and Type | Method and Description |
---|---|
static DriverCommand |
callCycle(java.lang.String[] parameters)
Invoke a Cycle table (from StepDriver or SuiteDriver)
Since the Cycle is executed as a driver command
and NOT as a test record, the call to the
Cycle itself is not counted as a test pass or a test fail.
|
static DriverCommand |
callCycle(java.lang.String cycleName,
java.lang.String cycleSeparator,
java.lang.String parameterName)
Invoke a Cycle table (from StepDriver or SuiteDriver)
Since the Cycle is executed as a driver command
and NOT as a test record, the call to the
Cycle itself is not counted as a test pass or a test fail.
|
static DriverCommand |
callJUnit(java.lang.String className)
Invoke one or more JUnit tests using the provided Class name(s).
|
static DriverCommand |
callScript(java.lang.String[] parameters)
Invoke a custom script with passed parameters/variables, if desired.
|
static DriverCommand |
callScript(java.lang.String scriptName,
java.lang.String parameterName)
Invoke a custom script with passed parameters/variables, if desired.
|
static DriverCommand |
callStep(java.lang.String[] parameters)
Invoke a Step table from within another Step table (from StepDriver).
|
static DriverCommand |
callStep(java.lang.String stepName,
java.lang.String stepSeparator,
java.lang.String parameterName)
Invoke a Step table from within another Step table (from StepDriver).
|
static DriverCommand |
callSuite(java.lang.String[] parameters)
Invoke a Suite table (from StepDriver or SuiteDriver)
You cannot use CallSuite in a CycleDriver test table.
|
static DriverCommand |
callSuite(java.lang.String suiteName,
java.lang.String suiteSeparator,
java.lang.String parameterName)
Invoke a Suite table (from StepDriver or SuiteDriver)
You cannot use CallSuite in a CycleDriver test table.
|
static DriverCommand |
callTestNG(java.lang.String testNGParameters)
Invoke TestNG tests using the provided TestNG parameters.
|
static DriverCommand |
exitCycle()
Exit the currently running Step, Suite, and/or Cycle table.
|
static DriverCommand |
exitSuite()
Exit the currently running Step and/or Suite table.
|
static DriverCommand |
exitTable()
Exit the currently running Step, Suite, or Cycle table.
|
static DDDriverFlowCommands |
getInstance()
public Singleton to access class static methods via instance
|
static DriverCommand |
gotoBlockID(java.lang.String blockID)
Goto a named block in the current table.
|
static DriverCommand |
onContainsGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value2 is contained within value1.
|
static DriverCommand |
onContainsGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block in the current table if value2 is contained within value1.
|
static DriverCommand |
onDirectoryExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the directory exists.
|
static DriverCommand |
onDirectoryExistGotoBlockID(java.lang.String blockID,
java.lang.String directoryName)
Goto the named block in the current table if the directory exists.
|
static DriverCommand |
onDirectoryNotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the Directory does not exist.
|
static DriverCommand |
onDirectoryNotExistGotoBlockID(java.lang.String blockID,
java.lang.String directoryName)
Goto the named block in the current table if the Directory does not exist.
|
static DriverCommand |
onEqualGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if two values are equal.
|
static DriverCommand |
onEqualGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block in the current table if two values are equal.
|
static DriverCommand |
onFileEOFGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the file is at EOF.
|
static DriverCommand |
onFileEOFGotoBlockID(java.lang.String blockID,
java.lang.String fileNumber)
Goto the named block in the current table if the file is at EOF.
|
static DriverCommand |
onFileExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the file exists.
|
static DriverCommand |
onFileExistGotoBlockID(java.lang.String blockID,
java.lang.String fileName)
Goto the named block in the current table if the file exists.
|
static DriverCommand |
onFileNotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the file does not exist.
|
static DriverCommand |
onFileNotExistGotoBlockID(java.lang.String blockID,
java.lang.String fileName)
Goto the named block in the current table if the file does not exist.
|
static DriverCommand |
onGreaterThanGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value1 is greater than value2.
|
static DriverCommand |
onGreaterThanGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block in the current table if value1 is greater than value2.
|
static DriverCommand |
onGUIExistsGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if a GUI component exists.
|
static DriverCommand |
onGUIExistsGotoBlockID(java.lang.String blockID,
java.lang.String windowID,
java.lang.String componentID,
java.lang.String timeOut)
Goto the named block in the current table if a GUI component exists.
|
static DriverCommand |
onGUINotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if a GUI component does not exist.
|
static DriverCommand |
onGUINotExistGotoBlockID(java.lang.String blockID,
java.lang.String windowID,
java.lang.String componentID,
java.lang.String timeOut)
Goto the named block in the current table if a GUI component does not exist.
|
static DriverCommand |
onInRangeGotoBlockID(java.lang.String[] parameters)
Goto named block if value1 is between value2 and value3.
|
static DriverCommand |
onInRangeGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String value3,
java.lang.String caseSensitive)
Goto named block if value1 is between value2 and value3.
|
static DriverCommand |
onLessThanGotoBlockID(java.lang.String[] parameters)
Goto the named block if value1 is less than value2.
|
static DriverCommand |
onLessThanGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block if value1 is less than value2.
|
static DriverCommand |
onMenuItemContainsStateGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if state is part of the state information of the menuitem.
|
static DriverCommand |
onMenuItemContainsStateGotoBlockID(java.lang.String blockID,
java.lang.String windowName,
java.lang.String componentName,
java.lang.String menuItem,
java.lang.String state)
Goto the named block in the current table if state is part of the state information of the menuitem.
|
static DriverCommand |
onNotContainsGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value2 is NOT a substring of value1.
|
static DriverCommand |
onNotContainsGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block in the current table if value2 is NOT a substring of value1.
|
static DriverCommand |
onNotEqualGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if two values are not equal.
|
static DriverCommand |
onNotEqualGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block in the current table if two values are not equal.
|
static DriverCommand |
onNotGreaterThanGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value1 is NOT greater than value2.
|
static DriverCommand |
onNotGreaterThanGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block in the current table if value1 is NOT greater than value2.
|
static DriverCommand |
onNotInRangeGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value1 is not between value2 and value3.
|
static DriverCommand |
onNotInRangeGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String value3,
java.lang.String caseSensitive)
Goto the named block in the current table if value1 is not between value2 and value3.
|
static DriverCommand |
onNotLessThanGotoBlockID(java.lang.String[] parameters)
Goto the named block if value1 is NOT less than value2.
|
static DriverCommand |
onNotLessThanGotoBlockID(java.lang.String blockID,
java.lang.String value1,
java.lang.String value2,
java.lang.String caseSensitive)
Goto the named block if value1 is NOT less than value2.
|
static DriverCommand |
onPartialMenuItemContainsStateGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if state is part of the state information of the menuitem.
|
static DriverCommand |
onPartialMenuItemContainsStateGotoBlockID(java.lang.String blockID,
java.lang.String windowName,
java.lang.String componentName,
java.lang.String menuItem,
java.lang.String state)
Goto the named block in the current table if state is part of the state information of the menuitem.
|
static DriverCommand |
onRegistryKeyExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the Registry Key exists.
|
static DriverCommand |
onRegistryKeyExistGotoBlockID(java.lang.String blockID,
java.lang.String key,
java.lang.String keyValue,
java.lang.String timeOut)
Goto the named block in the current table if the Registry Key exists.
|
static DriverCommand |
onRegistryKeyNotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the Registry Key does not exist.
|
static DriverCommand |
onRegistryKeyNotExistGotoBlockID(java.lang.String blockID,
java.lang.String key,
java.lang.String keyValue,
java.lang.String timeOut)
Goto the named block in the current table if the Registry Key does not exist.
|
static DriverCommand |
setExitTableBlock(java.lang.String blockID)
Set or clear the name of a block to execute when the ExitTable command is encountered.
|
static DriverCommand |
setGeneralScriptFailureBlock(java.lang.String blockID)
Set or clear the name of a block to execute when GeneralScriptFailure occurs.
|
static DriverCommand |
setInvalidFileIOBlock(java.lang.String blockID)
Set or clear the name of a block to execute when InvalidFileIO occurs.
|
static DriverCommand |
setNoScriptFailureBlock(java.lang.String blockID)
Set or clear the name of a block to execute when NoScriptFailure occurs.
|
static DriverCommand |
setScriptNotExecutedBlock(java.lang.String blockID)
Set or clear the name of a block to execute when ScriptNotExecuted occurs.
|
static DriverCommand |
setScriptWarningBlock(java.lang.String blockID)
Set or clear the name of a block to execute when ScriptWarning occurs.
|
static DriverCommand |
useLocalFlowControl(java.lang.String state)
When TRUE then flow control block IDs have current table scope only.
|
public static final java.lang.String CALLCYCLE_KEYWORD
public static final java.lang.String CALLJUNIT_KEYWORD
public static final java.lang.String CALLSCRIPT_KEYWORD
public static final java.lang.String CALLSTEP_KEYWORD
public static final java.lang.String CALLSUITE_KEYWORD
public static final java.lang.String CALLTESTNG_KEYWORD
public static final java.lang.String EXITCYCLE_KEYWORD
public static final java.lang.String EXITSUITE_KEYWORD
public static final java.lang.String EXITTABLE_KEYWORD
public static final java.lang.String GOTOBLOCKID_KEYWORD
public static final java.lang.String ONCONTAINSGOTOBLOCKID_KEYWORD
public static final java.lang.String OnDirectoryExistGotoBlockID_KEYWORD
public static final java.lang.String ONDIRECTORYNOTEXISTGOTOBLOCKID_KEYWORD
public static final java.lang.String ONEQUALGOTOBLOCKID_KEYWORD
public static final java.lang.String ONFILEEOFGOTOBLOCKID_KEYWORD
public static final java.lang.String ONFILEEXISTGOTOBLOCKID_KEYWORD
public static final java.lang.String ONFILENOTEXISTGOTOBLOCKID_KEYWORD
public static final java.lang.String ONGREATERTHANGOTOBLOCKID_KEYWORD
public static final java.lang.String ONGUIEXISTSGOTOBLOCKID_KEYWORD
public static final java.lang.String ONGUINOTEXISTGOTOBLOCKID_KEYWORD
public static final java.lang.String ONINRANGEGOTOBLOCKID_KEYWORD
public static final java.lang.String ONLESSTHANGOTOBLOCKID_KEYWORD
public static final java.lang.String ONMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD
public static final java.lang.String ONNOTCONTAINSGOTOBLOCKID_KEYWORD
public static final java.lang.String ONNOTEQUALGOTOBLOCKID_KEYWORD
public static final java.lang.String ONNOTGREATERTHANGOTOBLOCKID_KEYWORD
public static final java.lang.String ONNOTINRANGEGOTOBLOCKID_KEYWORD
public static final java.lang.String ONNOTLESSTHANGOTOBLOCKID_KEYWORD
public static final java.lang.String ONPARTIALMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD
public static final java.lang.String ONREGISTRYKEYEXISTGOTOBLOCKID_KEYWORD
public static final java.lang.String ONREGISTRYKEYNOTEXISTGOTOBLOCKID_KEYWORD
public static final java.lang.String SETEXITTABLEBLOCK_KEYWORD
public static final java.lang.String SETGENERALSCRIPTFAILUREBLOCK_KEYWORD
public static final java.lang.String SETINVALIDFILEIOBLOCK_KEYWORD
public static final java.lang.String SETNOSCRIPTFAILUREBLOCK_KEYWORD
public static final java.lang.String SETSCRIPTNOTEXECUTEDBLOCK_KEYWORD
public static final java.lang.String SETSCRIPTWARNINGBLOCK_KEYWORD
public static final java.lang.String USELOCALFLOWCONTROL_KEYWORD
public static DDDriverFlowCommands getInstance()
public static DriverCommand callCycle(java.lang.String cycleName, java.lang.String cycleSeparator, java.lang.String parameterName)
Invoke a Cycle table (from StepDriver or SuiteDriver) Since the Cycle is executed as a driver command and NOT as a test record, the call to the Cycle itself is not counted as a test pass or a test fail.Supporting Engines:
cycleName
- Optional:NO
The name of the Cycle table to execute.cycleSeparator
- Optional:YES DefaultVal:
The field separator used by the table--if required.parameterName
- Optional:YES DefaultVal:AValue
One or more parameter values to send to the Cycle--each in their own field.public static DriverCommand callCycle(java.lang.String[] parameters)
Invoke a Cycle table (from StepDriver or SuiteDriver) Since the Cycle is executed as a driver command and NOT as a test record, the call to the Cycle itself is not counted as a test pass or a test fail.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand callJUnit(java.lang.String className)
Invoke one or more JUnit tests using the provided Class name(s). Because JUnit is a testing framework; test_record, test_passes, and test_failure counts within the status counters will be updated when possible. If properly configured with SAFS RuntimeDataAwareness (dependency injection of SAFS Driver instances) the JUnit test has full access to all SAFS services including SAFS App Map data and SAFS Variable storage. JUnit tests can be intermixed with other SAFS tests.Supporting Engines:
className
- Optional:NO
The name of one or more Classes to execute.public static DriverCommand callScript(java.lang.String scriptName, java.lang.String parameterName)
Invoke a custom script with passed parameters/variables, if desired. Since the script is executed as a Driver Command and NOT a test; test_record, test_passes, and test_failures information within the status counters are not updated. For Rational Robot, if the called script wishes to record tests attempted, pass, and failure counts then it must do so itself by updating the ScriptStatusInfo fields accordingly. The name of the script must not include the file extension. Any number of parameters can be passed to the script. These parameters are passed as DDVariables and\or SAFSVARS variables. The variables and their values are available to the script and all of SAFS. These parameters are usually specific to each called script. The script can also set variable values for use by SAFS test tables. With Robot, the script can get/set variable values from the DDVariableStore. With Rational Functional Tester, the custom script should follow this Script Javadoc. For Apple IOS, consult the SAFS IOS Developer's Guide.Supporting Engines:
scriptName
- Optional:NO
The name of the Script to execute.parameterName
- Optional:YES DefaultVal:AValue
One or more parameter values to send to the script--each in their own field.public static DriverCommand callScript(java.lang.String[] parameters)
Invoke a custom script with passed parameters/variables, if desired. Since the script is executed as a Driver Command and NOT a test; test_record, test_passes, and test_failures information within the status counters are not updated. For Rational Robot, if the called script wishes to record tests attempted, pass, and failure counts then it must do so itself by updating the ScriptStatusInfo fields accordingly. The name of the script must not include the file extension. Any number of parameters can be passed to the script. These parameters are passed as DDVariables and\or SAFSVARS variables. The variables and their values are available to the script and all of SAFS. These parameters are usually specific to each called script. The script can also set variable values for use by SAFS test tables. With Robot, the script can get/set variable values from the DDVariableStore. With Rational Functional Tester, the custom script should follow this Script Javadoc. For Apple IOS, consult the SAFS IOS Developer's Guide.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand callStep(java.lang.String stepName, java.lang.String stepSeparator, java.lang.String parameterName)
Invoke a Step table from within another Step table (from StepDriver). The command is only used at the Step level. You do not use this command within Suites or Cycles. Since the Step table is executed as a driver command by StepDriver and NOT as a CycleDriver or SuiteDriver test record, the call to the Step table itself is not counted as a test pass or a test fail.Supporting Engines:
stepName
- Optional:NO
The name of the StepTable to execute.stepSeparator
- Optional:YES DefaultVal:
The field separator used by the Step table--if required.parameterName
- Optional:YES DefaultVal:AValue
One or more parameter values to send to the table--each in their own field.public static DriverCommand callStep(java.lang.String[] parameters)
Invoke a Step table from within another Step table (from StepDriver). The command is only used at the Step level. You do not use this command within Suites or Cycles. Since the Step table is executed as a driver command by StepDriver and NOT as a CycleDriver or SuiteDriver test record, the call to the Step table itself is not counted as a test pass or a test fail.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand callSuite(java.lang.String suiteName, java.lang.String suiteSeparator, java.lang.String parameterName)
Invoke a Suite table (from StepDriver or SuiteDriver) You cannot use CallSuite in a CycleDriver test table. Since the Suite is executed as a driver command by SuiteDriver or StepDriver and NOT as a CycleDriver test record, the call to the Suite itself is not counted as a test pass or a test fail.Supporting Engines:
suiteName
- Optional:NO
The name of the Suite to execute.suiteSeparator
- Optional:YES DefaultVal:
The field separator used by the Suite--if required.parameterName
- Optional:YES DefaultVal:AValue
One or more parameter values to send to the suite--each in their own field.public static DriverCommand callSuite(java.lang.String[] parameters)
Invoke a Suite table (from StepDriver or SuiteDriver) You cannot use CallSuite in a CycleDriver test table. Since the Suite is executed as a driver command by SuiteDriver or StepDriver and NOT as a CycleDriver test record, the call to the Suite itself is not counted as a test pass or a test fail.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand callTestNG(java.lang.String testNGParameters)
Invoke TestNG tests using the provided TestNG parameters. If properly configured with SAFS RuntimeDataAwareness (dependency injection of SAFS Driver instances) the TestNG test has full access to all SAFS services including SAFS App Map data and SAFS Variable storage. TestNG tests can be intermixed with other SAFS tests.Supporting Engines:
testNGParameters
- Optional:NO
The parameters accepted by TestNG.public static DriverCommand exitCycle()
Exit the currently running Step, Suite, and/or Cycle table. Exit the currently running Step, Suite, and/or Cycle table. Generally called from Step or Suite Driver to exit or abort the entire Cycle test currently running. The Step or Suite table containing the command is exited. If an ExitTable processing block has been set by SetExitTableBlock then that block will be executed. Otherwise, the table will immediately exit. Any Suite and/or Cycle table that invoked the table will also be exited. If an ExitTable processing block has been set by SetExitTableBlock for the table then that block will be executed. Otherwise, the table will immediately exit.Supporting Engines:
public static DriverCommand exitSuite()
Exit the currently running Step and/or Suite table. Exit the currently running Step and/or Suite table. Generally only called from Step Driver to exit the current Step table AND the Suite that invoked it. The command should have no effect inside a Cycle table. The Step or Suite table containing the command is exited. If an ExitTable processing block has been set by SetExitTableBlock then that block will be executed. Otherwise, the table will immediately exit. If the table containing the command was a Step table, then the Suite that called the Step table will also be exited. If an ExitTable processing block has been set by SetExitTableBlock for the Suite, then that block will be executed. Otherwise, the Suite will immediately exit.Supporting Engines:
public static DriverCommand exitTable()
Exit the currently running Step, Suite, or Cycle table. Exit the currently running Step, Suite, or Cycle table. The table containing the command is exited. No other table is automatically exited because of this command. If an ExitTable processing block has been set by SetExitTableBlock then that block will be executed. Otherwise, the table will immediately exit.Supporting Engines:
public static DriverCommand gotoBlockID(java.lang.String blockID)
Goto a named block in the current table.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.public static DriverCommand onContainsGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block in the current table if value2 is contained within value1.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value to be searched for the Value2 substringvalue2
- Optional:NO
A string to search Value1 for an occurance ofcaseSensitive
- Optional:YES
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.
Comparisons are case-sensitive by default.public static DriverCommand onContainsGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value2 is contained within value1.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onDirectoryExistGotoBlockID(java.lang.String blockID, java.lang.String directoryName)
Goto the named block in the current table if the directory exists.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.directoryName
- Optional:NO
The directory name of the directory relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).public static DriverCommand onDirectoryExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the directory exists.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onDirectoryNotExistGotoBlockID(java.lang.String blockID, java.lang.String directoryName)
Goto the named block in the current table if the Directory does not exist.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.directoryName
- Optional:NO
The directory name relatvie to Datapool/Text of the directory to be verified for non existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).public static DriverCommand onDirectoryNotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the Directory does not exist.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onEqualGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block in the current table if two values are equal.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The first value for the comparison.value2
- Optional:NO
The second value for the comparison.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.
Comparisons are case-sensitive by default.public static DriverCommand onEqualGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if two values are equal.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onFileEOFGotoBlockID(java.lang.String blockID, java.lang.String fileNumber)
Goto the named block in the current table if the file is at EOF.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.fileNumber
- Optional:NO
The file number of the file to be verified for EOF.public static DriverCommand onFileEOFGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the file is at EOF.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onFileExistGotoBlockID(java.lang.String blockID, java.lang.String fileName)
Goto the named block in the current table if the file exists.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.fileName
- Optional:NO
The file name of the file relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).public static DriverCommand onFileExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the file exists.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onFileNotExistGotoBlockID(java.lang.String blockID, java.lang.String fileName)
Goto the named block in the current table if the file does not exist.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.fileName
- Optional:NO
The file name of the file relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).public static DriverCommand onFileNotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the file does not exist.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onGreaterThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block in the current table if value1 is greater than value2.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value to be compared.value2
- Optional:NO
The value to be compared against.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.
Comparisons are case-sensitive by default.public static DriverCommand onGreaterThanGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value1 is greater than value2.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onGUIExistsGotoBlockID(java.lang.String blockID, java.lang.String windowID, java.lang.String componentID, java.lang.String timeOut)
Goto the named block in the current table if a GUI component exists.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.windowID
- Optional:NO
A Window reference from the app map.componentID
- Optional:NO
A reference from the app map for the Component within the Window.timeOut
- Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically (no branch).public static DriverCommand onGUIExistsGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if a GUI component exists.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onGUINotExistGotoBlockID(java.lang.String blockID, java.lang.String windowID, java.lang.String componentID, java.lang.String timeOut)
Goto the named block in the current table if a GUI component does not exist.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.windowID
- Optional:NO
A Window reference from the app map.componentID
- Optional:NO
A reference from the app map for the Component within the Window.timeOut
- Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically (no branch).public static DriverCommand onGUINotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if a GUI component does not exist.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onInRangeGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String value3, java.lang.String caseSensitive)
Goto named block if value1 is between value2 and value3.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value to be compared.value2
- Optional:NO
The low end of range to be compared against.value3
- Optional:NO
The high end of range to be compared against.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive.
String Comparisons are case-sensitive by default.public static DriverCommand onInRangeGotoBlockID(java.lang.String[] parameters)
Goto named block if value1 is between value2 and value3.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onLessThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block if value1 is less than value2.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value to be compared.value2
- Optional:NO
The value to be compared against.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive.
String Comparisons are case-sensitive by default.public static DriverCommand onLessThanGotoBlockID(java.lang.String[] parameters)
Goto the named block if value1 is less than value2.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onMenuItemContainsStateGotoBlockID(java.lang.String blockID, java.lang.String windowName, java.lang.String componentName, java.lang.String menuItem, java.lang.String state)
Goto the named block in the current table if state is part of the state information of the menuitem.Supporting Engines:
blockID
- Optional:NO
The name of the block to transfer control to if state is
part of the state information of the menuitem.windowName
- Optional:NO
The window name.componentName
- Optional:NO
The component name.menuItem
- Optional:NO
Menu->MenuItem hierarchy string to identify which menu item to test. This menu hierarchy is case-sensitive.
to test. This menu hierarchy is case-sensitive.state
- Optional:NO
Expected status string (or part thereof) to verify.
Ex: "Enabled Checked" OR "Disabled Grayed" etc. Each item
separated by a space will be evaluated separately so the order
of the status items does not matter. These status items are
case-sensitive.public static DriverCommand onMenuItemContainsStateGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if state is part of the state information of the menuitem.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onNotContainsGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block in the current table if value2 is NOT a substring of value1.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value to be searched for the Value2 substringvalue2
- Optional:NO
The substring to seek in VALUE1caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.
Comparisons are case-sensitive by default.public static DriverCommand onNotContainsGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value2 is NOT a substring of value1.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onNotEqualGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block in the current table if two values are not equal.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The first value for the comparison.value2
- Optional:NO
The second value for the comparison.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive.
String Comparisons are case-sensitive by default.public static DriverCommand onNotEqualGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if two values are not equal.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onNotGreaterThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block in the current table if value1 is NOT greater than value2.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value expected to be NOT greater than VALUE2.value2
- Optional:NO
The value expected to be equal or greater than VALUE1.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.
Comparisons are case-sensitive by default.public static DriverCommand onNotGreaterThanGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value1 is NOT greater than value2.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onNotInRangeGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String value3, java.lang.String caseSensitive)
Goto the named block in the current table if value1 is not between value2 and value3.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value to be compared.value2
- Optional:NO
The low end of range to be compared against.value3
- Optional:NO
The high end of range to be compared against.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive.
String Comparisons are case-sensitive by default.public static DriverCommand onNotInRangeGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if value1 is not between value2 and value3.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onNotLessThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive)
Goto the named block if value1 is NOT less than value2.Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.value1
- Optional:NO
The value that should be NOT less than VALUE2.value2
- Optional:NO
The value that should be equal or less than VALUE1.caseSensitive
- Optional:YES
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive.
String Comparisons are case-sensitive by default.public static DriverCommand onNotLessThanGotoBlockID(java.lang.String[] parameters)
Goto the named block if value1 is NOT less than value2.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onPartialMenuItemContainsStateGotoBlockID(java.lang.String blockID, java.lang.String windowName, java.lang.String componentName, java.lang.String menuItem, java.lang.String state)
Goto the named block in the current table if state is part of the state information of the menuitem. This command allows for a partial match of the menu item.Supporting Engines:
blockID
- Optional:NO
The name of the block to transfer control to if state is
part of the state information of the menuitem.windowName
- Optional:NO
The window name.componentName
- Optional:NO
The component name.menuItem
- Optional:NO
Menu->MenuItem hierarchy string to identify which menu item to test. This menu hierarchy is case-sensitive.
to test. This menu hierarchy is case-sensitive.state
- Optional:NO
Expected status string (or part thereof) to verify.
Ex: "Enabled Checked" OR "Disabled Grayed" etc. Each item
separated by a space will be evaluated separately so the order
of the status items does not matter. These status items are
case-sensitive.public static DriverCommand onPartialMenuItemContainsStateGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if state is part of the state information of the menuitem. This command allows for a partial match of the menu item.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onRegistryKeyExistGotoBlockID(java.lang.String blockID, java.lang.String key, java.lang.String keyValue, java.lang.String timeOut)
Goto the named block in the current table if the Registry Key exists. On Windows XP (and higher?) this is accomplished via the REG.EXE provided by the operating system. If this program is NOT available then the Registry commands will not work until another means is implemented--possibly Windows Scripting Host scripts, etc..Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.key
- Optional:NO
The Registry Key to seek.keyValue
- Optional:YES
The optional Registry subkey value to seek.timeOut
- Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically (no branch).public static DriverCommand onRegistryKeyExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the Registry Key exists. On Windows XP (and higher?) this is accomplished via the REG.EXE provided by the operating system. If this program is NOT available then the Registry commands will not work until another means is implemented--possibly Windows Scripting Host scripts, etc..Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand onRegistryKeyNotExistGotoBlockID(java.lang.String blockID, java.lang.String key, java.lang.String keyValue, java.lang.String timeOut)
Goto the named block in the current table if the Registry Key does not exist. On Windows XP (and higher?) this is accomplished via the REG.EXE provided by the operating system. If this program is NOT available then the Registry commands will not work until another means is implemented--possibly Windows Scripting Host scripts, etc..Supporting Engines:
blockID
- Optional:NO
The name of the block to Goto.key
- Optional:NO
The Registry Key to seek.keyValue
- Optional:YES
The optional Registry subkey value to seek.timeOut
- Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically (no branch).public static DriverCommand onRegistryKeyNotExistGotoBlockID(java.lang.String[] parameters)
Goto the named block in the current table if the Registry Key does not exist. On Windows XP (and higher?) this is accomplished via the REG.EXE provided by the operating system. If this program is NOT available then the Registry commands will not work until another means is implemented--possibly Windows Scripting Host scripts, etc..Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public static DriverCommand setExitTableBlock(java.lang.String blockID)
Set or clear the name of a block to execute when the ExitTable command is encountered. Set or clear the name of a block to execute when the ExitTable command is encountered. You can reset this to nothing by leaving the BlockID parameter blank or providing an empty BlockID. This reset should be done as part of the ExitTable processing.Supporting Engines:
blockID
- Optional:YES DefaultVal:
The name of the block to Goto when ExitTable is encountered.public static DriverCommand setGeneralScriptFailureBlock(java.lang.String blockID)
Set or clear the name of a block to execute when GeneralScriptFailure occurs. Set or clear the name of a block to execute when GeneralScriptFailure occurs. Status is evaluated after the completion of every record in a table. You can reset this to nothing by leaving the BlockID parameter blank or providing an empty BlockID.Supporting Engines:
blockID
- Optional:YES DefaultVal:
The name of the block to Goto on status GeneralScriptFailure.public static DriverCommand setInvalidFileIOBlock(java.lang.String blockID)
Set or clear the name of a block to execute when InvalidFileIO occurs. Set or clear the name of a block to execute when InvalidFileIO occurs. Status is evaluated after the completion of every record in a table. You can reset this to nothing by leaving the BlockID parameter blank or providing an empty BlockID. Note, an InvalidFileIO generated from the test table itself will not be processed by this block. In general, that would not be possible because the FileIO error likely means the table cannot be processed.Supporting Engines:
blockID
- Optional:YES DefaultVal:
The name of the block to Goto on status InvalidFileIO.public static DriverCommand setNoScriptFailureBlock(java.lang.String blockID)
Set or clear the name of a block to execute when NoScriptFailure occurs. Set or clear the name of a block to execute when NoScriptFailure occurs. Status is evaluated after the completion of every record in a table. So event the simple logging of message can return NoScriptFailure. This block setting is automatically cleared when a jump is executed as a result of this condition. This command is generally used immediately before the record you expect to pass or fail. You can reset this to nothing by leaving the BlockID parameter blank or providing an empty BlockID.Supporting Engines:
blockID
- Optional:YES DefaultVal:
The name of the block to Goto on status NoScriptFailure.public static DriverCommand setScriptNotExecutedBlock(java.lang.String blockID)
Set or clear the name of a block to execute when ScriptNotExecuted occurs. Set or clear the name of a block to execute when ScriptNotExecuted occurs. Status is evaluated after the completion of every record in a table. In general, ScriptNotExecuted only occurs when the drivers are not able to be invoked or StepDriver cannot properly locate GUI items or the functions to process them. You can reset this to nothing by leaving the BlockID parameter blank or providing an empty BlockID.Supporting Engines:
blockID
- Optional:YES DefaultVal:
The name of the block to Goto on status ScriptNotExecuted.public static DriverCommand setScriptWarningBlock(java.lang.String blockID)
Set or clear the name of a block to execute when ScriptWarning occurs. Set or clear the name of a block to execute when ScriptWarning occurs. Status is evaluated after the completion of every record in a table. You can reset this to nothing by leaving the BlockID parameter blank or providing an empty BlockID.Supporting Engines:
blockID
- Optional:YES DefaultVal:
The name of the block to Goto on status ScriptWarning.public static DriverCommand useLocalFlowControl(java.lang.String state)
When TRUE then flow control block IDs have current table scope only. By default, flow control block IDs provided with the SetXXXBlock commands have test level scope. That is, a block ID set stays in effect for all test tables at that test level until the block ID is changed or cleared. By setting UseLocalFlowControl=TRUE then any flow control block ID set has only local scope. It is only valid for the currently executing table. Note, if no parameter is provided the parameter will default to TRUE.Supporting Engines:
state
- Optional:YES DefaultVal:TRUE
The TRUE or FALSE value to use.Copyright © SAS Institute. All Rights Reserved.