org.safs.model.examples.advanced

Class JSAFSAdvancedRuntime

java.lang.Object

org.safs.tools.drivers.AbstractDriver

org.safs.tools.drivers.DefaultDriver

org.safs.model.examples.advanced.JSAFSAdvancedRuntime

All Implemented Interfaces:

DriverInterface, PathInterface, Versionable

public class JSAFSAdvancedRuntime
extends DefaultDriver

JSAFSAdvancedRuntime is a comprehensive sample implementation of a Driver Advanced Runtime. Execution expects SAFSROBOTJ (IBM Rational Functional Tester) be available for demonstrating certain command execution results. However, the sourcecode is a valuable usage reference even if the SAFSROBOTJ engine is not available at runtime.

This class is intended to be executed as a standalone Java application--typically, in its own JVM. The main(String[]) entry point will create a new instance and immediately invoke DefaultDriver.run().

Command-line Options and Configuration File Options are linked below. Custom sections and items in associated configuration file(s) can readily be processed at runtime via AbstractDriver.configInfo ConfigureInterface.

The default name of configuration files is "SAFSTID.INI". There is a hierarchy of configuration files that will be sought based on command-line parameters provided. This hierarchy is summarized in the Configuration File Options doc linked below and detailed below::

1. command-line specified PROJECT config file: -Dsafs.project.config

   a project or test-specific config file, other than SAFSTID.INI, containing config information intended to override settings in the SAFSTID.INI file located in the PROJECT ROOT directory.

2. default PROJECT config file

   SAFSTID.INI located in the PROJECT ROOT directory. The PROJECT ROOT would normally be provided as a command-line parameter. It may instead be provided in the previous specified PROJECT config file. This file will normally contain settings specific to an entire project and these override any similar settings in the DRIVER config files.

3. command-line specified DRIVER config file

   Rarely used. A config file, other than SAFSTID.INI, intended to override settings in any SAFSTID.INI file located in the DRIVER ROOT directory.

4. default DRIVER config file

   SAFSTID.INI located in the DRIVER ROOT directory. The DRIVER ROOT would normally be provided in a previous config file or as a command-line parameter. This config file will contain configuration information that is specific to the driver and independent of any project or test being executed.

In general, you want to provide the bare minimum of command-line parameters and place all remaining info in one or more configuration files. The total of all command-line parameters and config file information must enable the driver to locate valid driver and project root directories, project subdirectories, and all other items necessary to run a specified test. See the DefaultDriver.run() link below for all the exciting things the driver will do prior to launching the test!

An example invocation, providing the bare minimum command-line parameters:

java -Dsafs.project.config=c:\SAFS\Project\JSAFSExample.INI org.safs.model.examples.advanced.JSAFSAdvancedRuntime

The above invocation expects JSAFSExample.INI to contain any information expected by the Driver test, and where the PROJECT ROOT and maybe the DRIVER ROOT directories are located. Any remaining configuration information--such as which SAFS Engines to launch--can reside in either the JSAFSExample.INI file or default SAFSTID.INI files located in the PROJECT ROOT or DRIVER ROOT directories.

Sample JSAFSExample.INI in c:\SAFS\Project specific to one test:

 [SAFS_PROJECT]
 ProjectRoot="C:\safs\project"

 [SAFS_TEST]
 CycleLogName="JSAFSExample"
 CycleLogMode="41"
      (or)
 CycleLogMode="TOOLLOG CONSOLELOG TEXTLOG"

 [SAFS_ENGINES]
 First=org.safs.tools.engines.SAFSROBOTJ

 [SAFS_ROBOTJ]
 AUTOLAUNCH=TRUE
 DATASTORE="C:\SAFS\DatastoreJ"
 TESTDOMAINS=HTML,JAVA
 

Sample SAFSTID.INI in c:\SAFS\Project used by all tests:

 [SAFS_DRIVER]
 DriverRoot="C:\safs"

 [SAFS_MAPS]
 AUTOLAUNCH=TRUE

 [SAFS_INPUT]
 AUTOLAUNCH=TRUE

 [SAFS_VARS]
 AUTOLAUNCH=TRUE

 [SAFS_LOGS]
 AUTOLAUNCH=TRUE
 

And that is enough for us to run the Driver test.

Of course, more of the configuration parameters necessary for desired engines will have to be in those configuration files once the engines actually become available.

See Also:

DefaultDriver.run(), Command-Line Options, Configuration File Options

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	_args Optional, command-line args exposed more globally.
static java.lang.String	JSAFSRUNTIME "JSAFSRuntime" custom Driver Name.

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

cycleLog, cycleStack, engineObjects, enginePreference, engines, safsmonitor, status, stepLog, stepStack, suiteLog, suiteStack, useSAFSMonitor

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

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

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
JSAFSAdvancedRuntime() Default constructor using "JSAFSRuntime" Driver name.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAppMapItem(java.lang.String mapname, java.lang.String section, java.lang.String item) Convenience routine to get a value out of an app map.
protected TestRecordHelper	initTestRecordData(TestRecordHelper store) Convienience (re)initializer for a TestRecordHelper.
static void	main(java.lang.String[] args) Entry point for standalone Java execution.
protected StatusInterface	processTest() This is where the Driver developer implements the application-specific test!
protected void	validateTestParameters() Empty routine overrides superclass DefaultDriver.validateTestParameters() No initialization validation required for this sample advanced runtime.

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

clearEnginePreferences, closeTestLogs, endEnginePreference, getEngineInterface, getEnginePreferences, getEngines, getFullEngineClass, getGenericInterface, getLogID, getPreferredEngine, getPreferredEngineIndex, getTestLevelSeparator, hasEnginePreferences, initializeMiscConfigInfo, initializePresetVariables, initializeRuntimeEngines, initializeRuntimeInterface, initLog, insertConfigureInterfaceSource, isPreferredEngine, isPreferredEngine, isUseSAFSMonitor, launchSAFSMonitor, openTestLogs, parseLogMode, run, setUseSAFSMonitor, shutdownRuntimeEngines, shutdownRuntimeInterface, startEnginePreference, validateLogParameters

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

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

Methods inherited from class java.lang.Object

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

Field Detail

JSAFSRUNTIME

public static final java.lang.String JSAFSRUNTIME

"JSAFSRuntime" custom Driver Name.

See Also:

Constant Field Values

_args

public static java.lang.String[] _args

Optional, command-line args exposed more globally.

Constructor Detail

JSAFSAdvancedRuntime

public JSAFSAdvancedRuntime()

Default constructor using "JSAFSRuntime" Driver name. The constructor does nothing more than initialize internals and superclasses. Nothing else happens until DefaultDriver.run() is invoked.

Method Detail

validateTestParameters

protected void validateTestParameters()

Empty routine overrides superclass DefaultDriver.validateTestParameters() No initialization validation required for this sample advanced runtime. Superclass MUST be overridden or invalid/missing test table information will cause the test initialization to fail and abort the test.

Overrides:

validateTestParameters in class DefaultDriver

initTestRecordData

protected TestRecordHelper initTestRecordData(TestRecordHelper store)

Convienience (re)initializer for a TestRecordHelper.

Instantiates and\or reinits a TestRecordHelper and initializes key properties:

• setFac=cycleLog ID (required)
• setFileID="Driver" (arbitrary ID since we are not processing a test table)
• setFilename="Advanced Runtime" (arbitrary since we are not processing a test table)
• setTestLevel="STEP"
• setSeparator="," (comma separator for records)
• setStatusCode=DriverConstant.STATUS_SCRIPT_NOT_EXECUTED
• setStatusInfo="" (empty)

Parameters:

store - - A TestRecordHelper to reinitialize or null to get a new one initialized.

Returns:

TestRecordHelper

See Also:

TestRecordData.reinit();

getAppMapItem

protected java.lang.String getAppMapItem(java.lang.String mapname,
                                         java.lang.String section,
                                         java.lang.String item)

Convenience routine to get a value out of an app map. (We probably should "fix" the MapsInterface and the implementations to eliminate the need for this convenience routine!)

Parameters:

mapname - Name\ID of App Map to use. If null, use default map.

section - Named Section of App Map to search. If null, use default section.

item - Name of item in section to lookup.

Returns:

String or null

processTest

protected StatusInterface processTest()

This is where the Driver developer implements the application-specific test!

Here you can invoke any test setup that might have to occur after standard SAFS initialization. That would be followed by the actual test code including:

• readily access INI file entries via AbstractDriver.configInfo ConfigureInterface
• increment pass/fail counters via a StatusCounter
• log test messages via AbstractDriver.logs LogsInterface
• use localizable message resource bundles with GENStrings and FAILStrings.
  
  "SAFSTextResourceBundles" and "failedSAFSTextResourceBundles" are in SAFS.JAR for review.
• log debug messages to org.safs.Log
• get/set shared SAFS variables and NLS values via AbstractDriver.vars VarsInterface
• retrieve AppMap values including NLS values via AbstractDriver.maps MapsInterface
• process SAFS expressions for dynamic values via AbstractDriver.maps MapsInterface
• provide test flow logic
• invoke SAFS test table(s) via an InputProcessor
• issue SAFS Driver Command, Component Function, and EngineCommand records directly via EngineInterface
  • INI-specified SAFS_ENGINES like "SAFSROBOTJ" in DefaultDriver.engineObjects via DefaultDriver.getPreferredEngine(String)
  • Internal SAFS TID and SDC ENGINES--including Image-Based Testing support:
    • TID TIDDriverCommands via AbstractDriver.getTIDDriverCommands()
    • SDC SAFSDRIVERCOMMANDS via AbstractDriver.getIPDriverCommands()
    • TID/IBT TIDComponent via AbstractDriver.getTIDGUIlessComponentSupport()
• use STAF directly, if desired, via STAFHelper

When this function returns, standard SAFS test shutdown will commence including the closing of all logs, engines, and STAF--as appropriate.

Specified by:

processTest in class AbstractDriver

See Also:

AbstractDriver.processTest()

main

public static void main(java.lang.String[] args)

Entry point for standalone Java execution.

Instances a new driver object and immediately executes run() for standard SAFS initialization. The developer overrides processTest() to proceed with any additional non-SAFS test setup, execution, and non-SAFS teardown.

SAFS shutdown including engine and log closures will happen automatically after processTest() returns to the DefaultDriver.run() function that invoked it.

See Also:

DefaultDriver.run(), AbstractDriver.processTest(), processTest(), Command-Line Options, Configuration File Options