org.safs.tools.engines

Class TIDDriverCommands

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.TIDDriverCommands

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface

public class TIDDriverCommands
extends GenericEngine

Provides local in-process support for Driver Commands.Data

These are Driver Commands generally needed exclusively by the Driver to perform Driver-specific functions, or to configure the various engines. This is just a subset of all Driver Commands generally available.

This DriverCommands engine does not assume the use of STAF. Instead, it uses the various org.safs.tools Interfaces to talk with the rest of the framework (as made available via the DriverInterface configuration).

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	ABBOT_ENGINE "SAFSABBOT"
(package private) java.lang.String	command
(package private) static java.lang.String	COMMAND_CLOSEAPPLICATIONMAP "CloseApplicationMap"
(package private) static java.lang.String	COMMAND_EXPRESSIONS "Expressions"
(package private) static java.lang.String	COMMAND_SENDEMAIL SendEmail
(package private) static java.lang.String	COMMAND_SETAPPLICATIONMAP "SetApplicationMap"
static java.lang.String	COMMAND_SETBENCHDIRECTORY "SetBenchDirectory"
static java.lang.String	COMMAND_SETDIFDIRECTORY "SetDifDirectory"
static java.lang.String	COMMAND_SETIMAGEDEBUG "SetImageDebug"
static java.lang.String	COMMAND_SETIMAGEFUZZYMATCHING "SetImageFuzzyMatching"
static java.lang.String	COMMAND_SETPROJECTDIRECTORY "SetProjectDirectory"
static java.lang.String	COMMAND_SETROOTVERIFYDIRECTORY "SetRootVerifyDirectory"
static java.lang.String	COMMAND_SETTESTDIRECTORY "SetTestDirectory"
(package private) static java.lang.String	COMMAND_SETVARIABLEVALUES "SetVariableValues"
(package private) static java.lang.String	COMMAND_TAKESCREENSHOT TakeScreenShot
(package private) static java.lang.String	COMMAND_USEABBOTFUNCTIONS UseABBOTFunctions
(package private) static java.lang.String	COMMAND_USEDROIDFUNCTIONS UseDroidFunctions
(package private) static java.lang.String	COMMAND_USEIOSFUNCTIONS UseIOSFunctions
(package private) static java.lang.String	COMMAND_USEQTPFUNCTIONS UseQTPFunctions
(package private) static java.lang.String	COMMAND_USEROBOTJFUNCTIONS "UseRobotJFunctions"
(package private) static java.lang.String	COMMAND_USESAFSFUNCTIONS UseSAFSFunctions
(package private) static java.lang.String	COMMAND_USESELENIUMFUNCTIONS UseSeleniumFunctions
(package private) static java.lang.String	COMMAND_USETESTCOMPLETEFUNCTIONS UseTestCompleteFunctions
(package private) static java.lang.String	COMMAND_VERSION "Version"
static java.lang.String	COMMAND_WAITFORGUI "WaitForGUI"
static java.lang.String	COMMAND_WAITFORGUIGONE "WaitForGUIGone"
(package private) TIDDriverCounterCommands	dcCounters
(package private) TIDDriverFlowCommands	dcFlow
(package private) TIDDriverLogCommands	dcLog
(package private) TIDDriverRestCommands	dcRest
(package private) java.lang.String	detail
(package private) static java.lang.String	DROID_ENGINE "SAFSDROID"
(package private) static java.lang.String	ENGINE_NAME "SAFS/TIDDriverCommands"
static java.lang.String	GET_MILLIS_BETWEEN_RECORDS
(package private) static java.lang.String	IOS_ENGINE "SAFSIOS"
(package private) java.lang.String	message
(package private) static java.lang.String	QTP_ENGINE "SAFSQTP"
(package private) static java.lang.String	ROBOTJ_ENGINE "SAFSROBOTJ"
(package private) static java.lang.String	SDC_ENGINE "SAFSDRIVERCOMMANDS"
(package private) static java.lang.String	SELENIUM_ENGINE "SAFSSELENIUM"
static java.lang.String	SET_MILLIS_BETWEEN_RECORDS
static java.lang.String	SETMULTIPLETHREADSEARCH
(package private) static java.lang.String	TCAFS_ENGINE "SAFSTC"

Fields inherited from class org.safs.tools.engines.GenericEngine

console, process, testRecordData, testrecordStackable

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

config, customStr, customText, debugStr, debugText, driver, DRIVER_TEMP_PROCESS, failedStr, failedText, genericStr, genericText, launchCount, log, machine, otherStr, otherText, passedStr, passedText, processName, running, SAFS_RESBUN_NAME, servicename, shutdownCount, staf, STAFPROC_EXE, warningStr, warningText, weStartedService, weStartedSTAF

Fields inherited from interface org.safs.tools.engines.EngineInterface

COMMAND_SHUTDOWN_HOOK

Constructor Summary

Constructors

Constructor and Description
TIDDriverCommands() Constructor for TIDDriverCommands
TIDDriverCommands(DriverInterface driver) PREFERRED Constructor for TIDDriverCommands.
TIDDriverCommands(LogUtilities log) Instantiate a new TIDDriverCommands, Call setLogUtilities() of its super class for itself and its inner TID engines like Log, Flow, Counter TIDEngines. Normally, we should instantiate an object of this class with a driver.

Method Summary

Modifier and Type	Method and Description
void	launchInterface(java.lang.Object configInfo) Typically expects a DriverInterface object for initialization.
long	processRecord(TestRecordHelper testRecordData) Process the record present in the provided testRecordData.
void	setLogUtilities(LogUtilities log) Calls super.setLogUtilities for this class and then setLogUtilities for each chained processor in this class (dcLog, dcFlow, dcCounters, dcRest).
void	setLogUtilities(LogUtilities log, boolean copyLogClass) Calls super.setLogUtilities for this class and then setLogUtilities for each chained processor in this class (dcLog, dcFlow, dcCounters, dcRest).
protected long	takeScreenShot()

Methods inherited from class org.safs.tools.engines.GenericEngine

deduceBenchFile, deduceProjectFile, deduceTestFile, getAppMapItem, getEngineName, getVariable, isToolRunning, logMessage, makeQuotedPath, makeQuotedString, popTestRecord, postShutdownServiceDelay, pushTestRecord, reset, resetShutdownSemaphore, saveTestRecordScreenToTestDirectory, setTRDStatus, setVariable, shutdownService, waitHookShutdownAndReset

Methods inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

configureJSTAFServiceEmbeddedJVMOption, extendedGenericMessage, finalize, getCoreInterface, getEmbeddedJVMBinPath, getSTAFHelper, logMessage, shutdown, simpleGenericMessage, simpleGenericSuccessMessage, simpleGenericWarningMessage, simpleSuccessMessage, simpleSuccessMessage, simpleSuccessUsingMessage, standardErrorMessage, waitForServiceStartCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.tools.GenericToolsInterface

getCoreInterface, shutdown

Field Detail

ENGINE_NAME

static final java.lang.String ENGINE_NAME

"SAFS/TIDDriverCommands"

See Also:

Constant Field Values

ROBOTJ_ENGINE

static final java.lang.String ROBOTJ_ENGINE

"SAFSROBOTJ"

See Also:

Constant Field Values

SDC_ENGINE

static final java.lang.String SDC_ENGINE

"SAFSDRIVERCOMMANDS"

See Also:

Constant Field Values

IOS_ENGINE

static final java.lang.String IOS_ENGINE

"SAFSIOS"

See Also:

Constant Field Values

QTP_ENGINE

static final java.lang.String QTP_ENGINE

"SAFSQTP"

See Also:

Constant Field Values

ABBOT_ENGINE

static final java.lang.String ABBOT_ENGINE

"SAFSABBOT"

See Also:

Constant Field Values

TCAFS_ENGINE

static final java.lang.String TCAFS_ENGINE

"SAFSTC"

See Also:

Constant Field Values

SELENIUM_ENGINE

static final java.lang.String SELENIUM_ENGINE

"SAFSSELENIUM"

See Also:

Constant Field Values

DROID_ENGINE

static final java.lang.String DROID_ENGINE

"SAFSDROID"

See Also:

Constant Field Values

COMMAND_SETAPPLICATIONMAP

static final java.lang.String COMMAND_SETAPPLICATIONMAP

"SetApplicationMap"

See Also:

Constant Field Values

COMMAND_SETVARIABLEVALUES

static final java.lang.String COMMAND_SETVARIABLEVALUES

"SetVariableValues"

See Also:

Constant Field Values

COMMAND_CLOSEAPPLICATIONMAP

static final java.lang.String COMMAND_CLOSEAPPLICATIONMAP

"CloseApplicationMap"

See Also:

Constant Field Values

COMMAND_EXPRESSIONS

static final java.lang.String COMMAND_EXPRESSIONS

"Expressions"

See Also:

Constant Field Values

COMMAND_VERSION

static final java.lang.String COMMAND_VERSION

"Version"

See Also:

Constant Field Values

COMMAND_USEROBOTJFUNCTIONS

static final java.lang.String COMMAND_USEROBOTJFUNCTIONS

"UseRobotJFunctions"

See Also:

Constant Field Values

COMMAND_USESAFSFUNCTIONS

static final java.lang.String COMMAND_USESAFSFUNCTIONS

UseSAFSFunctions

See Also:

Constant Field Values

COMMAND_USETESTCOMPLETEFUNCTIONS

static final java.lang.String COMMAND_USETESTCOMPLETEFUNCTIONS

UseTestCompleteFunctions

See Also:

Constant Field Values

COMMAND_USEIOSFUNCTIONS

static final java.lang.String COMMAND_USEIOSFUNCTIONS

UseIOSFunctions

See Also:

Constant Field Values

COMMAND_USEQTPFUNCTIONS

static final java.lang.String COMMAND_USEQTPFUNCTIONS

UseQTPFunctions

See Also:

Constant Field Values

COMMAND_USEABBOTFUNCTIONS

static final java.lang.String COMMAND_USEABBOTFUNCTIONS

UseABBOTFunctions

See Also:

Constant Field Values

COMMAND_USESELENIUMFUNCTIONS

static final java.lang.String COMMAND_USESELENIUMFUNCTIONS

UseSeleniumFunctions

See Also:

Constant Field Values

COMMAND_USEDROIDFUNCTIONS

static final java.lang.String COMMAND_USEDROIDFUNCTIONS

UseDroidFunctions

See Also:

Constant Field Values

COMMAND_TAKESCREENSHOT

static final java.lang.String COMMAND_TAKESCREENSHOT

TakeScreenShot

See Also:

Constant Field Values

COMMAND_SENDEMAIL

static final java.lang.String COMMAND_SENDEMAIL

SendEmail

See Also:

Constant Field Values

COMMAND_SETBENCHDIRECTORY

public static final java.lang.String COMMAND_SETBENCHDIRECTORY

"SetBenchDirectory"

See Also:

Constant Field Values

COMMAND_SETDIFDIRECTORY

public static final java.lang.String COMMAND_SETDIFDIRECTORY

"SetDifDirectory"

See Also:

Constant Field Values

COMMAND_SETPROJECTDIRECTORY

public static final java.lang.String COMMAND_SETPROJECTDIRECTORY

"SetProjectDirectory"

See Also:

Constant Field Values

COMMAND_SETTESTDIRECTORY

public static final java.lang.String COMMAND_SETTESTDIRECTORY

"SetTestDirectory"

See Also:

Constant Field Values

COMMAND_SETROOTVERIFYDIRECTORY

public static final java.lang.String COMMAND_SETROOTVERIFYDIRECTORY

"SetRootVerifyDirectory"

See Also:

Constant Field Values

COMMAND_WAITFORGUI

public static final java.lang.String COMMAND_WAITFORGUI

"WaitForGUI"

See Also:

Constant Field Values

COMMAND_WAITFORGUIGONE

public static final java.lang.String COMMAND_WAITFORGUIGONE

"WaitForGUIGone"

See Also:

Constant Field Values

COMMAND_SETIMAGEDEBUG

public static final java.lang.String COMMAND_SETIMAGEDEBUG

"SetImageDebug"

See Also:

Constant Field Values

COMMAND_SETIMAGEFUZZYMATCHING

public static final java.lang.String COMMAND_SETIMAGEFUZZYMATCHING

"SetImageFuzzyMatching"

See Also:

Constant Field Values

SET_MILLIS_BETWEEN_RECORDS

public static final java.lang.String SET_MILLIS_BETWEEN_RECORDS

See Also:

Constant Field Values

GET_MILLIS_BETWEEN_RECORDS

public static final java.lang.String GET_MILLIS_BETWEEN_RECORDS

See Also:

Constant Field Values

SETMULTIPLETHREADSEARCH

public static final java.lang.String SETMULTIPLETHREADSEARCH

See Also:

Constant Field Values

dcLog

TIDDriverLogCommands dcLog

dcFlow

TIDDriverFlowCommands dcFlow

dcCounters

TIDDriverCounterCommands dcCounters

dcRest

TIDDriverRestCommands dcRest

command

java.lang.String command

message

java.lang.String message

detail

java.lang.String detail

Constructor Detail

TIDDriverCommands

public TIDDriverCommands()

Constructor for TIDDriverCommands

TIDDriverCommands

public TIDDriverCommands(LogUtilities log)

Instantiate a new TIDDriverCommands, Call setLogUtilities() of its super class for itself and its inner TID engines like Log, Flow, Counter TIDEngines.
Normally, we should instantiate an object of this class with a driver. But if TestRecord has Mixed-Mode-RS, we have to instantiate an object of this class from a Processor (ex. DCDriverCommand), to keep working the log functionality, we call this constructor. For other cases, we should NOT call this constructor.

Parameters:

log -

TIDDriverCommands

public TIDDriverCommands(DriverInterface driver)

PREFERRED Constructor for TIDDriverCommands. Constructs the instance and calls launchInterface to initialize.

Method Detail

setLogUtilities

public void setLogUtilities(LogUtilities log)

Calls super.setLogUtilities for this class and then setLogUtilities for each chained processor in this class (dcLog, dcFlow, dcCounters, dcRest).

Overrides:

setLogUtilities in class DriverConfiguredSTAFInterfaceClass

setLogUtilities

public void setLogUtilities(LogUtilities log,
                            boolean copyLogClass)

Calls super.setLogUtilities for this class and then setLogUtilities for each chained processor in this class (dcLog, dcFlow, dcCounters, dcRest).

Overrides:

setLogUtilities in class DriverConfiguredSTAFInterfaceClass

Parameters:

log -

copyLogClass - set to true to copy everything to the debug log (Log.class)

launchInterface

public void launchInterface(java.lang.Object configInfo)

Description copied from class: GenericEngine

Typically expects a DriverInterface object for initialization. Subclasses should indicate if an alternative type of object is required. This method will try to reset the "shutdown" semaphore remained by last hook shutdown.

Specified by:

launchInterface in interface ConfigurableToolsInterface

Overrides:

launchInterface in class GenericEngine

Parameters:

configInfo - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.

See Also:

GenericEngine.launchInterface(Object)

processRecord

public long processRecord(TestRecordHelper testRecordData)

Process the record present in the provided testRecordData. Route to other TIDDriverXXXCommands classes as necessary.

Specified by:

processRecord in interface EngineInterface

Overrides:

processRecord in class GenericEngine

Returns:

the status code resulting from the processing.

• 4 -- SCRIPT NOT EXECUTED. "I did not process this record."
• -1 -- NO SCRIPT FAILURE. "I processed the record successfully."
• -2 -- SCRIPT WARNING. "I processed the record, issued warning(s)."
• 0 -- SCRIPT FAILURE. "I processed the record, issued failure(s)."
• 2 -- IO FAILURE. "I process the record, issued IO failure(s)."
• 8 -- EXIT TABLE. "I processed the record, exit current table."
• 16 -- IGNORE STATUS. "I processed the record, ignore code and continue."

See Also:

EngineInterface#processRecord()

takeScreenShot

protected long takeScreenShot()
                       throws SAFSException

Throws:

SAFSException