Package org.apache.maven.plugin.surefire.report

Class TestSetRunListener

java.lang.Object

org.apache.maven.plugin.surefire.report.TestSetRunListener

All Implemented Interfaces:

ConsoleLogger, ConsoleOutputReceiver, RunListener

public class TestSetRunListener
extends Object
implements RunListener, ConsoleOutputReceiver, ConsoleLogger

Reports data for a single test set.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	briefOrPlainFormat
private final ConsoleOutputReportEventListener	consoleOutputReceiver
private final StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry,TestSetStats>	consoleReporter
private final TestSetStats	detailsForThis
private final StatelessTestsetInfoFileReportEventListener<WrappedReportEntry,TestSetStats>	fileReporter
private RunMode	runMode
private final StatelessReportEventListener<WrappedReportEntry,TestSetStats>	simpleXMLReporter
private final StatisticsReporter	statisticsReporter
private final Queue<TestMethodStats>	testMethodStats
private Utf8RecodingDeferredFileOutputStream	testStdErr
private Utf8RecodingDeferredFileOutputStream	testStdOut

Constructor Summary

Constructors

Constructor

Description

TestSetRunListener(StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry,TestSetStats> consoleReporter, StatelessTestsetInfoFileReportEventListener<WrappedReportEntry,TestSetStats> fileReporter, StatelessReportEventListener<WrappedReportEntry,TestSetStats> simpleXMLReporter, ConsoleOutputReportEventListener consoleOutputReceiver, StatisticsReporter statisticsReporter, boolean trimStackTrace, boolean isPlainFormat, boolean briefOrPlainFormat)

Method Summary

Modifier and Type	Method	Description
private void	addTestMethodStats()
private void	clearCapture()
void	close()
void	debug(String message)
void	error(String message)
void	error(String message, Throwable t)	Simply delegates to error( toString( t, message ) ).
void	error(Throwable t)	Simply delegates to method error(null, Throwable).
Queue<TestMethodStats>	getTestMethodStats()
void	info(String message)
private static Utf8RecodingDeferredFileOutputStream	initDeferred(String channel)
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isInfoEnabled()
boolean	isWarnEnabled()
private static int	lineBoundSymbolWidth(String message)
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 reportEntry)	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 reportEntry)	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 reportEntry)	Event fired when a test is skipped
void	testStarting(ReportEntry report)	Event fired when a test is about to start
void	testSucceeded(ReportEntry reportEntry)	Event fired when a test ended successfully
private static String	trimTrailingNewLine(String message)
void	warning(String message)
private WrappedReportEntry	wrap(ReportEntry other, ReportEntryType reportEntryType)
private WrappedReportEntry	wrapTestSet(TestSetReportEntry other)
void	writeTestOutput(String output, boolean newLine, 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 Details

testMethodStats

private final Queue<TestMethodStats> testMethodStats

detailsForThis

private final TestSetStats detailsForThis

consoleOutputReceiver

private final ConsoleOutputReportEventListener consoleOutputReceiver

briefOrPlainFormat

private final boolean briefOrPlainFormat

simpleXMLReporter

private final StatelessReportEventListener<WrappedReportEntry,TestSetStats> simpleXMLReporter

consoleReporter

private final StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry,TestSetStats> consoleReporter

fileReporter

private final StatelessTestsetInfoFileReportEventListener<WrappedReportEntry,TestSetStats> fileReporter

statisticsReporter

private final StatisticsReporter statisticsReporter

testStdOut

private Utf8RecodingDeferredFileOutputStream testStdOut

testStdErr

private Utf8RecodingDeferredFileOutputStream testStdErr

runMode

private volatile RunMode runMode

Constructor Details

TestSetRunListener

public TestSetRunListener(StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry,TestSetStats> consoleReporter,
 StatelessTestsetInfoFileReportEventListener<WrappedReportEntry,TestSetStats> fileReporter,
 StatelessReportEventListener<WrappedReportEntry,TestSetStats> simpleXMLReporter,
 ConsoleOutputReportEventListener consoleOutputReceiver,
 StatisticsReporter statisticsReporter,
 boolean trimStackTrace,
 boolean isPlainFormat,
 boolean briefOrPlainFormat)

Method Details

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

Parameters:

message - message to log

error

public void error(String message,
 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(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

writeTestOutput

public void writeTestOutput(String output,
 boolean newLine,
 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:

output - stdout/sterr output from running tests

newLine - print on new line

stdout - Indicates if this is stdout

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

clearCapture

private void clearCapture()

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

Description copied from interface: RunListener

Event fired when a test ended successfully

Specified by:

testSucceeded in interface RunListener

Parameters:

reportEntry - The report entry to log for

testError

public void testError(ReportEntry reportEntry)

Description copied from interface: RunListener

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

Specified by:

testError in interface RunListener

Parameters:

reportEntry - The report entry to log for

testFailed

public void testFailed(ReportEntry reportEntry)

Description copied from interface: RunListener

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

Specified by:

testFailed in interface RunListener

Parameters:

reportEntry - The report entry to log for

testSkipped

public void testSkipped(ReportEntry reportEntry)

Description copied from interface: RunListener

Event fired when a test is skipped

Specified by:

testSkipped in interface RunListener

Parameters:

reportEntry - 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

markAs

public RunMode markAs(RunMode currentRunMode)

Description copied from interface: RunListener

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

Specified by:

markAs in interface RunListener

Parameters:

currentRunMode - set current run

Returns:

previous run mode; never returns null

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

wrap

private WrappedReportEntry wrap(ReportEntry other,
 ReportEntryType reportEntryType)

wrapTestSet

private WrappedReportEntry wrapTestSet(TestSetReportEntry other)

close

public void close()

addTestMethodStats

private void addTestMethodStats()

getTestMethodStats

public Queue<TestMethodStats> getTestMethodStats()

trimTrailingNewLine

private static String trimTrailingNewLine(String message)

lineBoundSymbolWidth

private static int lineBoundSymbolWidth(String message)

initDeferred

private static Utf8RecodingDeferredFileOutputStream initDeferred(String channel)