com.segue.tm.published.api.testlaunch

Class TestCaseStartFinishSocketClient

java.lang.Object

com.segue.tm.published.api.testlaunch.TestCaseStartFinishSocketClient

public class TestCaseStartFinishSocketClient
extends java.lang.Object

When a test definition is not executed in the execution server process directly, used to communicate to SCTM, that a test case is about to start or has finished. When executing multiple test cases within one test definition and captured videos should be associated to specific test cases, an execution outside the execution server process is required to indicate beginning and ending of each test case. Using this class will send short textual messages to a dynamic port of the execution server process (see API help).

Constructor Summary

Constructors

Constructor and Description
TestCaseStartFinishSocketClient() Construct a session object connecting to the local execution server with a communication timeout of 10 seconds.
TestCaseStartFinishSocketClient(java.lang.String hostName) Construct a session object to the execution server on a arbitrary machine with a communication timeout of 10 seconds.
TestCaseStartFinishSocketClient(java.lang.String hostName, int socketTimeout) Construct a session object connecting to the execution server on a arbitrary machine with a user defined timeout.

Method Summary

Modifier and Type	Method and Description
void	close() Close this session when all test cases finished.
protected void	finalize()
boolean	indicateTestStart(java.lang.String testCaseName, java.lang.String extId) Used to communicate to the execution server, that a test case is about to start.
boolean	indicateTestStop(java.lang.String testName, java.lang.String extId, boolean success) Used to communicate to the execution server, that a test case has completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestCaseStartFinishSocketClient

public TestCaseStartFinishSocketClient()
                                throws java.net.UnknownHostException,
                                       java.io.IOException

Construct a session object connecting to the local execution server with a communication timeout of 10 seconds.

Throws:

java.net.UnknownHostException

java.io.IOException

TestCaseStartFinishSocketClient

public TestCaseStartFinishSocketClient(java.lang.String hostName)
                                throws java.net.UnknownHostException,
                                       java.io.IOException

Construct a session object to the execution server on a arbitrary machine with a communication timeout of 10 seconds.

Parameters:

hostName - the host name or IP address of the execution server

Throws:

java.net.UnknownHostException

java.io.IOException

TestCaseStartFinishSocketClient

public TestCaseStartFinishSocketClient(java.lang.String hostName,
                                       int socketTimeout)
                                throws java.net.UnknownHostException,
                                       java.io.IOException

Construct a session object connecting to the execution server on a arbitrary machine with a user defined timeout.

Parameters:

hostName - the host name or IP address of the execution server

socketTimeout - the time in milliseconds after which calls stop waiting for a response from the execution server.

Throws:

java.net.UnknownHostException

java.io.IOException

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public void close()

Close this session when all test cases finished. For performance reasons, do not construct a new object and thus communication session for each test case.

indicateTestStart

public boolean indicateTestStart(java.lang.String testCaseName,
                                 java.lang.String extId)
                          throws java.io.IOException

Used to communicate to the execution server, that a test case is about to start. Sends a corresponding 'START' message to the execution server process.

Parameters:

testCaseName - test case name that will appear in the video file name, characters not allowed for file names will be replaced.

extId - not used yet, should in future match the id of the test case as generated in the 'output.xml' file

Returns:

true if the message was successfully recognized by the execution server, false in case the request timed out or a parameter is invalid.

Throws:

java.io.IOException

indicateTestStop

public boolean indicateTestStop(java.lang.String testName,
                                java.lang.String extId,
                                boolean success)
                         throws java.io.IOException

Used to communicate to the execution server, that a test case has completed. Sends a corresponding 'FINISH' message to the execution server process. If video capturing is enabled in mode 'onError', the captured video will be dropped if parameter 'wasSuccess' is true.

Parameters:

testName - test case name that will appear in the video file name, characters not allowed for file names will be replaced.

extId - not used yet, should in future match the id of the test case as generated in the 'output.xml' file

success - indicates if the completed test case passed.

Returns:

true if the message was successfully recognized by the execution server, false in case the request timed out or a parameter is invalid.

Throws:

java.io.IOException