com.segue.tm.published.api.testlaunch

Interface TestLaunchBean

All Known Implementing Classes:

AbstractTestLaunchBean, ExtProcessTestLaunchBean

public interface TestLaunchBean

Interface to be implemented by each test launch plugin to be integrated into Test Manager. A customer plugin needs to implement this interface in order to be integrated into TM. Directly implement this interface if a derivation from AbstractTestLaunchBean is not possible, as this class is more convenient to use. If an external process should be started, derive from ExtProcessTestLaunchBean instead.

Any method get<<property-name>> defines a property displayed in the GUI, for each there must be a corresponding set<<property-name>> method. In the plugin configuration file additional edit meta info for each property can be defined (e.g. textual description, default value, range,..).

An instance of an implementing class is associated to one test definition and created on the execution server before this test definition is to be executed. Next the initialize(com.segue.tm.published.api.testlaunch.TestLaunchPluginContext) method is called and all set<<property-name>> methods, supplying all property input the user has entered for a test definition to the plugin. Finally the execute(long, com.segue.tm.published.api.testlaunch.TestLaunchResultDrain) method is called, where the actual execution work has to be implemented.

Method Summary

Modifier and Type	Method and Description
boolean	execute(long time, TestLaunchResultDrain context) Called to execute a test definition and invoke the plugin's test execution implementation.
java.lang.String	getTestDefName() Must return the name of the test definition this instance is associated to.
boolean	initialize(TestLaunchPluginContext contextAccess) Called to initialize this instance and provide an access point to obtain infos from the framework context.
void	setTestDefName(java.lang.String testDefName) Called to supply the name of the test definition to this plugin instance.
void	terminate() Called to demand immediate termination while an execution takes currently place.

Method Detail

initialize

boolean initialize(TestLaunchPluginContext contextAccess)

Called to initialize this instance and provide an access point to obtain infos from the framework context. Currently this method is only called before a test definition is to be executed. The parameter passed can be stored to later obtain infos from the testing environment.

Parameters:

contextAccess - access to information like the root directory of the test container.

Returns:

true if initialization was successfull, false otherwise.

execute

boolean execute(long time,
                TestLaunchResultDrain context)
         throws java.lang.InterruptedException

Called to execute a test definition and invoke the plugin's test execution implementation. Is invoked at times specified by some schedule within the execution part or by "run-once".

Parameters:

time - The (logical) timestamp milliseconds after the epoch identifying this execution.

context - Container for holding results of the current run.

Returns:

true indicates test execution was successful, it's NOT about the result of the test itself!

Throws:

java.lang.InterruptedException - if the terminate() method was called while execution was in progress.

terminate

void terminate()

Called to demand immediate termination while an execution takes currently place. This method is called concurrently to the execute(long, com.segue.tm.published.api.testlaunch.TestLaunchResultDrain) method, which on reaction should throw an InterruptedException. This is typically if the user aborts the execution manually, a specified timeout has expired, or the execution server is shut down.

getTestDefName

java.lang.String getTestDefName()

Must return the name of the test definition this instance is associated to.

Returns:

the name of the test definition this instance is associated to.

setTestDefName

void setTestDefName(java.lang.String testDefName)

Called to supply the name of the test definition to this plugin instance.

Parameters:

testDefName - the name of the test definition this instance is associated to.