TestStepProcessor (SAFS API DOCUMENT)

java.lang.Object
- org.safs.Processor
- - org.safs.TestStepProcessor

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

DTestStepProcessor, ITestStepProcessor, JVMAgentTestStepProcessor, WDTestStepProcessor
```
public class TestStepProcessor
extends Processor
```
Purpose: TestStepProcessor
Lifetime: instantiated by ProcessRequest

Since:

JUN 04, 2003
AUG 06, 2003 (DBauman)Original Release
SEP 10, 2003 (Carl Nagle) Removed WARNING messages for cases "not implemented"
SEP 16, 2003 (Carl Nagle) Implemented use of new SAFSLOGS logging.
NOV 04, 2003 (Carl Nagle) Modified .process engine failures from GENERAL_FAILURES to SCRIPT_NOT_EXECUTED so that other engines (like Classic) can attempt to execute the record.
NOV 05, 2003 (Carl Nagle) .process will now catch and report RuntimeExceptions.
NOV 10, 2003 (Carl Nagle) Added isSupportedRecordType() implementation.
NOV 14, 2003 (DBauman/Carl Nagle) Added support for breakpoints.
NOV 19, 2003 (Carl Nagle) Additional refactoring.
FEB 04, 2004 (DBauman)Copy the status code to variable 'customStatusCode'.
FEB 12, 2004 (BNat) Added the Throwable catch block. This throwable catch block takes care of anything higher than Exceptions i.e. Error and Throwable.
NOV 11, 2004 (Carl Nagle) Removed special handling of ClickLinkBeginning\Containing
MAR 21, 2005 (Carl Nagle) Allow instantiation of Default Comp Function class when compType=null
MAR 03, 2009 (Carl Nagle) Issue Failure instead of "Unknown Command" when Comp is not found in waitForObject.
APR 08, 2010 (Lei Wang)Modify method process(): 1. Treat the mixed mode RS. 2. Move out some logics to methods. Add methods waitForObject(), statusIsOK() and setActiveWindow(): contain some logics moved from method process().
SEP 26, 2014 (Lei Wang)Rename method statusIsOK() to waitForObjectAndCheck(): if object cannot be found and there are more engines to try, the give them a chance.
AUG 05, 2016 (Lei Wang)Modified waitForObjectAndCheck(): if the waitForObject's rc is SCRIPT_NOT_EXECUTED (4), then set the testrecord's status to SCRIPT_NOT_EXECUTED.
SEP 27, 2017 (Carl Nagle) Modify TSP to support SAFS REST for ALL frameworks (including SeleniumPlus)
SEP 28, 2017 (Lei Wang) Modify process(): Delay REST check to WebDriverGUIUtilities.waitForObject(), so it will only affect Selenium-webdriver's engine
SEP 28, 2017 (Carl Nagle) Removing some of my SEP 27 code that now provides no function.

Author:

Doug Bauman

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`cfBreakpointsOn` All instances may enable/disable and force breakpoints where they deem this appropriate.
`static java.lang.String`	`DEFAULT_TEST_STEP_CLASSNAME` DEFAULT_TEST_STEP_PREFIX +"Component" Short classname appended to alternative/custom package names.
`static java.lang.String`	`DEFAULT_TEST_STEP_PREFIX` "CF" Default prefix for short classname for test step processors.

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

TestStepProcessor()

Purpose: constructor, calls super

Constructors
Constructor and Description
`TestStepProcessor()` Purpose: constructor, calls super

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkMyBreakpoints(java.lang.String breakpoint_message)` test for enabled CF-specific breakpoints in addition to the standard Processor breakpoints.
`protected void`	`componentFailureMessage(java.lang.String detail)` Purpose: log a standard component function FAILED_MESSAGE with detail.
`protected void`	`componentWarningMessage(java.lang.String detail)` Purpose: log a standard component function WARNING_MESSAGE with detail.
`protected java.lang.String`	`getComponentProcClassName()` Assumes the stored procInstancePath identifies a package name in which to locate the "CFComponent" class.
`java.util.ArrayList`	`getCustomProcClassNames()` Overrides Processor.getCustomProcClassName Calls the super method to first see if the user has already specified a full path name for any custom Driver Command Processor.
`java.util.ArrayList`	`getProcClassNames()` Overrides Processor.getProcClassNames Calls the super method to first see if the user has already specified a full path name for the Test Step Processor.
`protected boolean`	`getWinAndCompGUIObjects()` Called internally or overridden by subclasses to find the windowObject and compObjects.
`protected boolean`	`instantiateComponentFunction(java.util.Collection params)` Purpose: This is where we call the component functions declared at the top in the ComponentFunctions DECLARATION section.
`protected java.util.Collection`	`interpretFields()` Purpose: Interprets the fields of the test record and puts the appropriate values into the fields of testRecordData.
`static boolean`	`isCFBreakpointsOn()` test if CF-specific breakpoints are enabled.
`boolean`	`isSupportedRecordType(java.lang.String recordType)` Supports standard TEST STEP record types (T, TW, TF)
`protected void`	`postProcess()` A place to perform operations AFTER we have finished processing the record but before we return from the process function.
`void`	`process()` Purpose: process: process the testRecordData
`protected boolean`	`setActiveWindow()` Note: This method will make the top window to become the active window.
`static void`	`setCFBreakpointsOn(boolean enabled)` This may be set by any means.
`protected int`	`waitForObject(boolean isWindow)` Wait for the window/component occur.
`protected boolean`	`waitForObjectAndCheck(boolean isWindow)` Wait for the window/component to occur, and check if window/component can be found or not. If the window/component can not be found: if there are more engines available then log warning and set status-code to "NotExecuted". if the return-code of waitForObject() is 'SCRIPT_NOT_EXECUTED' then set status-code to "NotExecuted" so that more engine will be tried. otherwise log error and set status-code to "Failure".

Methods inherited from class org.safs.Processor
activateBreakpoint, checkBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAlternateParams, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcInstancePath, getLogUtilities, getParams, 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
  - DEFAULT_TEST_STEP_PREFIX
```
public static final java.lang.String DEFAULT_TEST_STEP_PREFIX
```
    "CF" Default prefix for short classname for test step processors.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TEST_STEP_CLASSNAME
```
public static final java.lang.String DEFAULT_TEST_STEP_CLASSNAME
```
    DEFAULT_TEST_STEP_PREFIX +"Component" Short classname appended to alternative/custom package names. This is for dynamic instancing of Test Step processors.
    
    See Also:
    
    Constant Field Values
  - cfBreakpointsOn
```
protected static boolean cfBreakpointsOn
```
    All instances may enable/disable and force breakpoints where they deem this appropriate. The static setting is shared by all our instances. By default, our breakpoints are disabled. However, a check is done for the global Processor.isBreakpoints enabled which overrides this setting. our breakpoints can be enabled separately when all other global breakpoints are disabled.
- Constructor Detail
  - TestStepProcessor
```
public TestStepProcessor()
```
    Purpose: constructor, calls super
- Method Detail
  - setCFBreakpointsOn
```
public static void setCFBreakpointsOn(boolean enabled)
```
    This may be set by any means. In a runtime debugging environment this will likely be set by a Driver Command.
  - isCFBreakpointsOn
```
public static boolean isCFBreakpointsOn()
```
    test if CF-specific breakpoints are enabled.
    
    Returns:
    
    true if cfBreakpointsOn is true.
  - checkMyBreakpoints
```
protected void checkMyBreakpoints(java.lang.String breakpoint_message)
```
    test for enabled CF-specific breakpoints in addition to the standard Processor breakpoints. Overrides Process.checkMyBreakpoints.
    
    Overrides:
    
    checkMyBreakpoints in class Processor
  - isSupportedRecordType
```
public boolean isSupportedRecordType(java.lang.String recordType)
```
    Supports standard TEST STEP record types (T, TW, TF)
    
    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.
  - getProcClassNames
```
public java.util.ArrayList getProcClassNames()
```
    Overrides Processor.getProcClassNames Calls the super method to first see if the user has already specified a full path name for the Test Step Processor. If not, this routine then assumes the stored procInstancePath identifies a package name in which to locate the "CFcompType" class.
    The routine returns a list of:
    super.getProcClassNames procInstancePath.CFcompType
    Use validProcessorClassName before adding class names to the list.
    
    Overrides:
    
    getProcClassNames in class Processor
    
    Returns:
    
    a list of potential processor classnames to try.
  - getCustomProcClassNames
```
public java.util.ArrayList getCustomProcClassNames()
```
    Overrides Processor.getCustomProcClassName Calls the super method to first see if the user has already specified a full path name for any custom Driver Command Processor. If not, this routine then assumes the stored customProcInstancePath identifies a package name in which to locate the custom "CFComponent" class.
    The routine returns a list of:
    super.getCustomProcClassNames customProcInstancePath.CFComponent customProcInstancePath.custom.CFComponent
    Use validProcessorClassName before adding class names to the list.
    
    Overrides:
    
    getCustomProcClassNames in class Processor
    
    Returns:
    
    a valid classname for the Processor or null.
  - getComponentProcClassName
```
protected java.lang.String getComponentProcClassName()
```
    Assumes the stored procInstancePath identifies a package name in which to locate the "CFComponent" class. This is normally only called if processing for specific component types has already failed.
    The routine returns a String of:
    procInstancePath.CFComponent
    
    Returns:
    
    a valid classname for the Processor or null.
  - getWinAndCompGUIObjects
```
protected boolean getWinAndCompGUIObjects()
                                   throws SAFSException
```
    Called internally or overridden by subclasses to find the windowObject and compObjects.
    This routine is called only after all MixedUse recognition strings have separately been handled. This routine is called only after all non-GUI commands have separately been handled. This routine is only called if it has been determined we have a "normal" GUI command in which OBT window and component objects need to be found.
    Found windowObjects will also have setActiveWindow invoked.
    
    Returns:
    
    Throws:
    
    SAFSException
  - process
```
public void process()
```
    Purpose: process: process the testRecordData
    At this point the Driver has determined we are dealing with a Test Record. A Test Record is one acting on a window or a component within a window.
    Field #1: The TEST record type (T).
    Subsequent fields would be as follows (with a separator between each field): Field: #2 #3 #4 #5 - N ============== ============== ======== =============== WINDOWNAME, COMPONENTNAME, ACTION, [PARAMETER(S),]
    WINDOWNAME is the name given the window in the appmap that you intend to have focus for this test step.
    COMPONENTNAME is the name of the component within that window you intend to perform some function or test on. If it is the window itself then the COMPONENTNAME should be the same as the WINDOWNAME.
    ACTION is the command or test you wish to perform. Different types of components support different types of actions. Almost all support some versions of VERIFY actions. Pushbuttons can be CLICKed etc... Consult each Component's TYPE or CLASS documentation for the actions available for the component.
    PARAMETER(s) are the additional fields needed based upon the action to be completed. Each action can have its own unique set of parameters. Some actions may take no parameters at all. Consult the component's TYPE or CLASS documentation for the parameters needed for a given action.
    Although the separator used in the example above is a comma, any separator can be used as long as it is specified at the time the file is provided or in subsequent command lines which might change the separator in use. (Currently, changes are limited to a per file bases, but per line changes will be easy to implement when the need arises.)
    The test record is processed out to functions according to the "Type" of the component in the record. Thus, components of Type=Window are sent to WindowFunctions and components of Type=Pushbutton are sent to PushbuttonFunctions. Currently, some Types of Generic, Other, and other oddities are processed out to Window or GenericObjectFunctions. This will allow some property verifications and maybe some image testcases but probably not too much else.
    ?? Some special handling occurs for certain Java components. In the event the compType, compModule, and compClass are ALL "Unknown"; we perform a check to see if "Java" appears anywhere in the recognition method provided by the user for the component. If it does, then we attempt to extract the component type out of the recognition method using the last "Type=" part of the string. If this is successful, we will then set the compType to that component type and set the compModule to "Java". This enables us to try and process Java components to the correct ComponentFunction even though Robot does not seem to properly recognize the type of component it is dealing with.
    ?? Popup menus are not of a real Component Type. The action commands for Popup menus are intercepted here and routed to the PopupMenuFunctions without doing the normal processing and verification of window and child objects. This is required due to the special nature of Popup menus and how they are handled by the operating system.
    ?? The same holds true for DatabaseFunctions. They are intercepted here and routed accordingly. (BETA)
    NOTE: A user or developer would not normally call this routine. This routine is intended to be called from the StepDriver routine as deemed necessary by the input records of the data table provided to the StepDriver routine. The internals of this routine and the declaration and parameters are all subject to change as necessary.
    Side Effects: Processor.testRecordData statusCode is set based on the result of the processing
    State Read: Processor.testRecordData
    Assumptions: Various exceptions are caught here, and if so, the status code is set to StatusCodes.SCRIPT_NOT_EXECUTED and a WARNING message is logged.
    Added by dbauman Feb, 2004 so that a variable remains for the next test with the status code. Copies the status code to variable 'customStatusCode'
    Carl Nagle added REST diversion to TIDComponents.
    Carl Nagle removing code previously delaying REST diversion to TIDComponents.
    
    Overrides:
    
    process in class Processor
  - waitForObject
```
protected int waitForObject(boolean isWindow)
                     throws SAFSException
```
    Wait for the window/component occur.
    
    Parameters:
    
    isWindow - boolean. If true, waiting for window object; otherwise waiting for component object.
    
    Returns:
    
    int 0 represents the waiting status is ok.
    
    Throws:
    
    SAFSException
    
    See Also:
    
    #waitForObjectAndCheck(boolean)}
  - waitForObjectAndCheck
```
protected boolean waitForObjectAndCheck(boolean isWindow)
                                 throws SAFSException
```
    Wait for the window/component to occur, and check if window/component can be found or not.
    If the window/component can not be found:
    if there are more engines available then log warning and set status-code to "NotExecuted".
    if the return-code of waitForObject() is 'SCRIPT_NOT_EXECUTED' then set status-code to "NotExecuted" so that more engine will be tried.
    otherwise log error and set status-code to "Failure".
    
    Parameters:
    
    isWindow - boolean If true, the status is for window object; otherwise for component object.
    
    Returns:
    
    boolean true, if the window/component can be found.
    
    Throws:
    
    SAFSException
    
    See Also:
    
    #waitForObject(boolean)}
  - setActiveWindow
```
protected boolean setActiveWindow()
                           throws SAFSException
```
    Note: This method will make the top window to become the active window.
    
    Returns:
    
    boolean If the window becomes active, return true.
    
    Throws:
    
    SAFSException
  - postProcess
```
protected void postProcess()
```
    A place to perform operations AFTER we have finished processing the record but before we return from the process function. This can be overridden by subclasses.
    added by dbauman Feb, 2004 so that a variable remains for the next test with the status code. copy the status code to variable 'customStatusCode'
  - interpretFields
```
protected java.util.Collection interpretFields()
                                        throws SAFSException
```
    Purpose: Interprets the fields of the test 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 TEST record type (T).
    Subsequent fields would be as follows (with a separator between each field): Field: #2 #3 #4 #5 - N ============== ============== ======== =============== WINDOWNAME, COMPONENTNAME, ACTION, [PARAMETER(S),]
    
    Returns:
    
    Collection of the parameter(s)
    
    Throws:
    
    SAFSException
  - instantiateComponentFunction
```
protected boolean instantiateComponentFunction(java.util.Collection params)
                                        throws SAFSException
```
    Purpose: This is where we call the component functions declared at the top in the ComponentFunctions DECLARATION section. When new components are coded for recognition by this engine the declaration must be made in that section and the call to them must be added here.
    Side Effects:
    State Read: Processor.testRecordData
    Assumptions: uses Class.forName to instantiate, catches all exceptions
    Assumes that the qualified name of the component begins with org.safs.rational.CF
    So a tree would be class org.safs.raional.CFTree (where the compType was Tree).
    Note that the path is derived from testRecordData.getCompInstancePath() + "CF"+ compType, so the actual path can vary based on what the actual return value of that is.
    IF no class is found for the compType, then the generic version is instead instantiated if possible: CFComponent is the generic type, try that before giving up...
    Finally, we make use of a HashMap of components already instantiated, and reuse them if possible, so that we do not have to incurr the cost of instantiating over and over again. field: '#functionMap'
    NOTE: a custom type can be defined by placing it into a package like: org.safs.rational.custom (that is tried second)
    
    Parameters:
    
    params, - Collection
    
    Returns:
    
    specific ComponentFunction instance, null if none found
    
    Throws:
    
    SAFSException
  - componentFailureMessage
```
protected void componentFailureMessage(java.lang.String detail)
```
    Purpose: log a standard component function FAILED_MESSAGE with detail. Expects testRecordData to already have filename, lineNumber, compName, and command.
  - componentWarningMessage
```
protected void componentWarningMessage(java.lang.String detail)
```
    Purpose: log a standard component function WARNING_MESSAGE with detail. Expects testRecordData to already have filename, lineNumber, compName, and command.

Class TestStepProcessor

Field Summary

Fields inherited from class org.safs.Processor

Constructor Summary

Method Summary

Methods inherited from class org.safs.Processor

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TEST_STEP_PREFIX

DEFAULT_TEST_STEP_CLASSNAME

cfBreakpointsOn

Constructor Detail

TestStepProcessor

Method Detail

setCFBreakpointsOn

isCFBreakpointsOn

checkMyBreakpoints

isSupportedRecordType

getProcClassNames

getCustomProcClassNames

getComponentProcClassName

getWinAndCompGUIObjects

process

waitForObject

waitForObjectAndCheck

setActiveWindow

postProcess

interpretFields

instantiateComponentFunction

componentFailureMessage

componentWarningMessage