com.segue.tm.published.api.testlaunch

Interface TestLaunchResultDrain

public interface TestLaunchResultDrain

Allows to publish results produced by a single execution on the execution server. A reference is passed in TestLaunchBean.execute(long, com.segue.tm.published.api.testlaunch.TestLaunchResultDrain) giving the plugin implementation a chance to report back occurred errors, warnings, messages, files and log info.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OUTPUT_XML_RESULT_FILE The file name of the xml result file which contains result information that can be rendered by SCTM ("output.xml").
static int	SEVERITY_ERROR
static int	SEVERITY_FATAL
static int	SEVERITY_INFO
static int	SEVERITY_SUCCESS
static int	SEVERITY_WARNING

Method Summary

Modifier and Type	Method and Description
boolean	codeAnalysisIsOn() Returns true if the "Code Analysis" setting is switched on.
java.io.File	createFullCodeCoverageFile() Creates a full code coverage file associated to the execution plan run to be written in xml code coverage standard format by a plugin.
java.io.File	createTestCodeCoverageFile() Creates a code coverage file associated to the current test to be written in xml code coverage standard format by a plugin.
void	digestCodeCoverageResults() Deprecated. code coverage recording with remote access to OptimizeIt controller not supported anymore. Use createTestCodeCoverageFile()
ExecutionContextInfo	getExecutionContextInfo() Used to obtain execution related properties (e.g.
java.io.PrintStream	getLog() Provides a stream to publish log information into a log file and for online run info.
java.io.File	getTempResultsDir() Returns the path to a temporary directory exclusive for one execution.
void	indicateTestCaseFinished(java.lang.String testCaseName, java.lang.String extId, boolean wasSuccess) Used to communicate to SCTM, that a test case has completed.
void	indicateTestCaseStart(java.lang.String testCaseName, java.lang.String extId) Used to communicate to SCTM, that a test case is about to start.
void	parseStdResultFile(java.io.File file) Parses errors, warnings and messages from a standard result description xml file and publishes all messages.
void	parseStdResultFile(java.io.File file, int minimalPublishMessageSeverity) Parses errors, warnings and messages from a standard result description xml file and publishes messages with a severity equal or higher than the given minimalPublishMessageSeverity.
void	publishErrors(int errors, int warnings) Reports the number of errors and warnings of a test execution.
void	publishMessage(int severity, java.lang.String msg) Adds a message to the list of messages for one execution.
void	startCodeCoverageRecording(int port) Deprecated. use startCodeCoverageRecording(String, int)
void	startCodeCoverageRecording(java.lang.String fullCoverageID, int port) Deprecated. code coverage recording with remote access to OptimizeIt controller not supported anymore. Use createTestCodeCoverageFile()
boolean	testCaseStartFinishIndicationRequired() If true, the plugin is required to indicate beginning and ending of each sub test case, when executing multiple test cases within one test (for screen or video capturing).
void	updateErrors(int errors, int warnings) Updates (increments) the number of errors and warnings of a test execution.

Field Detail

SEVERITY_INFO

static final int SEVERITY_INFO

See Also:

Constant Field Values

SEVERITY_SUCCESS

static final int SEVERITY_SUCCESS

See Also:

Constant Field Values

SEVERITY_WARNING

static final int SEVERITY_WARNING

See Also:

Constant Field Values

SEVERITY_ERROR

static final int SEVERITY_ERROR

See Also:

Constant Field Values

SEVERITY_FATAL

static final int SEVERITY_FATAL

See Also:

Constant Field Values

OUTPUT_XML_RESULT_FILE

static final java.lang.String OUTPUT_XML_RESULT_FILE

The file name of the xml result file which contains result information that can be rendered by SCTM ("output.xml"). Please check the documentation (e.g. on "Windows Script Host Tests") for the structure of this output file.

See Also:

Constant Field Values

Method Detail

publishErrors

void publishErrors(int errors,
                   int warnings)

Reports the number of errors and warnings of a test execution. Overwrites previous values.

Parameters:

errors - the number of errors occured

warnings - the number of warnings occured

updateErrors

void updateErrors(int errors,
                  int warnings)

Updates (increments) the number of errors and warnings of a test execution.

Parameters:

errors - the amount to increment the error count

warnings - the amount to increment the warning count

publishMessage

void publishMessage(int severity,
                    java.lang.String msg)

Adds a message to the list of messages for one execution.

Parameters:

severity - the severity of the message being one of the SEVERITY_<XXX> constants.

msg - an arbitrary message displayed to the user.

parseStdResultFile

void parseStdResultFile(java.io.File file)

Parses errors, warnings and messages from a standard result description xml file and publishes all messages.

Parameters:

file - the path to the standard result file

parseStdResultFile

void parseStdResultFile(java.io.File file,
                        int minimalPublishMessageSeverity)

Parses errors, warnings and messages from a standard result description xml file and publishes messages with a severity equal or higher than the given minimalPublishMessageSeverity.

Parameters:

file - the path to the standard result file

minimalPublishMessageSeverity - only messages with this or a higher severity will be published

getTempResultsDir

java.io.File getTempResultsDir()

Returns the path to a temporary directory exclusive for one execution. Result files produced by an execution should be stored in this directory.

Returns:

the path to an exclusive temporary directory for each execution.

getLog

java.io.PrintStream getLog()

Provides a stream to publish log information into a log file and for online run info. Information written to this stream is stored in a "log.txt" included in the result file list of an test execution. Further, the so far published info can be viewed during execution as online run-info in the GUI. Launching an external process, the stream is typically passed to ExtProcessTestLaunchBean.runExternalProcess(java.lang.String[], java.lang.String[], java.io.File, java.io.PrintStream) to store and publish stdout and strerr output of the process. As the framework may also access this stream always synchronize on the object while writing to it in order to prevent concurrent access.

Returns:

a stream to publish log info kept in a log file and displayed on the frontend.

codeAnalysisIsOn

boolean codeAnalysisIsOn()

Returns true if the "Code Analysis" setting is switched on.

Returns:

true if the "Code Analysis" setting is switched on.

createTestCodeCoverageFile

java.io.File createTestCodeCoverageFile()
                                 throws java.io.IOException

Creates a code coverage file associated to the current test to be written in xml code coverage standard format by a plugin.

Throws:

java.io.IOException

createFullCodeCoverageFile

java.io.File createFullCodeCoverageFile()
                                 throws java.io.IOException

Creates a full code coverage file associated to the execution plan run to be written in xml code coverage standard format by a plugin.

Throws:

java.io.IOException

getExecutionContextInfo

ExecutionContextInfo getExecutionContextInfo()

Used to obtain execution related properties (e.g. name of execution definition) and keywords.

testCaseStartFinishIndicationRequired

boolean testCaseStartFinishIndicationRequired()

If true, the plugin is required to indicate beginning and ending of each sub test case, when executing multiple test cases within one test (for screen or video capturing). This can be done by calling indicateTestCaseStart(String, String) and indicateTestCaseFinished(String, String, boolean). If the test runs in a separate process, messages must be sent to the port stored in ExecutionContextInfo.ExecProperty.PORT_TESTCASE_START_FINISH (see API help and TestCaseStartFinishSocketClient.indicateTestStart(java.lang.String, java.lang.String)).

Returns:

true, if the plugin is required to indicate beginning and ending of each sub test case, when executing multiple test cases within one test.

indicateTestCaseStart

void indicateTestCaseStart(java.lang.String testCaseName,
                           java.lang.String extId)

Used to communicate to SCTM, that a test case is about to start. When executing multiple sub test cases within one test and captured videos should be associated to specific test cases, a plugin is required to indicate beginning and ending of each test case. If the test runs in a separate process, a message must be sent to the port stored in ExecutionContextInfo.ExecProperty.PORT_TESTCASE_START_FINISH (see API help and TestCaseStartFinishSocketClient.indicateTestStart(java.lang.String, java.lang.String)).

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

See Also:

indicateTestCaseFinished(String, String, boolean)

indicateTestCaseFinished

void indicateTestCaseFinished(java.lang.String testCaseName,
                              java.lang.String extId,
                              boolean wasSuccess)

Used to communicate to SCTM, that a test case has completed. When executing multiple test cases within one test definition and recorded videos should be associated to specific test cases, a plugin is required to indicate beginning and ending of each test case. If video capturing is enabled in mode 'onError', the captured video will be dropped if parameter 'wasSuccess' is true.

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

wasSuccess - indicates if the completed test case passed.

See Also:

indicateTestCaseStart(String, String)

startCodeCoverageRecording

@Deprecated
void startCodeCoverageRecording(java.lang.String fullCoverageID,
                                             int port)

Deprecated. code coverage recording with remote access to OptimizeIt controller not supported anymore. Use createTestCodeCoverageFile()

Initiates code coverage recording of a Java vm equipped with an OptimizeIt coverage controller. This can only be called once during an execution.

Parameters:

fullCoverageID - if multiple test executions pass an equal value, full coverage is only fetched for the first call, saving time.

port - the tcp port on which the code coverage controller can be accessed.

startCodeCoverageRecording

@Deprecated
void startCodeCoverageRecording(int port)

Deprecated. use startCodeCoverageRecording(String, int)

Initiates code coverage recording of a Java vm equipped with an OptimizeIt coverage controller. This can only be called once during an execution.

Parameters:

port - the tcp port on which the code coverage controller can be accessed.

digestCodeCoverageResults

@Deprecated
void digestCodeCoverageResults()

Deprecated. code coverage recording with remote access to OptimizeIt controller not supported anymore. Use createTestCodeCoverageFile()

Stops code coverage recording and stores recorded results. This can only be called once during an execution if startCodeCoverageRecording(java.lang.String, int) has been called before.