org.safs.tools.engines

Class SAFSQTP

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.SAFSQTP

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface

public class SAFSQTP
extends GenericEngine

A wrapper to the Mercury QuickTest Pro SAFS engine--the "QTP" engine. This engine can only be used if you have a valid install of Mercury's QuickTest Pro product.

The default SAFSDRIVER Tool-Independent Driver (TID) does not provide for any command-line options to configure the Engine. All configuration information must be provided in config files. By default, these are SAFSTID.INI files. See SAFSTID Config Files for more information.

The QTP supported config file items:

 [SAFS_QTP]
 AUTOLAUNCH=FALSE                    Defaults to FALSE because config info must be valid.
 HOOK=C:\PathTo\AnyAOM.VBS           (QTP Automation Object Model startup via WSH cscript.exe)
 ;HOOK=C:\PathTo\AnyExecutable.EXT   (Alternate method of starting like via a .BAT file)
 ;TIMEOUT=45                         (Timeout in seconds before issuing autolaunch failure)
 

Note: The HOOK item can be a VBS script that will be used as an argument to the CSCRIPT.EXE executable for Windows Script Host. This script is intended to use the QTP Automation Object Model to prepare and then launch QTP as desired by the tester.

The HOOK item can also be a valid full path to any other executable -- like a batch file (.BAT). The value of HOOK in this case will be used "as is". The Java Runtime.exec function will attempt to launch this, so whatever limitations placed by the Runtime.exec from Java apply. Mostly this may only be an issue if spaces or tabs exist in the string.

We do use a ProcessConsole to keep the Process in, out, and err streams from filling up.

Runtime.exec
Runtime.exec Process

@author Carl Nagle NOV 18, 2005 Modified CScript launch command for VBScript.
@author Carl Nagle DEC 14, 2005 Refactored with DriverConfiguredSTAFInterface superclass

See Also:

ProcessConsole

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	ENGINE_NAME "SAFS/QTP" -- The name of this engine as registered with STAF.
(package private) static java.lang.String	TIMEOUT_OPTION

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
SAFSQTP() Constructor for QTP.
SAFSQTP(DriverInterface driver) PREFERRED Constructor for SAFSQTP.

Method Summary

Modifier and Type	Method and Description
void	launchInterface(java.lang.Object configInfo) Extracts configuration information and launches QTP initialization script in a new process.
long	processRecord(TestRecordHelper testRecordData) Override superclass to catch unsuccessful initialization scenarios.

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, setLogUtilities, setLogUtilities, 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/QTP" -- The name of this engine as registered with STAF.

See Also:

Constant Field Values

TIMEOUT_OPTION

static final java.lang.String TIMEOUT_OPTION

See Also:

Constant Field Values

Constructor Detail

SAFSQTP

public SAFSQTP()

Constructor for QTP. Call launchInterface with an appropriate DriverInterface before attempting to use this minimally initialized object.

SAFSQTP

public SAFSQTP(DriverInterface driver)

PREFERRED Constructor for SAFSQTP.

Method Detail

launchInterface

public void launchInterface(java.lang.Object configInfo)

Extracts configuration information and launches QTP initialization script in a new process.
@author Carl Nagle NOV 18, 2005 Modified CScript launch command for VBScript.

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)

Override superclass to catch unsuccessful initialization scenarios.

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()