org.safs.tools.drivers

Class DefaultDriver

java.lang.Object

org.safs.tools.drivers.AbstractDriver

org.safs.tools.drivers.DefaultDriver

All Implemented Interfaces:

DriverInterface, PathInterface

Direct Known Subclasses:

JSAFSAdvancedRuntime, JSAFSDriver, SAFSDRIVER

public abstract class DefaultDriver
extends AbstractDriver

The root, yet abstract, implementation of our tool-independent Driver. The final concrete implementation must implement AbstractDriver.processTest().

We use String-based Interface objects for inter-API communication.

The driver monitors SAFSVARS variable 'SAFS_DRIVER_CONTROL'. If this variable is set to 'SHUTDOWN_HOOK' then the driver will initiate a shutdown.

The driver will provide a Frame monitor allowing the user to initiate such a shutdown.
(Carl Nagle) DEC 10, 2008 Fixed LogMode problems affecting XML Logging
(LeiWang)APR 20, 2010 Modify method initializePresetVariables(): Read the OCR settings from INI file, then set them to STAF Variables.
(LeiWang)JUL 13, 2010 Modify method initializePresetVariables(): Read the IBT settings from INI file, then set to ImageUtils
(JunwuMa)SEP 27, 2010 Added initialization for step retry working with SAFSMonitorFrame.
Oct 26, 2010 (Carl Nagle) Refactored to support separate misc config initialization
Jul 08, 2011 (Carl Nagle) Add support for PREFERRED_ENGINES_OVERRIDE
SEP 12, 2013 (Carl Nagle) Add Daemon threads for SAFSMonitor shutdown.
OCT 09, 2016 (Lei Wang) Modified validateTestParameters(): handle 'DndReleaseDelay'.

See Also:

UniqueStringID, UniqueStringLogInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected UniqueStringLogInfo	cycleLog
protected StacksInterface	cycleStack
protected CaseInsensitiveHashtable	engineObjects Stores ALL instanced EngineInterface objects in classname=engine format.
protected java.util.Vector	enginePreference Stores only active 'preferred' engine class names in preferred order.
protected java.util.Vector	engines Stores ALL instanced EngineInterface objects in instanced order.
protected SAFSMonitorFrame	safsmonitor
protected SAFSSTATUS	status
protected UniqueStringLogInfo	stepLog
protected StacksInterface	stepStack
protected UniqueStringLogInfo	suiteLog
protected StacksInterface	suiteStack
boolean	useSAFSMonitor If true, the SAFS Monitor window can be used to control test execution--allowing the tester to interactively PAUSE the test, STEP through portions of the test, or force a premature SHUTDOWN (Abort) of the test--including any running SAFS Engines.

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

autoitcomponent, benchSource, configInfo, core, counterInfo, counts, cycleflowcontrol, cycleLinkedFac, cycleLogMode, cycleLogName, cycleSeparator, cycleSuffix, datapoolSource, debug, difSource, driverConfigPath, driverName, driverRootDir, exitCycle, exitSuite, expressionsOn, input, ipcommands, locator, logLevel, logs, logsSource, maps, millisBetweenRecords, perTableFlowControl, projectConfigPath, projectRootDir, statuscounts, stepflowcontrol, stepLinkedFac, stepLogMode, stepLogName, stepSeparator, stepSuffix, suiteflowcontrol, suiteLinkedFac, suiteLogMode, suiteLogName, suiteSeparator, suiteSuffix, testLevel, testName, testSource, tidcommands, tidcomponent, vars, verifySource

Fields inherited from interface org.safs.tools.drivers.DriverInterface

DRIVER_CONTROL_POF_VAR, DRIVER_CONTROL_POW_VAR, DRIVER_CONTROL_VAR

Constructor Summary

Constructors

Constructor and Description
DefaultDriver()

Method Summary

Modifier and Type	Method and Description
void	clearEnginePreferences()
protected void	closeTestLogs() Close logs initialized with openTestLogs.
void	endEnginePreference(java.lang.String key)
protected EngineInterface	getEngineInterface(java.lang.String itemName) Locate an EngineInterface given the engine priority string as defined in the documented Configuration File standard for SAFS_ENGINES.
java.util.ListIterator	getEnginePreferences()
java.util.ListIterator	getEngines()
protected java.lang.String	getFullEngineClass(java.lang.String key) used internally or by subclasses to find the validity of an engine name.
protected GenericToolsInterface	getGenericInterface(java.lang.String configSection, java.lang.String defaultInterface)
protected java.lang.String	getLogID(java.lang.String testlevel) Returns the logid based on the current testLevel.
EngineInterface	getPreferredEngine(java.lang.String key) Retrieve a running EngineInterface engineObject by stored classname.
protected int	getPreferredEngineIndex(java.lang.String key) used internally to find the index of an engine marked as "preferred"
protected java.lang.String	getTestLevelSeparator(java.lang.String testlevel) Returns the separator based on the current testLevel.
boolean	hasEnginePreferences()
protected void	initializeMiscConfigInfo() Initialize other miscellaneous config info from INI files.
protected void	initializePresetVariables() Initialize any preset SAFS variables such as known project directories, etc.
protected void	initializeRuntimeEngines() Instantiate and initialize any EngineInterface classes (up to 10)listed in the SAFS_ENGINE section of the Configuration Source.
protected void	initializeRuntimeInterface() Initialize all the Driver/Engine interfaces as specified by the config files or driver defaults (Status is a SAFSSTATUS object directly instanced).
protected UniqueStringLogInfo	initLog(java.lang.String logname, long logmodes, java.lang.String loglevel) Initialize a log and set the loglevel via the LogsInterface.
protected void	insertConfigureInterfaceSource(ConfigureInterface source) Initialize or insert a ConfigureInterface at the start of the search order.
boolean	isPreferredEngine(EngineInterface engine)
boolean	isPreferredEngine(java.lang.String key)
boolean	isUseSAFSMonitor()
protected void	launchSAFSMonitor() Only launches if there is already not one running from another process.
protected void	openTestLogs() Instantiate unique logs.
protected long	parseLogMode(java.lang.String value) parse a configuration file logmode entry for valid text or numeric values.
void	run() Bootstrap a newly instanced driver.
void	setUseSAFSMonitor(boolean useSAFSMonitor)
protected void	shutdownRuntimeEngines() shutdown any engines started with initializeRuntimeEngines()
protected void	shutdownRuntimeInterface() shutdown interfaces started with initializeRuntimeInterfaces() (Carl Nagle) 2013.09.23 Change the order of shutdown to be reverse of initialization.
void	startEnginePreference(java.lang.String key)
protected void	validateLogParameters() Verify the existence of sufficient test information.
protected void	validateTestParameters() Verify the existence of sufficient test information.

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

addConfigureInterfaceSource, addStatusCounts, getAutoItComponentSupport, getBenchDir, getConfigureInterface, getConfigureLocator, getCoreInterface, getCountersInterface, getCycleLogMode, getCycleLogName, getCycleSeparator, getCycleSuffix, getDatapoolDir, getDebugInterface, getDifDir, getDriverName, getDriverRootDir, getFlowControlInterface, getInputInterface, getIPDriverCommands, getLogLevel, getLogsDir, getLogsInterface, getMapsInterface, getMillisBetweenRecords, getParameterValue, getProjectDirectoryInfo, getProjectRootDir, getRootDirectoryInfo, getRootVerifyDir, getStatusInterface, getStepLogMode, getStepLogName, getStepSeparator, getStepSuffix, getSuiteLogMode, getSuiteLogName, getSuiteSeparator, getSuiteSuffix, getTestDir, getTestLevel, getTestName, getTIDDriverCommands, getTIDGUIlessComponentSupport, getVarsInterface, incrementGeneralStatus, incrementTestStatus, isExitCycle, isExitSuite, isExpressionsEnabled, isModifiedConfig, isModifiedRoot, isPerTableFlowControl, logMessage, processEmbeddedVariable, processTest, resetModifiedProperties, setBenchDir, setDatapoolDir, setDifDir, setExitCycle, setExitSuite, setExpressionsEnabled, setLogsDir, setMillisBetweenRecords, setPerTableFlowControl, setProjectRootDir, setRootVerifyDir, setTestDir, validateRootConfigureParameters

Methods inherited from class java.lang.Object

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

Field Detail

safsmonitor

protected SAFSMonitorFrame safsmonitor

status

protected SAFSSTATUS status

cycleStack

protected StacksInterface cycleStack

suiteStack

protected StacksInterface suiteStack

stepStack

protected StacksInterface stepStack

useSAFSMonitor

public boolean useSAFSMonitor

If true, the SAFS Monitor window can be used to control test execution--allowing the tester to interactively PAUSE the test, STEP through portions of the test, or force a premature SHUTDOWN (Abort) of the test--including any running SAFS Engines.

To ignore the default SAFS Monitor integration, the developer can set this value to 'false'.
The default setting is 'true'.

engines

protected java.util.Vector engines

Stores ALL instanced EngineInterface objects in instanced order.

enginePreference

protected java.util.Vector enginePreference

Stores only active 'preferred' engine class names in preferred order.

engineObjects

protected CaseInsensitiveHashtable engineObjects

Stores ALL instanced EngineInterface objects in classname=engine format. Note the classname is NOT case-sensitive.

See Also:

CaseInsensitiveHashtable

cycleLog

protected UniqueStringLogInfo cycleLog

suiteLog

protected UniqueStringLogInfo suiteLog

stepLog

protected UniqueStringLogInfo stepLog

Constructor Detail

DefaultDriver

public DefaultDriver()

Method Detail

isUseSAFSMonitor

public boolean isUseSAFSMonitor()

setUseSAFSMonitor

public void setUseSAFSMonitor(boolean useSAFSMonitor)

getEngines

public java.util.ListIterator getEngines()

See Also:

DriverInterface.getEngines()

getEnginePreferences

public java.util.ListIterator getEnginePreferences()

See Also:

DriverInterface.getEnginePreferences()

getPreferredEngineIndex

protected int getPreferredEngineIndex(java.lang.String key)

used internally to find the index of an engine marked as "preferred"

getFullEngineClass

protected java.lang.String getFullEngineClass(java.lang.String key)
                                       throws java.lang.IllegalArgumentException

used internally or by subclasses to find the validity of an engine name. For example, if the key substring provided is "SAFSROBOTJ", then the full key of "ORG.SAFS.TOOLS.ENGINES.SAFSROBOTJ" will be returned if it is a running engine.

Throws:

java.lang.IllegalArgumentException

getPreferredEngine

public EngineInterface getPreferredEngine(java.lang.String key)
                                   throws java.lang.IllegalArgumentException

Retrieve a running EngineInterface engineObject by stored classname.

Parameters:

key - full classname or simple classname of engine to retrieve. For example, "SAFSROBOTJ" will successfully get "org.safs.tools.engines.SAFSROBOTJ" if it is running.

Throws:

java.lang.IllegalArgumentException

See Also:

getFullEngineClass(String), DriverInterface.getPreferredEngine(String), engineObjects

hasEnginePreferences

public boolean hasEnginePreferences()

See Also:

DriverInterface.hasEnginePreferences()

startEnginePreference

public void startEnginePreference(java.lang.String key)
                           throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.startEnginePreference(String)

endEnginePreference

public void endEnginePreference(java.lang.String key)
                         throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.endEnginePreference(String)

clearEnginePreferences

public void clearEnginePreferences()

See Also:

DriverInterface.clearEnginePreferences()

isPreferredEngine

public boolean isPreferredEngine(java.lang.String key)
                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.isPreferredEngine(String)

isPreferredEngine

public boolean isPreferredEngine(EngineInterface engine)
                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.isPreferredEngine(EngineInterface)

getEngineInterface

protected EngineInterface getEngineInterface(java.lang.String itemName)

Locate an EngineInterface given the engine priority string as defined in the documented Configuration File standard for SAFS_ENGINES. (Ex: "First", "Second", etc.)

Returns:

an EngineInterface or null if not found or instantiated.

insertConfigureInterfaceSource

protected void insertConfigureInterfaceSource(ConfigureInterface source)

Initialize or insert a ConfigureInterface at the start of the search order.

validateTestParameters

protected void validateTestParameters()

Verify the existence of sufficient test information. We need a test name, test level, and field separator. If no separator is found we will default to a comma (,) separator.

parseLogMode

protected long parseLogMode(java.lang.String value)

parse a configuration file logmode entry for valid text or numeric values.

validateLogParameters

protected void validateLogParameters()

Verify the existence of sufficient test information. We need a test name, test level, and field separator. If no separator is found we will default to a comma (,) separator. (Carl Nagle) DEC 10, 2008 Fixed LogMode problems affecting XML Logging

getGenericInterface

protected GenericToolsInterface getGenericInterface(java.lang.String configSection,
                                                    java.lang.String defaultInterface)
                                             throws java.lang.ClassNotFoundException,
                                                    java.lang.IllegalAccessException,
                                                    java.lang.InstantiationException

Throws:

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.InstantiationException

initializeRuntimeInterface

protected void initializeRuntimeInterface()

Initialize all the Driver/Engine interfaces as specified by the config files or driver defaults (Status is a SAFSSTATUS object directly instanced). This driver passes itself (a DriverInterface) to all Configurable tools it instances. (Carl Nagle) 2013.09.23 Watch the order of initialization to be reverse of shutdown.

initializeRuntimeEngines

protected void initializeRuntimeEngines()

Instantiate and initialize any EngineInterface classes (up to 10)listed in the SAFS_ENGINE section of the Configuration Source.

This driver passes itself--a DriverInterface object--to each instanced engine.

initializePresetVariables

protected void initializePresetVariables()

Initialize any preset SAFS variables such as known project directories, etc.

Known preset variables are:

• "SAFSPROJECTDIRECTORY" -- Root project directory: "C:\MyProject"
• "SAFSDATAPOOLDIRECTORY" -- Project Datapool directory: "C:\MyProject\Datapool"
• "SAFSBENCHDIRECTORY" -- Project Bench directory: "C:\MyProject\Datapool\Bench"
• "SAFSTESTDIRECTORY" -- Project Test\Actual directory: "C:\MyProject\Datapool\Test"
• "SAFSDIFDIRECTORY" -- Project Dif directory: "C:\MyProject\Datapool\Dif"
• "SAFSLOGSDIRECTORY" -- Project Logs directory: "C:\MyProject\Datapool\Logs"
• "SAFSSYSTEMUSERID" -- UserID of the person\account logged onto the system.
• "SAFS_DRIVER_CONTROL" -- "RUNNING".
• "SAFS_DRIVER_CONTROL_POF" -- "OFF".
• "STAF_OCR_ENGINE_VAR_NAME" -- from INI file SAFS_OCR:OCRName
• "STAF_OCR_LANGUAGE_ID_VAR_NAME" -- from INI file SAFS_OCR:LanguageID

initializeMiscConfigInfo

protected void initializeMiscConfigInfo()

Initialize other miscellaneous config info from INI files. For example, SAFS_IBT INI values or other class configuration options made available through the INI files.

Currently processed values:

From [SAFS_IBT]
• "UseMultiThreadedSearch"
• "ThreadNumber"
• "UsePerImageModifiers"

From [SAFS_DRIVER]
• "ResolveSkippedRecords"
• "PreferredEnginesOverride"
• "BringMonitorToFrontOnPause"
• "TurnOnPOF"

initLog

protected UniqueStringLogInfo initLog(java.lang.String logname,
                                      long logmodes,
                                      java.lang.String loglevel)

Initialize a log and set the loglevel via the LogsInterface. The logName serves as the unique ID. Text logs and xml logs are named with ".txt" and ".xml" suffixes on the logName.

openTestLogs

protected void openTestLogs()

Instantiate unique logs.

closeTestLogs

protected void closeTestLogs()

Close logs initialized with openTestLogs.

shutdownRuntimeEngines

protected void shutdownRuntimeEngines()

shutdown any engines started with initializeRuntimeEngines()

shutdownRuntimeInterface

protected void shutdownRuntimeInterface()

shutdown interfaces started with initializeRuntimeInterfaces() (Carl Nagle) 2013.09.23 Change the order of shutdown to be reverse of initialization.

getTestLevelSeparator

protected java.lang.String getTestLevelSeparator(java.lang.String testlevel)

Returns the separator based on the current testLevel. Returns the DriverConstant.DEFAULT_FIELD_SEPARATOR if no other can be determined.

getLogID

protected java.lang.String getLogID(java.lang.String testlevel)

Returns the logid based on the current testLevel.

launchSAFSMonitor

protected void launchSAFSMonitor()

Only launches if there is already not one running from another process.

run

public void run()

Bootstrap a newly instanced driver. The routine calls all the other routines to prepare the the test, execute the test, and shutdown the test. This routine must be overridden by subclasses if they wish to change default start-to-finish execution flow.

The model for overall driver operation is that any command-line arguments or configuration file arguments that prevent normal execution will generate an IllegalArgumentException. Those IllegalArgumentExceptions are caught here and sent to stderr output. We then return immediately from this function.

Calls:
• AbstractDriver.validateRootConfigureParameters(boolean)
• validateTestParameters()
• validateLogParameters()
• initializeRuntimeInterface()
• launchSAFSMonitor()
• initializePresetVariables()
• initializeMiscConfigInfo()
• initializeRuntimeEngines()
• openTestLogs()

• AbstractDriver.processTest()

• closeTestLogs()
• shutdownRuntimeEngines()
• shutdownRuntimeInterface()
• Shutdown SAFSMonitorFrame.dispose()

See Also:

SAFSDRIVER.main(String[])