org.safs.model.tools

Class AbstractRunner

java.lang.Object

org.safs.model.tools.AbstractRunner

All Implemented Interfaces:

JSAFSConfiguredClassStore

Direct Known Subclasses:

DefaultRunner

public abstract class AbstractRunner
extends java.lang.Object
implements JSAFSConfiguredClassStore

This Runner is an access point to a minimalist AbstractDriver API. See the AbstractDriver reference for a list of known available subclasses.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARG_AUTORUN_CLASS "-autorunclass", the parameter to indicate the class name to run test automatically. Example, "-autorunclass autorun.full.classname".
protected static java.util.Vector<java.lang.Object>	callers
protected AbstractDriver	driver The model driver embedded with JSAFSDriver/InputProcessor, which will handle the keyword at the back-end.
protected static java.util.Hashtable<java.lang.String,java.lang.Object>	instances
protected boolean	running

Constructor Summary

Constructors

Constructor and Description
AbstractRunner()

Method Summary

Modifier and Type	Method and Description
TestRecordHelper	action(Component comp, java.lang.String command, java.lang.String... params)
TestRecordHelper	action(java.lang.String command, java.lang.String window, java.lang.String component, java.lang.String... params)
void	addConfiguredClassInstance(java.lang.String classname, java.lang.Object object) normally only used internally to store objects as we instantiate them.
void	autorun(java.lang.String[] args) This is the critical method users could call to commence the automatic instantiation, configuration, and execution of JSAFSTest methods.
protected void	beforeRun() Prepare something before running.
TestRecordHelper	command(java.lang.String command, java.lang.String... params)
static void	debug(java.lang.String message)
AbstractDriver	driver()
static void	error(java.lang.String message)
java.lang.Object	getConfiguredClassInstance(java.lang.String classname) When using JSAFS to automatically instantiate, configure, and execute tests across many classes and packages the user can retrieve those otherwise unavailable class object instances here.
abstract AbstractDriver	getDriver() The model driver embedded with JSAFSDriver/InputProcessor, which will handle the keyword at the back-end.
abstract JavaHook	hookDriver()
DriverInterface	iDriver()
protected boolean	isRunning() The indicator tells if the runner/embedded-driver is running or not.
JSAFSDriver	jsafs()
void	logFAILED(java.lang.String message, java.lang.String detail)
void	logGENERIC(java.lang.String message, java.lang.String detail)
void	logMessage(java.lang.String msg, java.lang.String msgdescription, int msgtype)
void	logPASSED(java.lang.String message, java.lang.String detail)
InputProcessor	processor()
void	run() Initiates the embedded drivers and engines to start running if it is not already running.
void	setDriver(AbstractDriver driver)
void	terminate() Shutdown the driver and all related resources such as hooks, engines, services and logs etc.

Methods inherited from class java.lang.Object

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

Field Detail

ARG_AUTORUN_CLASS

public static final java.lang.String ARG_AUTORUN_CLASS

"-autorunclass", the parameter to indicate the class name to run test automatically.
Example, "-autorunclass autorun.full.classname".

See Also:

Constant Field Values

callers

protected static java.util.Vector<java.lang.Object> callers

instances

protected static java.util.Hashtable<java.lang.String,java.lang.Object> instances

running

protected boolean running

driver

protected AbstractDriver driver

The model driver embedded with JSAFSDriver/InputProcessor, which will handle the keyword at the back-end.

Constructor Detail

AbstractRunner

public AbstractRunner()

Method Detail

getConfiguredClassInstance

public java.lang.Object getConfiguredClassInstance(java.lang.String classname)

When using JSAFS to automatically instantiate, configure, and execute tests across many classes and packages the user can retrieve those otherwise unavailable class object instances here. This can be useful if the class instance will capture test execution information or data that you want to examine.

Specified by:

getConfiguredClassInstance in interface JSAFSConfiguredClassStore

Parameters:

classname - -- the full package name of the class to retrieve. ex: my.test.package.MyTest

Returns:

the object instance that was instantiated and used, or null if we have no instance of the specified class.

addConfiguredClassInstance

public void addConfiguredClassInstance(java.lang.String classname,
                                       java.lang.Object object)

normally only used internally to store objects as we instantiate them.

Specified by:

addConfiguredClassInstance in interface JSAFSConfiguredClassStore

Parameters:

classname - -- the full path case-sensitive Class name that was used to instantiate the object.

object - -- the object that was instantiated and used for processing.

getDriver

public abstract AbstractDriver getDriver()

The model driver embedded with JSAFSDriver/InputProcessor, which will handle the keyword at the back-end.

driver

public AbstractDriver driver()

Returns:

AbstractDriver, the AbstractDriver instance.

hookDriver

public abstract JavaHook hookDriver()

Returns:

JavaHook, the "embedded Hook" owned by some Runner/Driver.

setDriver

public void setDriver(AbstractDriver driver)

isRunning

protected boolean isRunning()

The indicator tells if the runner/embedded-driver is running or not.

run

public void run()
         throws java.lang.Exception

Initiates the embedded drivers and engines to start running if it is not already running. The user MUST call this method to ensure the drivers/engines are initialized before using them.

Throws:

java.lang.Exception

beforeRun

protected void beforeRun()

Prepare something before running.

See Also:

run()

terminate

public void terminate()
               throws java.lang.Exception

Shutdown the driver and all related resources such as hooks, engines, services and logs etc.

Throws:

java.lang.Exception

autorun

public void autorun(java.lang.String[] args)
             throws java.lang.Throwable

This is the critical method users could call to commence the automatic instantiation, configuration, and execution of JSAFSTest methods.

Minimalist example:

     public static void main(String[] args)throws Throwable{
         MyTestApp app = new MyTestApp();

         new Runner().autorun(args);
         ...
     }
 

Automatic configuration and usage is not required. The user can control test configuration and execution within their custom code if they want.

Parameters:

args - passed in from command-line Java-- the primordial main(String[] args)
Usually, it is the class who calls Runner.autorun() will be considered as
the class that is requesting the automatic configuration and execution, but we can also
change it by providing parameter as "-autorunclass autorun.full.classname".

Throws:

java.lang.Throwable

See Also:

JSAFSTest

iDriver

public DriverInterface iDriver()

jsafs

public JSAFSDriver jsafs()

processor

public InputProcessor processor()

action

public TestRecordHelper action(Component comp,
                               java.lang.String command,
                               java.lang.String... params)
                        throws java.lang.Throwable

Throws:

java.lang.Throwable

action

public TestRecordHelper action(java.lang.String command,
                               java.lang.String window,
                               java.lang.String component,
                               java.lang.String... params)
                        throws java.lang.Throwable

Throws:

java.lang.Throwable

command

public TestRecordHelper command(java.lang.String command,
                                java.lang.String... params)
                         throws java.lang.Throwable

Throws:

java.lang.Throwable

logMessage

public void logMessage(java.lang.String msg,
                       java.lang.String msgdescription,
                       int msgtype)

logGENERIC

public void logGENERIC(java.lang.String message,
                       java.lang.String detail)

logPASSED

public void logPASSED(java.lang.String message,
                      java.lang.String detail)

logFAILED

public void logFAILED(java.lang.String message,
                      java.lang.String detail)

debug

public static void debug(java.lang.String message)

error

public static void error(java.lang.String message)