org.safs.tools.engines

Class SAFSIOS

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.SAFSIOS

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface

public class SAFSIOS
extends GenericEngine

A wrapper to Apple's iOS Developer UIAutomation SAFS engine--the "IOS" engine. This engine can only be used if you have a valid install of the iOS/XCode Developer SDK tools on an Apple Mac(or equivalent) computer.

This is intended for testing of iPhone and iPad iOS applications.

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 IOS supported config file items are listed below. Remember, this engine executes on a Mac, so all file paths are in Unix/Mac format:

 [SAFS_IOS]
 AUTOLAUNCH=FALSE                     (Defaults to FALSE because config info must be valid.)
 Project=/Library/SAFS/samples/UICatalog/  (IOS Automation Project Location)
 Template="UICatalogInstruments.tracetemplate"   (Instruments tracetemplate for Application)
 ;HOOK=org.safs.ios.JavaHook          (Java SAFS Engine Class)
 ;TIMEOUT=30                          (Alternate AutoLaunch timeout value in seconds)
 ;STAFID="SAFS/IOS"                   (Normally never used.)
 ;JVM=JVMpath                         (Full path to desired Java executable if "java" is not sufficient.)
 ;JVMARGS=JVM Args                    (Ex: "-Xms512m -Xmx512m", will be used unmodified.)
 ;CLASSPATH=altClasspath              (Generally overrides system classpath.)
 ;XBOOTCLASSPATH=<CLASSPATH>       (CLASSPATH needed for rare cases. Normally never used.)
 ;ConvertSAFSInputKeysSyntax=ON|OFF   (ON to use SAFS InputKeys syntax in Test Complete)
 

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 JUN 30, 2011 Original Release

See Also:

ProcessConsole

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	AUTOLAUNCH_OPTION
(package private) static int	DEFAULT_INIT_TIMEOUT
(package private) static java.lang.String	ENGINE_NAME "SAFS/IOS" -- The name of this engine as registered with STAF.
(package private) static java.lang.String	HOOK_CLASS "org.safs.ios.JavaHook"
(package private) static java.lang.String	HOOK_OPTION
(package private) static java.lang.String	JVM_OPTION
(package private) static java.lang.String	JVMARGS_OPTION
(package private) static java.lang.String	PROJECT_OPTION
(package private) static java.lang.String	TEMPLATE_OPTION
(package private) static java.lang.String	TIMEOUT_OPTION
(package private) static java.lang.String	XBOOTCLASSPATH_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
SAFSIOS() Constructor for IOS.
SAFSIOS(DriverInterface driver) PREFERRED Constructor for SAFSIOS.

Method Summary

Modifier and Type	Method and Description
void	launchInterface(java.lang.Object configInfo) Extracts configuration information and launches IOS initialization 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/IOS" -- The name of this engine as registered with STAF.

See Also:

Constant Field Values

HOOK_CLASS

static final java.lang.String HOOK_CLASS

"org.safs.ios.JavaHook"

See Also:

Constant Field Values

AUTOLAUNCH_OPTION

static final java.lang.String AUTOLAUNCH_OPTION

See Also:

Constant Field Values

HOOK_OPTION

static final java.lang.String HOOK_OPTION

See Also:

Constant Field Values

PROJECT_OPTION

static final java.lang.String PROJECT_OPTION

See Also:

Constant Field Values

TEMPLATE_OPTION

static final java.lang.String TEMPLATE_OPTION

See Also:

Constant Field Values

JVM_OPTION

static final java.lang.String JVM_OPTION

See Also:

Constant Field Values

JVMARGS_OPTION

static final java.lang.String JVMARGS_OPTION

See Also:

Constant Field Values

XBOOTCLASSPATH_OPTION

static final java.lang.String XBOOTCLASSPATH_OPTION

See Also:

Constant Field Values

TIMEOUT_OPTION

static final java.lang.String TIMEOUT_OPTION

See Also:

Constant Field Values

DEFAULT_INIT_TIMEOUT

static final int DEFAULT_INIT_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

SAFSIOS

public SAFSIOS()

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

SAFSIOS

public SAFSIOS(DriverInterface driver)

PREFERRED Constructor for SAFSIOS.

Method Detail

launchInterface

public void launchInterface(java.lang.Object configInfo)

Extracts configuration information and launches IOS initialization in a new process.

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