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

Class DefaultForkConfiguration

java.lang.Object

org.apache.maven.plugin.surefire.booterclient.ForkConfiguration

org.apache.maven.plugin.surefire.booterclient.DefaultForkConfiguration

Direct Known Subclasses:

AbstractClasspathForkConfiguration, ModularClasspathForkConfiguration

public abstract class DefaultForkConfiguration
extends ForkConfiguration

Basic framework which constructs CLI.

Since:

2.21.0.Jigsaw

Field Summary

Fields

Modifier and Type	Field	Description
private final String	argLine
private final Classpath	booterClasspath
private final boolean	debug
private final String	debugLine
private final Map<String,String>	environmentVariables
private final String[]	excludedEnvironmentVariables
private final int	forkCount
private final ConsoleLogger	log
private final Properties	modelProperties
private final Platform	pluginPlatform
private final boolean	reuseForks
private final File	tempDirectory
private final File	workingDirectory

Fields inherited from class org.apache.maven.plugin.surefire.booterclient.ForkConfiguration

DEFAULT_PROVIDER_CLASS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultForkConfiguration(Classpath booterClasspath, File tempDirectory, String debugLine, File workingDirectory, Properties modelProperties, String argLine, Map<String,String> environmentVariables, String[] excludedEnvironmentVariables, boolean debug, int forkCount, boolean reuseForks, Platform pluginPlatform, ConsoleLogger log)

Method Summary

Modifier and Type	Method	Description
OutputStreamFlushableCommandline	createCommandLine(StartupConfiguration config, int forkNumber, File dumpLogDirectory)
protected String	extendJvmArgLine(String jvmArgLine)
private static String	findStartClass(StartupConfiguration config)
protected String	getArgLine()
protected Classpath	getBooterClasspath()
protected String	getDebugLine()
protected Map<String,String>	getEnvironmentVariables()
protected String[]	getExcludedEnvironmentVariables()
protected int	getForkCount()
protected JdkAttributes	getJdkForTests()
protected ConsoleLogger	getLogger()
protected Properties	getModelProperties()
protected Platform	getPluginPlatform()
File	getTempDirectory()
protected File	getWorkingDirectory()
private File	getWorkingDirectory(int forkNumber)
private String	interpolateArgLineWithPropertyExpressions()	Replaces expressions
protected boolean	isDebug()
protected boolean	isReuseForks()
private String	newJvmArgLine(int forks)
protected abstract void	resolveClasspath(OutputStreamFlushableCommandline cli, String booterThatHasMainMethod, StartupConfiguration config, File dumpLogDirectory)
private static String	stripNewLines(String argLine)
protected List<String>	toCompleteClasspath(StartupConfiguration conf)
private static <K, V> Map<K,V>	toImmutable(Map<K,V> map)	Immutable map.

Methods inherited from class java.lang.Object

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

Field Details

booterClasspath

@Nonnull
private final Classpath booterClasspath

tempDirectory

@Nonnull
private final File tempDirectory

debugLine

@Nullable
private final String debugLine

workingDirectory

@Nonnull
private final File workingDirectory

modelProperties

@Nonnull
private final Properties modelProperties

argLine

@Nullable
private final String argLine

environmentVariables

@Nonnull
private final Map<String,String> environmentVariables

excludedEnvironmentVariables

@Nonnull
private final String[] excludedEnvironmentVariables

debug

private final boolean debug

forkCount

private final int forkCount

reuseForks

private final boolean reuseForks

pluginPlatform

@Nonnull
private final Platform pluginPlatform

log

@Nonnull
private final ConsoleLogger log

Constructor Details

DefaultForkConfiguration

protected DefaultForkConfiguration(@Nonnull
 Classpath booterClasspath,
 @Nonnull
 File tempDirectory,
 @Nullable
 String debugLine,
 @Nonnull
 File workingDirectory,
 @Nonnull
 Properties modelProperties,
 @Nullable
 String argLine,
 @Nonnull
 Map<String,String> environmentVariables,
 @Nonnull
 String[] excludedEnvironmentVariables,
 boolean debug,
 int forkCount,
 boolean reuseForks,
 @Nonnull
 Platform pluginPlatform,
 @Nonnull
 ConsoleLogger log)

Method Details

resolveClasspath

protected abstract void resolveClasspath(@Nonnull
 OutputStreamFlushableCommandline cli,
 @Nonnull
 String booterThatHasMainMethod,
 @Nonnull
 StartupConfiguration config,
 @Nonnull
 File dumpLogDirectory)
                                  throws SurefireBooterForkException

Throws:

SurefireBooterForkException

extendJvmArgLine

@Nonnull
protected String extendJvmArgLine(@Nonnull
 String jvmArgLine)

createCommandLine

@Nonnull
public OutputStreamFlushableCommandline createCommandLine(@Nonnull
 StartupConfiguration config,
 int forkNumber,
 @Nonnull
 File dumpLogDirectory)
                                                   throws SurefireBooterForkException

Specified by:

createCommandLine in class ForkConfiguration

Parameters:

config - The startup configuration

forkNumber - index of forked JVM, to be the replacement in the argLine

dumpLogDirectory - directory for dump log file

Returns:

CommandLine able to flush entire command going to be sent to forked JVM

Throws:

SurefireBooterForkException - when unable to perform the fork

getLogger

protected ConsoleLogger getLogger()

toCompleteClasspath

@Nonnull
protected List<String> toCompleteClasspath(StartupConfiguration conf)
                                    throws SurefireBooterForkException

Throws:

SurefireBooterForkException

getWorkingDirectory

@Nonnull
private File getWorkingDirectory(int forkNumber)
                          throws SurefireBooterForkException

Throws:

SurefireBooterForkException

interpolateArgLineWithPropertyExpressions

@Nonnull
private String interpolateArgLineWithPropertyExpressions()

Replaces expressions

@{property-name}

with the corresponding properties from the model. This allows late evaluation of property values when the plugin is executed (as compared to evaluation when the pom is parsed as is done with

${property-name}

expressions). This allows other plugins to modify or set properties with the changes getting picked up by surefire.

stripNewLines

@Nonnull
private static String stripNewLines(@Nonnull
 String argLine)

toImmutable

@Nonnull
private static <K,
V> Map<K,V> toImmutable(@Nullable
 Map<K,V> map)

Immutable map.

Type Parameters:

K - key type

V - value type

Parameters:

map - immutable map copies elements from map

Returns:

never returns null

getTempDirectory

@Nonnull
public File getTempDirectory()

Specified by:

getTempDirectory in class ForkConfiguration

getDebugLine

@Nullable
protected String getDebugLine()

Specified by:

getDebugLine in class ForkConfiguration

getWorkingDirectory

@Nonnull
protected File getWorkingDirectory()

Specified by:

getWorkingDirectory in class ForkConfiguration

getModelProperties

@Nonnull
protected Properties getModelProperties()

Specified by:

getModelProperties in class ForkConfiguration

getArgLine

@Nullable
protected String getArgLine()

Specified by:

getArgLine in class ForkConfiguration

getEnvironmentVariables

@Nonnull
protected Map<String,String> getEnvironmentVariables()

Specified by:

getEnvironmentVariables in class ForkConfiguration

getExcludedEnvironmentVariables

@Nonnull
protected String[] getExcludedEnvironmentVariables()

Specified by:

getExcludedEnvironmentVariables in class ForkConfiguration

isDebug

protected boolean isDebug()

Specified by:

isDebug in class ForkConfiguration

getForkCount

protected int getForkCount()

Specified by:

getForkCount in class ForkConfiguration

isReuseForks

protected boolean isReuseForks()

Specified by:

isReuseForks in class ForkConfiguration

getPluginPlatform

@Nonnull
protected Platform getPluginPlatform()

Specified by:

getPluginPlatform in class ForkConfiguration

getJdkForTests

@Nonnull
protected JdkAttributes getJdkForTests()

Specified by:

getJdkForTests in class ForkConfiguration

getBooterClasspath

@Nonnull
protected Classpath getBooterClasspath()

Specified by:

getBooterClasspath in class ForkConfiguration

newJvmArgLine

@Nonnull
private String newJvmArgLine(int forks)

findStartClass

@Nonnull
private static String findStartClass(StartupConfiguration config)