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

Class ForkClient

java.lang.Object

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

All Implemented Interfaces:

EventHandler<Event>

public final class ForkClient
extends Object
implements EventHandler<Event>

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 class	ForkClient.ErrorListener
private final class	ForkClient.ExitErrorEventListener
private final class	ForkClient.StdErrListener
private final class	ForkClient.StdOutListener
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 DefaultReporterFactory	defaultReporterFactory
private StackTraceWriter	errorInFork
private final int	forkNumber
private final NotifiableTestStream	notifiableTestStream
private final ForkedProcessEventNotifier	notifier
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 TestReportListener<TestOutputReportEntry>	testSetReporter
private final AtomicLong	testSetStartedAt	testSetStartedAt is set to non-zero after received MasterProcessChannelEncoder.testSetStarting(TestSetReportEntry, boolean).
private final Queue<String>	testsInProgress
private final Map<String,String>	testVmSystemProperties

Constructor Summary

Constructors

Constructor	Description
ForkClient(DefaultReporterFactory defaultReporterFactory, NotifiableTestStream notifiableTestStream, int forkNumber)

Method Summary

Modifier and Type	Method	Description
void	close(boolean hadTimeout)
(package private) void	dumpToLoFile(String msg)
TestOutputReceiver<TestOutputReportEntry>	getConsoleOutputReceiver()
DefaultReporterFactory	getDefaultReporterFactory()
StackTraceWriter	getErrorInFork()
private ConsoleLogger	getOrCreateConsoleLogger()
RunListener	getReporter()	Used when getting reporters on the plugin side of a fork.
private TestReportListener<TestOutputReportEntry>	getTestSetReporter()	Only getConsoleOutputReceiver() may call this method in another Thread.
Map<String,String>	getTestVmSystemProperties()
boolean	hadTimeout()
void	handleEvent(Event event)
boolean	hasTestsInProgress()
boolean	isErrorInFork()
boolean	isSaidGoodBye()
void	kill()
private void	setCurrentStartTime()
void	setStopOnNextTestListener(ForkedProcessEventListener listener)
Set<String>	testsInProgress()
void	tryToTimeout(long currentTimeMillis, int forkedProcessTimeoutInSeconds)	Called in concurrent Thread.
private void	writeTestOutput(String output, boolean isStdout, boolean newLine, RunMode runMode, Long testRunId)

Methods inherited from class java.lang.Object

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

Field Details

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 MasterProcessChannelEncoder.testSetStarting(TestSetReportEntry, boolean).

notifier

private final ForkedProcessEventNotifier notifier

forkNumber

private final int forkNumber

testSetReporter

private volatile TestReportListener<TestOutputReportEntry> 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,
 int forkNumber)

Method Details

setStopOnNextTestListener

public void setStopOnNextTestListener(ForkedProcessEventListener listener)

kill

public void kill()

tryToTimeout

public 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 DefaultReporterFactory getDefaultReporterFactory()

handleEvent

public void handleEvent(@Nonnull
 Event event)

Specified by:

handleEvent in interface EventHandler<Event>

setCurrentStartTime

private void setCurrentStartTime()

hadTimeout

public boolean hadTimeout()

getTestSetReporter

private TestReportListener<TestOutputReportEntry> getTestSetReporter()

Only getConsoleOutputReceiver() may call this method in another Thread.

dumpToLoFile

void dumpToLoFile(String msg)

writeTestOutput

private void writeTestOutput(String output,
 boolean isStdout,
 boolean newLine,
 RunMode runMode,
 Long testRunId)

getTestVmSystemProperties

public Map<String,String> getTestVmSystemProperties()

getReporter

public 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

getConsoleOutputReceiver

public TestOutputReceiver<TestOutputReportEntry> getConsoleOutputReceiver()

getOrCreateConsoleLogger

private ConsoleLogger getOrCreateConsoleLogger()

close

public void close(boolean hadTimeout)

isSaidGoodBye

public boolean isSaidGoodBye()

getErrorInFork

public StackTraceWriter getErrorInFork()

isErrorInFork

public boolean isErrorInFork()

testsInProgress

public Set<String> testsInProgress()

hasTestsInProgress

public boolean hasTestsInProgress()