org.apache.maven.surefire.booter

Class ForkingRunListener

java.lang.Object

org.apache.maven.surefire.booter.ForkingRunListener

All Implemented Interfaces:

ConsoleLogger, ConsoleOutputReceiver, ConsoleStream, RunListener

public class ForkingRunListener
extends java.lang.Object
implements RunListener, ConsoleLogger, ConsoleOutputReceiver, ConsoleStream

Encodes the full output of the test run to the stdout stream.
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 threadsafe.
The synchronization in the underlying PrintStream (target instance) is used to preserve thread safety of the output stream. To perform multiple writes/prints for a single request, they must synchronize on "target" variable in this class.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	BOOTERCODE_BYE
static byte	BOOTERCODE_CONSOLE INFO logger
static byte	BOOTERCODE_DEBUG DEBUG logger
static byte	BOOTERCODE_ERROR ERROR logger
static byte	BOOTERCODE_NEXT_TEST
static byte	BOOTERCODE_STDERR
static byte	BOOTERCODE_STDOUT
static byte	BOOTERCODE_STOP_ON_NEXT_TEST
static byte	BOOTERCODE_SYSPROPS
static byte	BOOTERCODE_TEST_ASSUMPTIONFAILURE
static byte	BOOTERCODE_TEST_ERROR
static byte	BOOTERCODE_TEST_FAILED
static byte	BOOTERCODE_TEST_SKIPPED
static byte	BOOTERCODE_TEST_STARTING
static byte	BOOTERCODE_TEST_SUCCEEDED
static byte	BOOTERCODE_TESTSET_COMPLETED
static byte	BOOTERCODE_TESTSET_STARTING
static byte	BOOTERCODE_WARNING WARNING logger
private byte[]	stdErrHeader
private byte[]	stdOutHeader
private java.io.PrintStream	target
private int	testSetChannelId
private boolean	trimStackTraces

Constructor Summary

Constructors

Constructor and Description
ForkingRunListener(java.io.PrintStream target, int testSetChannelId, boolean trimStackTraces)

Method Summary

Modifier and Type	Method and Description
private void	append(java.lang.StringBuilder stringBuilder, byte b)
private void	append(java.lang.StringBuilder stringBuilder, java.lang.String message)
private static void	comma(java.lang.StringBuilder stringBuilder)
static byte[]	createHeader(byte booterCode, int testSetChannel)
void	debug(java.lang.String message)
private java.lang.String	encode(java.lang.String source)
private void	encode(java.lang.StringBuilder stringBuilder, StackTraceWriter stackTraceWriter)
static void	encode(java.lang.StringBuilder stringBuilder, StackTraceWriter stackTraceWriter, boolean trimStackTraces)
private void	encodeAndWriteToTarget(java.lang.String string)
void	error(java.lang.String message)
void	error(java.lang.String message, java.lang.Throwable t) Simply delegates to error( toString( t, message ) ).
void	error(java.lang.Throwable t) Simply delegates to method error(null, Throwable).
void	info(java.lang.String message)
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isInfoEnabled()
boolean	isWarnEnabled()
private void	log(byte bootCode, java.lang.String message)
private void	nullableEncoding(java.lang.StringBuilder stringBuilder, java.lang.Integer source)
private static void	nullableEncoding(java.lang.StringBuilder stringBuilder, java.lang.String source)
void	println(byte[] buf, int off, int len)
void	println(java.lang.String message)
private void	sendProps()
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
private java.lang.String	toPropertyString(java.lang.String key, java.lang.String value)
private java.lang.String	toString(byte operationCode, ReportEntry reportEntry, int testSetChannelId)
void	warning(java.lang.String message)
void	writeTestOutput(byte[] buf, int off, int len, boolean stdout) 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

Field Detail

BOOTERCODE_TESTSET_STARTING

public static final byte BOOTERCODE_TESTSET_STARTING

See Also:

Constant Field Values

BOOTERCODE_TESTSET_COMPLETED

public static final byte BOOTERCODE_TESTSET_COMPLETED

See Also:

Constant Field Values

BOOTERCODE_STDOUT

public static final byte BOOTERCODE_STDOUT

See Also:

Constant Field Values

BOOTERCODE_STDERR

public static final byte BOOTERCODE_STDERR

See Also:

Constant Field Values

BOOTERCODE_TEST_STARTING

public static final byte BOOTERCODE_TEST_STARTING

See Also:

Constant Field Values

BOOTERCODE_TEST_SUCCEEDED

public static final byte BOOTERCODE_TEST_SUCCEEDED

See Also:

Constant Field Values

BOOTERCODE_TEST_ERROR

public static final byte BOOTERCODE_TEST_ERROR

See Also:

Constant Field Values

BOOTERCODE_TEST_FAILED

public static final byte BOOTERCODE_TEST_FAILED

See Also:

Constant Field Values

BOOTERCODE_TEST_SKIPPED

public static final byte BOOTERCODE_TEST_SKIPPED

See Also:

Constant Field Values

BOOTERCODE_TEST_ASSUMPTIONFAILURE

public static final byte BOOTERCODE_TEST_ASSUMPTIONFAILURE

See Also:

Constant Field Values

BOOTERCODE_CONSOLE

public static final byte BOOTERCODE_CONSOLE

INFO logger

See Also:

ConsoleLogger.info(String), Constant Field Values

BOOTERCODE_SYSPROPS

public static final byte BOOTERCODE_SYSPROPS

See Also:

Constant Field Values

BOOTERCODE_NEXT_TEST

public static final byte BOOTERCODE_NEXT_TEST

See Also:

Constant Field Values

BOOTERCODE_STOP_ON_NEXT_TEST

public static final byte BOOTERCODE_STOP_ON_NEXT_TEST

See Also:

Constant Field Values

BOOTERCODE_ERROR

public static final byte BOOTERCODE_ERROR

ERROR logger

See Also:

ConsoleLogger.error(String), Constant Field Values

BOOTERCODE_BYE

public static final byte BOOTERCODE_BYE

See Also:

Constant Field Values

BOOTERCODE_DEBUG

public static final byte BOOTERCODE_DEBUG

DEBUG logger

See Also:

ConsoleLogger.debug(String), Constant Field Values

BOOTERCODE_WARNING

public static final byte BOOTERCODE_WARNING

WARNING logger

See Also:

ConsoleLogger.warning(String), Constant Field Values

target

private final java.io.PrintStream target

testSetChannelId

private final int testSetChannelId

trimStackTraces

private final boolean trimStackTraces

stdOutHeader

private final byte[] stdOutHeader

stdErrHeader

private final byte[] stdErrHeader

Constructor Detail

ForkingRunListener

public ForkingRunListener(java.io.PrintStream target,
                          int testSetChannelId,
                          boolean trimStackTraces)

Method Detail

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

sendProps

private void sendProps()

writeTestOutput

public void writeTestOutput(byte[] buf,
                            int off,
                            int len,
                            boolean stdout)

Description copied from interface: ConsoleOutputReceiver

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

Specified by:

writeTestOutput in interface ConsoleOutputReceiver

Parameters:

buf - the buffer to write

off - offset

len - len

stdout - Indicates if this is stdout

createHeader

public static byte[] createHeader(byte booterCode,
                                  int testSetChannel)

log

private void log(byte bootCode,
                 java.lang.String message)

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface ConsoleLogger

debug

public void debug(java.lang.String message)

Specified by:

debug in interface ConsoleLogger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface ConsoleLogger

info

public void info(java.lang.String message)

Specified by:

info in interface ConsoleLogger

isWarnEnabled

public boolean isWarnEnabled()

Specified by:

isWarnEnabled in interface ConsoleLogger

warning

public void warning(java.lang.String message)

Specified by:

warning in interface ConsoleLogger

isErrorEnabled

public boolean isErrorEnabled()

Specified by:

isErrorEnabled in interface ConsoleLogger

error

public void error(java.lang.String message)

Specified by:

error in interface ConsoleLogger

Parameters:

message - message to log

error

public void error(java.lang.String message,
                  java.lang.Throwable t)

Description copied from interface: ConsoleLogger

Simply delegates to error( toString( t, message ) ).

Specified by:

error in interface ConsoleLogger

Parameters:

message - message to log

t - exception, message and trace to log

error

public void error(java.lang.Throwable t)

Description copied from interface: ConsoleLogger

Simply delegates to method error(null, Throwable).

Specified by:

error in interface ConsoleLogger

Parameters:

t - exception, message and trace to log

encodeAndWriteToTarget

private void encodeAndWriteToTarget(java.lang.String string)

toPropertyString

private java.lang.String toPropertyString(java.lang.String key,
                                          java.lang.String value)

toString

private java.lang.String toString(byte operationCode,
                                  ReportEntry reportEntry,
                                  int testSetChannelId)

comma

private static void comma(java.lang.StringBuilder stringBuilder)

append

private void append(java.lang.StringBuilder stringBuilder,
                    java.lang.String message)

append

private void append(java.lang.StringBuilder stringBuilder,
                    byte b)

nullableEncoding

private void nullableEncoding(java.lang.StringBuilder stringBuilder,
                              java.lang.Integer source)

encode

private java.lang.String encode(java.lang.String source)

nullableEncoding

private static void nullableEncoding(java.lang.StringBuilder stringBuilder,
                                     java.lang.String source)

encode

private void encode(java.lang.StringBuilder stringBuilder,
                    StackTraceWriter stackTraceWriter)

encode

public static void encode(java.lang.StringBuilder stringBuilder,
                          StackTraceWriter stackTraceWriter,
                          boolean trimStackTraces)

println

public void println(java.lang.String message)

Specified by:

println in interface ConsoleStream

println

public void println(byte[] buf,
                    int off,
                    int len)

Specified by:

println in interface ConsoleStream