Package org.apache.maven.surefire.api.booter

Class ForkingRunListener

java.lang.Object

org.apache.maven.surefire.api.booter.ForkingRunListener

All Implemented Interfaces:

ConsoleLogger, RunListener, TestOutputReceiver<TestOutputReportEntry>, TestReportListener<TestOutputReportEntry>

public class ForkingRunListener
extends Object
implements TestReportListener<TestOutputReportEntry>

Encodes the full output of the test run to the "target".
This class and the ForkClient contain the full definition of the "wire-level" protocol used by the forked process. The protocol is *not* part of any public api and may change without further notice.
This class is thread-safe.
The synchronization in the underlying (target instance) is used to preserve thread safety of the target stream. To perform multiple writes/prints for a single request, they must synchronize on "target" variable in this class.

Author:

Kristian Rosenvold

Constructor Summary

Constructors

Constructor	Description
ForkingRunListener(MasterProcessChannelEncoder target, boolean trim)

Method Summary

Modifier and Type	Method	Description
void	debug(String message)
void	error(String message)
void	error(String message, Throwable t)
void	error(Throwable t)
void	info(String message)
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isInfoEnabled()
boolean	isWarnEnabled()
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
void	warning(String message)
void	writeTestOutput(TestOutputReportEntry reportEntry)	Forwards process output from the running test-case into the reporting system

Methods inherited from class java.lang.Object

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

Constructor Details

ForkingRunListener

public ForkingRunListener(MasterProcessChannelEncoder target,
 boolean trim)

Method Details

testSetStarting

public void testSetStarting(TestSetReportEntry report)

Description copied from interface: RunListener

Indicates the start of a given test-set

Specified by:

testSetStarting in interface RunListener

Parameters:

report - the report entry describing the testset

testSetCompleted

public void testSetCompleted(TestSetReportEntry report)

Description copied from interface: RunListener

Indicates end of a given test-set

Specified by:

testSetCompleted in interface RunListener

Parameters:

report - the report entry describing the testset

testStarting

public void testStarting(ReportEntry report)

Description copied from interface: RunListener

Event fired when a test is about to start

Specified by:

testStarting in interface RunListener

Parameters:

report - The report entry to log for

testSucceeded

public void testSucceeded(ReportEntry report)

Description copied from interface: RunListener

Event fired when a test ended successfully

Specified by:

testSucceeded in interface RunListener

Parameters:

report - The report entry to log for

testAssumptionFailure

public void testAssumptionFailure(ReportEntry report)

Description copied from interface: RunListener

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

Specified by:

testAssumptionFailure in interface RunListener

Parameters:

report - The report entry to log for

testError

public void testError(ReportEntry report)

Description copied from interface: RunListener

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

Specified by:

testError in interface RunListener

Parameters:

report - The report entry to log for

testFailed

public void testFailed(ReportEntry report)

Description copied from interface: RunListener

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

Specified by:

testFailed in interface RunListener

Parameters:

report - The report entry to log for

testSkipped

public void testSkipped(ReportEntry report)

Description copied from interface: RunListener

Event fired when a test is skipped

Specified by:

testSkipped in interface RunListener

Parameters:

report - The report entry to log for

testExecutionSkippedByUser

public void testExecutionSkippedByUser()

Description copied from interface: RunListener

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.)

Specified by:

testExecutionSkippedByUser in interface RunListener

writeTestOutput

public void writeTestOutput(TestOutputReportEntry reportEntry)

Description copied from interface: TestOutputReceiver

Forwards process output from the running test-case into the reporting system

Specified by:

writeTestOutput in interface TestOutputReceiver<TestOutputReportEntry>

Parameters:

reportEntry - wraps test output with descriptive information of the output

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface ConsoleLogger

debug

public void debug(String message)

Specified by:

debug in interface ConsoleLogger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface ConsoleLogger

info

public void info(String message)

Specified by:

info in interface ConsoleLogger

isWarnEnabled

public boolean isWarnEnabled()

Specified by:

isWarnEnabled in interface ConsoleLogger

warning

public void warning(String message)

Specified by:

warning in interface ConsoleLogger

isErrorEnabled

public boolean isErrorEnabled()

Specified by:

isErrorEnabled in interface ConsoleLogger

error

public void error(String message)

Specified by:

error in interface ConsoleLogger

error

public void error(String message,
 Throwable t)

Specified by:

error in interface ConsoleLogger

error

public void error(Throwable t)

Specified by:

error in interface ConsoleLogger