org.safs.tools.engines

Class AutoItComponent

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.AutoItComponent

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface, Versionable

public class AutoItComponent
extends GenericEngine

Provides local in-process support Component Functions and Driver Commands by AutoIT engine on Windows.

This 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).

Author:

Dharmesh Patel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AutoItComponent.AutoItDriverCommand Handle Driver Commands
(package private) class	AutoItComponent.CFComponent Local CFComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected AutoItComponent.AutoItDriverCommand	adc The special AutoIT Processor for handling Driver Command keywords.
static java.lang.String	AUTOITCOMPONENT_ENGINE "AUTOITComponent"
protected ComponentFunction	cf The special AutoIT Processor for handling Component Function keywords.
static java.lang.String	ENGINE_DESCRIPTION 'The engine using AutoIt to automate the Windows GUI.'
static java.lang.String	ENGINE_NAME "SAFS/AUTOITComponent"
static java.lang.String	ENGINE_VERSION 'v3'
protected AutoItXPlus	it The AutoIt instance got by AutoIt.AutoItObject(). This instance may be shared by multiple threads.

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

console, description, process, productName, testRecordData, testrecordStackable, version

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
AutoItComponent() Constructor for AUTOITComponent. It will also initialize the shared AutoIT object.
AutoItComponent(DriverInterface driver) PREFERRED Constructor for AUTOITComponent.

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<java.lang.String>	interpretFields(TestRecordHelper testRecordData)
void	launchInterface(java.lang.Object configInfo) Typically expects a DriverInterface object for initialization.
void	processIndependently(TestRecordHelper testRecordData) Note: Now this method is called only by a special processor CFAUTOITComponent Before calling this method, you must make sure the test record data is correctly initialized.
long	processRecord(TestRecordHelper testRecordData) Initiate the event-driven protocol to send the test record to the engine.
protected boolean	waitForGUI(AutoItRs rs) Prerequisite: it and GenericEngine.testRecordData should be initialized.

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

deduceBenchFile, deduceProjectFile, deduceTestFile, getAppMapItem, getDescription, getEngineName, getProductName, getVariable, getVersion, isToolRunning, logMessage, makeQuotedPath, makeQuotedString, popTestRecord, postShutdownServiceDelay, pushTestRecord, reset, resetShutdownSemaphore, saveTestRecordScreenToTestDirectory, setDescription, setProductName, setTRDStatus, setVariable, setVersion, shutdownService, waitHookShutdownAndReset

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

configureJSTAFServiceEmbeddedJVMOption, extendedGenericMessage, finalize, getCoreInterface, getEmbedded64JVMBinPath, 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

public static final java.lang.String ENGINE_NAME

"SAFS/AUTOITComponent"

See Also:

Constant Field Values

ENGINE_VERSION

public static final java.lang.String ENGINE_VERSION

'v3'

See Also:

Constant Field Values

ENGINE_DESCRIPTION

public static final java.lang.String ENGINE_DESCRIPTION

'The engine using AutoIt to automate the Windows GUI.'

See Also:

Constant Field Values

AUTOITCOMPONENT_ENGINE

public static final java.lang.String AUTOITCOMPONENT_ENGINE

"AUTOITComponent"

See Also:

Constant Field Values

cf

protected ComponentFunction cf

The special AutoIT Processor for handling Component Function keywords.

adc

protected AutoItComponent.AutoItDriverCommand adc

The special AutoIT Processor for handling Driver Command keywords.

it

protected AutoItXPlus it

The AutoIt instance got by AutoIt.AutoItObject().
This instance may be shared by multiple threads.

See Also:

AutoItComponent()

Constructor Detail

AutoItComponent

public AutoItComponent()

Constructor for AUTOITComponent.
It will also initialize the shared AutoIT object.

AutoItComponent

public AutoItComponent(DriverInterface driver)

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

Method Detail

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)

Description copied from class: GenericEngine

Initiate the event-driven protocol to send the test record to the engine. All official engines conform to this protocol. So this function rarely needs to be overridden..

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

processIndependently

public void processIndependently(TestRecordHelper testRecordData)

Note: Now this method is called only by a special processor CFAUTOITComponent Before calling this method, you must make sure the test record data is correctly initialized.

Parameters:

testRecordData -

interpretFields

protected java.util.Collection<java.lang.String> interpretFields(TestRecordHelper testRecordData)

waitForGUI

protected boolean waitForGUI(AutoItRs rs)
                      throws SAFSException

Prerequisite: it and GenericEngine.testRecordData should be initialized.

Parameters:

rs - AutoItRs, the recognition string representing the AutoIT component.

Returns:

boolean, if the AutoIT component exists.

Throws:

SAFSException