Package org.apache.maven.surefire.booter

Class ForkedBooter

java.lang.Object

org.apache.maven.surefire.booter.ForkedBooter

public final class ForkedBooter
extends Object

The part of the booter that is unique to a forked vm.
Deals with deserialization of the booter wire-level protocol

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ForkedBooter.PingScheduler

Field Summary

Fields

Modifier and Type	Field	Description
private MasterProcessChannelProcessorFactory	channelProcessorFactory
private CommandReader	commandReader
private static final long	DEFAULT_SYSTEM_EXIT_TIMEOUT_IN_SECONDS
private MasterProcessChannelEncoder	eventChannel
private final Semaphore	exitBarrier
private ForkingReporterFactory	forkingReporterFactory
private ScheduledThreadPoolExecutor	jvmTerminator
private static final String	LAST_DITCH_SHUTDOWN_THREAD
private ConsoleLogger	logger
private static final String	PING_THREAD
private static final long	PING_TIMEOUT_IN_SECONDS
private ForkedBooter.PingScheduler	pingScheduler
private static final String	PROCESS_CHECKER_THREAD
private static final String	PROCESS_PIPES_ERROR
private ProviderConfiguration	providerConfiguration
private StartupConfiguration	startupConfiguration
private long	systemExitTimeoutInSeconds
private Object	testSet

Constructor Summary

Constructors

Constructor	Description
ForkedBooter()

Method Summary

Modifier and Type	Method	Description
private void	acknowledgedExit()
private static boolean	acquireOnePermit(Semaphore barrier)
private void	cancelPingScheduler()
private static boolean	canUseNewPingMechanism(PpidChecker pluginProcessChecker)
private void	closeForkChannel()
private CommandListener	createExitHandler(PpidChecker ppidChecker)
private ForkingReporterFactory	createForkingReporterFactory()
private CommandListener	createPingHandler(AtomicBoolean pingDone)
private Runnable	createPingJob(AtomicBoolean pingDone, PpidChecker pluginProcessChecker)
private SurefireProvider	createProviderInCurrentClassloader()
private static ScheduledExecutorService	createScheduler(String threadName)
private static InputStream	createSurefirePropertiesIfFileExists(String tmpDir, String propFileName)
private Object	createTestSet(TypeEncodedValue forkedTestSet, boolean readTestsFromCommandReader, ClassLoader cl)
private void	execute()
private void	exit1()
private void	flushEventChannelOnExit()	Necessary for the Surefire817SystemExitIT.
private static String	generateThreadDump()
private ScheduledThreadPoolExecutor	getJvmTerminator()
private static String	getProcessName()
private static boolean	isDebugging()
private void	kill()
private void	kill(int returnCode)
private void	launchLastDitchDaemonShutdownThread(int returnCode)
private ForkedBooter.PingScheduler	listenToShutdownCommands(String ppid)
private static MasterProcessChannelProcessorFactory	lookupDecoderFactory(String channelConfig)
static void	main(String[] args)	This method is invoked when Surefire is forked - this method parses and organizes the arguments passed to it and then calls the Surefire class' run method.
private Runnable	processCheckerJob(ForkedBooter.PingScheduler pingMechanism)
private static void	run(ForkedBooter booter, String[] args)	created for testing purposes.
private void	runSuitesInProcess()
private void	setupBooter(String tmpDir, String dumpFileName, String surefirePropsFileName, String effectiveSystemPropertiesFileName)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SYSTEM_EXIT_TIMEOUT_IN_SECONDS

private static final long DEFAULT_SYSTEM_EXIT_TIMEOUT_IN_SECONDS

See Also:

• Constant Field Values

PING_TIMEOUT_IN_SECONDS

private static final long PING_TIMEOUT_IN_SECONDS

See Also:

• Constant Field Values

LAST_DITCH_SHUTDOWN_THREAD

private static final String LAST_DITCH_SHUTDOWN_THREAD

See Also:

• Constant Field Values

PING_THREAD

private static final String PING_THREAD

See Also:

• Constant Field Values

PROCESS_CHECKER_THREAD

private static final String PROCESS_CHECKER_THREAD

See Also:

• Constant Field Values

PROCESS_PIPES_ERROR

private static final String PROCESS_PIPES_ERROR

See Also:

• Constant Field Values

exitBarrier

private final Semaphore exitBarrier

eventChannel

private volatile MasterProcessChannelEncoder eventChannel

logger

private volatile ConsoleLogger logger

channelProcessorFactory

private volatile MasterProcessChannelProcessorFactory channelProcessorFactory

commandReader

private volatile CommandReader commandReader

systemExitTimeoutInSeconds

private volatile long systemExitTimeoutInSeconds

pingScheduler

private volatile ForkedBooter.PingScheduler pingScheduler

jvmTerminator

private ScheduledThreadPoolExecutor jvmTerminator

providerConfiguration

private ProviderConfiguration providerConfiguration

forkingReporterFactory

private ForkingReporterFactory forkingReporterFactory

startupConfiguration

private StartupConfiguration startupConfiguration

testSet

private Object testSet

Constructor Details

ForkedBooter

public ForkedBooter()

Method Details

setupBooter

private void setupBooter(String tmpDir,
 String dumpFileName,
 String surefirePropsFileName,
 String effectiveSystemPropertiesFileName)
                  throws IOException

Throws:

IOException

execute

private void execute()

createTestSet

private Object createTestSet(TypeEncodedValue forkedTestSet,
 boolean readTestsFromCommandReader,
 ClassLoader cl)

cancelPingScheduler

private void cancelPingScheduler()

closeForkChannel

private void closeForkChannel()

listenToShutdownCommands

private ForkedBooter.PingScheduler listenToShutdownCommands(String ppid)

processCheckerJob

private Runnable processCheckerJob(ForkedBooter.PingScheduler pingMechanism)

createPingHandler

private CommandListener createPingHandler(AtomicBoolean pingDone)

createExitHandler

private CommandListener createExitHandler(PpidChecker ppidChecker)

createPingJob

private Runnable createPingJob(AtomicBoolean pingDone,
 PpidChecker pluginProcessChecker)

kill

private void kill()

kill

private void kill(int returnCode)

exit1

private void exit1()

acknowledgedExit

private void acknowledgedExit()

runSuitesInProcess

private void runSuitesInProcess()
                         throws TestSetFailedException,
InvocationTargetException

Throws:

TestSetFailedException

InvocationTargetException

createForkingReporterFactory

private ForkingReporterFactory createForkingReporterFactory()

getJvmTerminator

private ScheduledThreadPoolExecutor getJvmTerminator()

launchLastDitchDaemonShutdownThread

private void launchLastDitchDaemonShutdownThread(int returnCode)

createProviderInCurrentClassloader

private SurefireProvider createProviderInCurrentClassloader()

flushEventChannelOnExit

private void flushEventChannelOnExit()

Necessary for the Surefire817SystemExitIT.

lookupDecoderFactory

private static MasterProcessChannelProcessorFactory lookupDecoderFactory(String channelConfig)

main

public static void main(String[] args)

This method is invoked when Surefire is forked - this method parses and organizes the arguments passed to it and then calls the Surefire class' run method.
The system exit code will be 1 if an exception is thrown.

Parameters:

args - Commandline arguments

run

private static void run(ForkedBooter booter,
 String[] args)

created for testing purposes.

Parameters:

booter - booter in JVM

args - arguments passed to JVM

canUseNewPingMechanism

private static boolean canUseNewPingMechanism(PpidChecker pluginProcessChecker)

acquireOnePermit

private static boolean acquireOnePermit(Semaphore barrier)

createScheduler

private static ScheduledExecutorService createScheduler(String threadName)

createSurefirePropertiesIfFileExists

private static InputStream createSurefirePropertiesIfFileExists(String tmpDir,
 String propFileName)
                                                         throws FileNotFoundException

Throws:

FileNotFoundException

isDebugging

private static boolean isDebugging()

generateThreadDump

private static String generateThreadDump()

getProcessName

private static String getProcessName()