raccoon.api.eai.uitest.report
Interface IUnitTestResult

All Known Implementing Classes:

UiTestResult

public interface IUnitTestResult

The results of the execution of a single test.

Since:

Raccoon v0.7

Version:

$Id: IUnitTestResult.java,v 1.1 2004/08/08 20:25:56 crouvrais Exp $

Author:

Cedric ROUVRAIS

Field Summary

static int	ERROR This test couldn't be correctly executed.
static int	FAILED The execution of this test failed.
static int	SUCCESSFUL This test was successfully executed.
static int	WARNING Warnings were raised during the execution.

Method Summary

long	getExecutionTime() The time (in milliseconds) it took for this test to run.
java.lang.String	getName() Retrieves the name of the test this result corresponds to.
IReceivedMessage	getReceivedMessageAt(int pIndex) Gets the expected message that was received at the specified index.
java.util.List	getReceivedMessages() Retrieves the list of received expected messages.
java.util.HashMap	getStillWaiting() The list of events that haven't been received.
int	getTestResult() The result of the execution of the test.
java.lang.String	getUserMessage() A message that is user friendly.
int	receivedMsgSize() The number of expected messages that were received.

Field Detail

SUCCESSFUL

static final int SUCCESSFUL

This test was successfully executed. This means that all expected messages were received in time and that there no messages fired on the watch channels.

See Also:

Constant Field Values

FAILED

static final int FAILED

The execution of this test failed. This means that all expected messages weren't received on time.

See Also:

Constant Field Values

WARNING

static final int WARNING

Warnings were raised during the execution. This means that while this test was being undertaken warnings were fired on the related watch channels.

See Also:

Constant Field Values

ERROR

static final int ERROR

This test couldn't be correctly executed. This means that while this test was being undertaken errors were fired on the related watch channels or that the configuration of this test is incorrect: see the error message for more information.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Retrieves the name of the test this result corresponds to.

Returns:

the name of the test.

getUserMessage

java.lang.String getUserMessage()

A message that is user friendly. If this test failed or went in error then this string will provide useful information for the user.

Returns:

the message related to the results of the execution of this test.

getTestResult

int getTestResult()

The result of the execution of the test.

Returns:

one of SUCCESSFUL, FAILED, WARNING or ERROR.

getExecutionTime

long getExecutionTime()

The time (in milliseconds) it took for this test to run.

Returns:

the time elapsed since the first message was fired and the last expected message received.

receivedMsgSize

int receivedMsgSize()

The number of expected messages that were received.

Returns:

the number of received messages.

getReceivedMessageAt

IReceivedMessage getReceivedMessageAt(int pIndex)

Gets the expected message that was received at the specified index.

Parameters:

pIndex - the index of the expected message that was received.

Returns:

the information related to the expected message.

See Also:

receivedMsgSize()

getReceivedMessages

java.util.List getReceivedMessages()

Retrieves the list of received expected messages.

Returns:

the information related to the messages that were received as expected.

See Also:

getReceivedMessageAt(int), receivedMsgSize()

getStillWaiting

java.util.HashMap getStillWaiting()

The list of events that haven't been received.

Returns:

the list of still waiting elements.