Package org.apache.maven.plugin.surefire.booterclient.output

Class ForkClient

java.lang.Object

org.apache.maven.plugin.surefire.booterclient.output.ForkClient

All Implemented Interfaces:

org.apache.maven.shared.utils.cli.StreamConsumer

public class ForkClient
extends Object
implements org.apache.maven.shared.utils.cli.StreamConsumer

Knows how to reconstruct *all* the state transmitted over stdout by the forked process.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	ForkClient.AcquireNextTestListener
private final class	ForkClient.ByeListener
private final class	ForkClient.ConsoleListener
private final class	ForkClient.DebugListener
private final class	ForkClient.ErrorHandler
private class	ForkClient.ErrorListener
private final class	ForkClient.StdErrListener
private final class	ForkClient.StdOutListener
private final class	ForkClient.StopOnNextTestListener
private final class	ForkClient.SystemPropertiesListener
private final class	ForkClient.TestAssumptionFailureListener
private final class	ForkClient.TestErrorListener
private final class	ForkClient.TestFailedListener
private final class	ForkClient.TestSetCompletedListener
private final class	ForkClient.TestSetStartingListener
private final class	ForkClient.TestSkippedListener
private final class	ForkClient.TestStartingListener
private final class	ForkClient.TestSucceededListener
private final class	ForkClient.WarningListener

Field Summary

Fields

Modifier and Type	Field	Description
private final ForkedChannelDecoder	decoder
private final DefaultReporterFactory	defaultReporterFactory
private final ForkedChannelDecoderErrorHandler	errorHandler	Used by single Thread started by ThreadedStreamConsumer and therefore does not need to be volatile.
private StackTraceWriter	errorInFork
private final int	forkNumber
private final ConsoleLogger	log
private final NotifiableTestStream	notifiableTestStream
private static final String	PRINTABLE_JVM_NATIVE_STREAM
private final AtomicBoolean	printedErrorStream	prevents from printing same warning
private boolean	saidGoodBye	Written by one Thread and read by another: Main Thread and ForkStarter's Thread.
private static final long	START_TIME_NEGATIVE_TIMEOUT
private static final long	START_TIME_ZERO
private RunListener	testSetReporter
private final AtomicLong	testSetStartedAt	testSetStartedAt is set to non-zero after received ForkedChannelEncoder.testSetStarting(ReportEntry, boolean).
private final Queue<String>	testsInProgress
private final Map<String,String>	testVmSystemProperties

Constructor Summary

Constructors

Constructor	Description
ForkClient(DefaultReporterFactory defaultReporterFactory, NotifiableTestStream notifiableTestStream, ConsoleLogger log, AtomicBoolean printedErrorStream, int forkNumber)

Method Summary

Modifier and Type	Method	Description
void	close(boolean hadTimeout)
final void	consumeLine(String s)
final void	consumeMultiLineContent(String s)
private StackTraceWriter	deserializeStackTraceWriter(String stackTraceMessage, String smartStackTrace, String stackTrace)
private File	dumpToLoFile(String msg, Throwable e)
final DefaultReporterFactory	getDefaultReporterFactory()
final StackTraceWriter	getErrorInFork()
private ConsoleLogger	getOrCreateConsoleLogger()
private ConsoleOutputReceiver	getOrCreateConsoleOutputReceiver()
final RunListener	getReporter()	Used when getting reporters on the plugin side of a fork.
private RunListener	getTestSetReporter()
final Map<String,String>	getTestVmSystemProperties()
final boolean	hadTimeout()
boolean	hasTestsInProgress()
final boolean	isErrorInFork()
final boolean	isSaidGoodBye()
void	kill()
private void	logStreamWarning(String event, Throwable e)
private void	processLine(String event)
private void	setCurrentStartTime()
protected void	stopOnNextTest()	Overridden by a subclass, see ForkStarter.
Set<String>	testsInProgress()
final void	tryToTimeout(long currentTimeMillis, int forkedProcessTimeoutInSeconds)	Called in concurrent Thread.
private void	writeTestOutput(String output, boolean newLine, boolean isStdout)

Methods inherited from class java.lang.Object

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

Field Details

PRINTABLE_JVM_NATIVE_STREAM

private static final String PRINTABLE_JVM_NATIVE_STREAM

See Also:

• Constant Field Values

START_TIME_ZERO

private static final long START_TIME_ZERO

See Also:

• Constant Field Values

START_TIME_NEGATIVE_TIMEOUT

private static final long START_TIME_NEGATIVE_TIMEOUT

See Also:

• Constant Field Values

defaultReporterFactory

private final DefaultReporterFactory defaultReporterFactory

testVmSystemProperties

private final Map<String,String> testVmSystemProperties

notifiableTestStream

private final NotifiableTestStream notifiableTestStream

testsInProgress

private final Queue<String> testsInProgress

testSetStartedAt

private final AtomicLong testSetStartedAt

testSetStartedAt is set to non-zero after received ForkedChannelEncoder.testSetStarting(ReportEntry, boolean).

decoder

private final ForkedChannelDecoder decoder

log

private final ConsoleLogger log

printedErrorStream

private final AtomicBoolean printedErrorStream

prevents from printing same warning

forkNumber

private final int forkNumber

errorHandler

private final ForkedChannelDecoderErrorHandler errorHandler

Used by single Thread started by ThreadedStreamConsumer and therefore does not need to be volatile.

testSetReporter

private RunListener testSetReporter

saidGoodBye

private volatile boolean saidGoodBye

Written by one Thread and read by another: Main Thread and ForkStarter's Thread.

errorInFork

private volatile StackTraceWriter errorInFork

Constructor Details

ForkClient

public ForkClient(DefaultReporterFactory defaultReporterFactory,
 NotifiableTestStream notifiableTestStream,
 ConsoleLogger log,
 AtomicBoolean printedErrorStream,
 int forkNumber)

Method Details

stopOnNextTest

protected void stopOnNextTest()

Overridden by a subclass, see ForkStarter.

kill

public void kill()

tryToTimeout

public final void tryToTimeout(long currentTimeMillis,
 int forkedProcessTimeoutInSeconds)

Called in concurrent Thread. Will shutdown if timeout was reached.

Parameters:

currentTimeMillis - current time in millis seconds

forkedProcessTimeoutInSeconds - timeout in seconds given by MOJO

getDefaultReporterFactory

public final DefaultReporterFactory getDefaultReporterFactory()

consumeLine

public final void consumeLine(String s)

Specified by:

consumeLine in interface org.apache.maven.shared.utils.cli.StreamConsumer

setCurrentStartTime

private void setCurrentStartTime()

hadTimeout

public final boolean hadTimeout()

getTestSetReporter

private RunListener getTestSetReporter()

processLine

private void processLine(String event)

dumpToLoFile

private File dumpToLoFile(String msg,
 Throwable e)

logStreamWarning

private void logStreamWarning(String event,
 Throwable e)

writeTestOutput

private void writeTestOutput(String output,
 boolean newLine,
 boolean isStdout)

consumeMultiLineContent

public final void consumeMultiLineContent(String s)
                                   throws IOException

Throws:

IOException

getTestVmSystemProperties

public final Map<String,String> getTestVmSystemProperties()

getReporter

public final RunListener getReporter()

Used when getting reporters on the plugin side of a fork. Used by testing purposes only. May not be volatile variable.

Returns:

A mock provider reporter

getOrCreateConsoleOutputReceiver

private ConsoleOutputReceiver getOrCreateConsoleOutputReceiver()

getOrCreateConsoleLogger

private ConsoleLogger getOrCreateConsoleLogger()

close

public void close(boolean hadTimeout)

isSaidGoodBye

public final boolean isSaidGoodBye()

getErrorInFork

public final StackTraceWriter getErrorInFork()

isErrorInFork

public final boolean isErrorInFork()

testsInProgress

public Set<String> testsInProgress()

hasTestsInProgress

public boolean hasTestsInProgress()

deserializeStackTraceWriter

private StackTraceWriter deserializeStackTraceWriter(String stackTraceMessage,
 String smartStackTrace,
 String stackTrace)