org.apache.maven.plugin.surefire.booterclient

Class ForkConfiguration

java.lang.Object

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

public class ForkConfiguration
extends java.lang.Object

Configuration for forking tests.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	argLine
private Classpath	bootClasspathConfiguration
private boolean	debug
private java.lang.String	debugLine
private java.util.Map<java.lang.String,java.lang.String>	environmentVariables
static java.lang.String	FORK_ALWAYS
static java.lang.String	FORK_NEVER
static java.lang.String	FORK_ONCE
static java.lang.String	FORK_PERTHREAD
private int	forkCount
private JdkAttributes	jdk
private java.util.Properties	modelProperties
private Platform	pluginPlatform
private boolean	reuseForks
private java.io.File	tempDirectory
private java.io.File	workingDirectory

Constructor Summary

Constructors

Constructor and Description
ForkConfiguration(Classpath bootClasspathConfiguration, java.io.File tmpDir, java.lang.String debugLine, JdkAttributes jdk, java.io.File workingDirectory, java.util.Properties modelProperties, java.lang.String argLine, java.util.Map<java.lang.String,java.lang.String> environmentVariables, boolean debugEnabled, int forkCount, boolean reuseForks, Platform pluginPlatform)

Method Summary

Modifier and Type	Method and Description
(package private) OutputStreamFlushableCommandline	createCommandLine(java.util.List<java.lang.String> classPath, boolean useJar, boolean shadefire, java.lang.String providerThatHasMainMethod, int threadNumber)
OutputStreamFlushableCommandline	createCommandLine(java.util.List<java.lang.String> classPath, StartupConfiguration config, int threadNumber)
private java.io.File	createJar(java.util.List<java.lang.String> classPath, java.lang.String startClassName) Create a jar with just a manifest containing a Main-Class entry for BooterConfiguration and a Class-Path entry for all classpath elements.
Classpath	getBootClasspath()
java.lang.String	getDebugLine()
static java.lang.String	getEffectiveForkMode(java.lang.String forkMode)
int	getForkCount()
Platform	getPluginPlatform()
java.io.File	getTempDirectory()
private java.io.File	getWorkingDirectory(int threadNumber)
boolean	isDebug()
boolean	isReuseForks()
private java.lang.String	replacePropertyExpressions() Replaces expressions
private java.lang.String	replaceThreadNumberPlaceholder(java.lang.String argLine, int threadNumber)
private static java.lang.String	stripNewLines(java.lang.String argLine)
private static <K,V> java.util.Map<K,V>	toImmutable(java.util.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 Detail

FORK_ONCE

public static final java.lang.String FORK_ONCE

See Also:

Constant Field Values

FORK_ALWAYS

public static final java.lang.String FORK_ALWAYS

See Also:

Constant Field Values

FORK_NEVER

public static final java.lang.String FORK_NEVER

See Also:

Constant Field Values

FORK_PERTHREAD

public static final java.lang.String FORK_PERTHREAD

See Also:

Constant Field Values

forkCount

private final int forkCount

reuseForks

private final boolean reuseForks

bootClasspathConfiguration

private final Classpath bootClasspathConfiguration

jdk

private final JdkAttributes jdk

modelProperties

private final java.util.Properties modelProperties

argLine

private final java.lang.String argLine

environmentVariables

private final java.util.Map<java.lang.String,java.lang.String> environmentVariables

workingDirectory

private final java.io.File workingDirectory

tempDirectory

private final java.io.File tempDirectory

debug

private final boolean debug

debugLine

private final java.lang.String debugLine

pluginPlatform

private final Platform pluginPlatform

Constructor Detail

ForkConfiguration

public ForkConfiguration(Classpath bootClasspathConfiguration,
                         java.io.File tmpDir,
                         java.lang.String debugLine,
                         JdkAttributes jdk,
                         java.io.File workingDirectory,
                         java.util.Properties modelProperties,
                         java.lang.String argLine,
                         java.util.Map<java.lang.String,java.lang.String> environmentVariables,
                         boolean debugEnabled,
                         int forkCount,
                         boolean reuseForks,
                         Platform pluginPlatform)

Method Detail

getBootClasspath

public Classpath getBootClasspath()

getEffectiveForkMode

public static java.lang.String getEffectiveForkMode(java.lang.String forkMode)

createCommandLine

public OutputStreamFlushableCommandline createCommandLine(java.util.List<java.lang.String> classPath,
                                                          StartupConfiguration config,
                                                          int threadNumber)
                                                   throws SurefireBooterForkException

Parameters:

classPath - cli the classpath arguments

config - The startup configuration

threadNumber - the thread number, to be the replacement in the argLine @return A commandline

Returns:

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

Throws:

SurefireBooterForkException - when unable to perform the fork

createCommandLine

OutputStreamFlushableCommandline createCommandLine(java.util.List<java.lang.String> classPath,
                                                   boolean useJar,
                                                   boolean shadefire,
                                                   java.lang.String providerThatHasMainMethod,
                                                   int threadNumber)
                                            throws SurefireBooterForkException

Throws:

SurefireBooterForkException

getWorkingDirectory

private java.io.File getWorkingDirectory(int threadNumber)
                                  throws SurefireBooterForkException

Throws:

SurefireBooterForkException

replaceThreadNumberPlaceholder

private java.lang.String replaceThreadNumberPlaceholder(java.lang.String argLine,
                                                        int threadNumber)

replacePropertyExpressions

private java.lang.String replacePropertyExpressions()

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.

createJar

private java.io.File createJar(java.util.List<java.lang.String> classPath,
                               java.lang.String startClassName)
                        throws java.io.IOException

Create a jar with just a manifest containing a Main-Class entry for BooterConfiguration and a Class-Path entry for all classpath elements.

Parameters:

classPath - List<String> of all classpath elements.

startClassName - The classname to start (main-class)

Returns:

The file pointint to the jar

Throws:

java.io.IOException - When a file operation fails.

isDebug

public boolean isDebug()

getDebugLine

public java.lang.String getDebugLine()

getTempDirectory

public java.io.File getTempDirectory()

getForkCount

public int getForkCount()

isReuseForks

public boolean isReuseForks()

getPluginPlatform

public Platform getPluginPlatform()

stripNewLines

private static java.lang.String stripNewLines(java.lang.String argLine)

toImmutable

private static <K,V> java.util.Map<K,V> toImmutable(java.util.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