Package org.apache.maven.surefire.report

Interface RunListener

All Known Implementing Classes:

ClassesParallelRunListener, ConcurrentRunListener, ForkingRunListener, MethodsParallelRunListener, MockReporter, TestSetRunListener

public interface RunListener

Used by providers to report results. Using this interface integrates the providers together into a common reporting infrastructure.
An instance of a reporter is not guaranteed to be thread-safe and concurrent test frameworks must request an instance of a reporter per-thread from the ReporterFactory.

Method Summary

Modifier and Type	Method	Description
RunMode	markAs(RunMode currentRunMode)	Marks the listener with run mode, e.g.
void	testAssumptionFailure(ReportEntry report)	Event fired when a test assumption failure was encountered.
void	testError(ReportEntry report)	Event fired when a test ended with an error (non anticipated problem)
void	testExecutionSkippedByUser()	Event fired skipping an execution of remaining test-set in other fork(s); or does nothing if no forks.
void	testFailed(ReportEntry report)	Event fired when a test ended with a failure (anticipated problem)
void	testSetCompleted(TestSetReportEntry report)	Indicates end of a given test-set
void	testSetStarting(TestSetReportEntry report)	Indicates the start of a given test-set
void	testSkipped(ReportEntry report)	Event fired when a test is skipped
void	testStarting(ReportEntry report)	Event fired when a test is about to start
void	testSucceeded(ReportEntry report)	Event fired when a test ended successfully

Method Detail

testSetStarting

void testSetStarting(TestSetReportEntry report)

Indicates the start of a given test-set

Parameters:

report - the report entry describing the testset

Throws:

ReporterException - When reporting fails

testSetCompleted

void testSetCompleted(TestSetReportEntry report)

Indicates end of a given test-set

Parameters:

report - the report entry describing the testset

Throws:

ReporterException - When reporting fails

testStarting

void testStarting(ReportEntry report)

Event fired when a test is about to start

Parameters:

report - The report entry to log for

testSucceeded

void testSucceeded(ReportEntry report)

Event fired when a test ended successfully

Parameters:

report - The report entry to log for

testAssumptionFailure

void testAssumptionFailure(ReportEntry report)

Event fired when a test assumption failure was encountered. An assumption failure indicates that the test is not relevant

Parameters:

report - The report entry to log for

testError

void testError(ReportEntry report)

Event fired when a test ended with an error (non anticipated problem)

Parameters:

report - The report entry to log for

testFailed

void testFailed(ReportEntry report)

Event fired when a test ended with a failure (anticipated problem)

Parameters:

report - The report entry to log for

testSkipped

void testSkipped(ReportEntry report)

Event fired when a test is skipped

Parameters:

report - The report entry to log for

testExecutionSkippedByUser

void testExecutionSkippedByUser()

Event fired skipping an execution of remaining test-set in other fork(s); or does nothing if no forks. The method is called by SurefireProvider.

(The event is fired after the Nth test failed to signal skipping the rest of test-set.)

markAs

RunMode markAs(RunMode currentRunMode)

Marks the listener with run mode, e.g. normal run or re-run.

Parameters:

currentRunMode - set current run

Returns:

previous run mode; never returns null

Throws:

java.lang.NullPointerException - if currentRunMode is null