Package org.apache.maven.plugin.surefire

Class SurefireHelper

java.lang.Object

org.apache.maven.plugin.surefire.SurefireHelper

public final class SurefireHelper
extends Object

Helper class for surefire plugins

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DUMP_FILE_DATE
static final String	DUMP_FILE_PREFIX
static final String	DUMP_FILENAME
static final String	DUMP_FILENAME_FORMATTER
private static final String[]	DUMP_FILES_PRINT
static final String	DUMPSTREAM_FILENAME
static final String	DUMPSTREAM_FILENAME_FORMATTER
static final String	EVENTS_BINARY_DUMP_FILENAME_FORMATTER
private static final String	FORK_NUMBER_PLACEHOLDER	The placeholder that is replaced by the executing fork's running number.
private static final int	MAX_PATH_LENGTH_WINDOWS	The maximum path that does not require long path prefix on Windows. See sun/nio/fs/WindowsPath in OpenJDK and MSDN article.
private static final String	THREAD_NUMBER_PLACEHOLDER	The placeholder that is replaced by the executing thread's running number.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SurefireHelper()	Do not instantiate.

Method Summary

Modifier and Type	Method	Description
static List<CommandLineOption>	commandLineOptions(org.apache.maven.execution.MavenSession session, PluginConsoleLogger log)
private static String	createErrorMessage(SurefireReportParameters reportParameters, RunResult result, Exception firstForkException)
static String	escapeToPlatformPath(String path)	Escape file path for Windows when the path is too long; otherwise returns path.
private static boolean	failIfNoTests(SurefireReportParameters reportParameters)
static String[]	getDumpFilesToPrint()
private static boolean	isFatal(Exception firstForkException)
private static boolean	isTooFlaky(RunResult result, SurefireReportParameters reportParameters)
static void	logDebugOrCliShowErrors(String s, PluginConsoleLogger log, Collection<CommandLineOption> cli)
static File	replaceForkThreadsInPath(File path, int replacement)
static String	replaceThreadNumberPlaceholders(String argLine, int threadNumber)
static void	reportExecution(SurefireReportParameters reportParameters, RunResult result, PluginConsoleLogger log, Exception firstForkException)
private static void	throwException(SurefireReportParameters reportParameters, RunResult result, Exception firstForkException)

Methods inherited from class java.lang.Object

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

Field Details

DUMP_FILE_DATE

private static final String DUMP_FILE_DATE

DUMP_FILE_PREFIX

public static final String DUMP_FILE_PREFIX

DUMP_FILENAME_FORMATTER

public static final String DUMP_FILENAME_FORMATTER

DUMPSTREAM_FILENAME_FORMATTER

public static final String DUMPSTREAM_FILENAME_FORMATTER

DUMPSTREAM_FILENAME

public static final String DUMPSTREAM_FILENAME

DUMP_FILENAME

public static final String DUMP_FILENAME

EVENTS_BINARY_DUMP_FILENAME_FORMATTER

public static final String EVENTS_BINARY_DUMP_FILENAME_FORMATTER

MAX_PATH_LENGTH_WINDOWS

private static final int MAX_PATH_LENGTH_WINDOWS

The maximum path that does not require long path prefix on Windows.
See sun/nio/fs/WindowsPath in OpenJDK and MSDN article.
The maximum path is 260 minus 1 (NUL) but for directories it is 260 minus 12 minus 1 (to allow for the creation of a 8.3 file in the directory).

See Also:

• Constant Field Values

DUMP_FILES_PRINT

private static final String[] DUMP_FILES_PRINT

THREAD_NUMBER_PLACEHOLDER

private static final String THREAD_NUMBER_PLACEHOLDER

The placeholder that is replaced by the executing thread's running number. The thread number range starts with 1 Deprecated.

See Also:

• Constant Field Values

FORK_NUMBER_PLACEHOLDER

private static final String FORK_NUMBER_PLACEHOLDER

The placeholder that is replaced by the executing fork's running number. The fork number range starts with 1

See Also:

• Constant Field Values

Constructor Details

SurefireHelper

private SurefireHelper()

Do not instantiate.

Method Details

replaceThreadNumberPlaceholders

@Nonnull
public static String replaceThreadNumberPlaceholders(@Nonnull
 String argLine,
 int threadNumber)

replaceForkThreadsInPath

public static File replaceForkThreadsInPath(File path,
 int replacement)

getDumpFilesToPrint

public static String[] getDumpFilesToPrint()

reportExecution

public static void reportExecution(SurefireReportParameters reportParameters,
 RunResult result,
 PluginConsoleLogger log,
 Exception firstForkException)
                            throws org.apache.maven.plugin.MojoFailureException,
org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

commandLineOptions

public static List<CommandLineOption> commandLineOptions(org.apache.maven.execution.MavenSession session,
 PluginConsoleLogger log)

logDebugOrCliShowErrors

public static void logDebugOrCliShowErrors(String s,
 PluginConsoleLogger log,
 Collection<CommandLineOption> cli)

escapeToPlatformPath

public static String escapeToPlatformPath(String path)

Escape file path for Windows when the path is too long; otherwise returns path.
See sun/nio/fs/WindowsPath for "long path" value explanation (=247), and MSDN article for detailed escaping strategy explanation: in short, \\?\ prefix for path with drive letter or \\?\UNC\ for UNC path.

Parameters:

path - source path

Returns:

escaped to platform path

failIfNoTests

private static boolean failIfNoTests(SurefireReportParameters reportParameters)

isFatal

private static boolean isFatal(Exception firstForkException)

throwException

private static void throwException(SurefireReportParameters reportParameters,
 RunResult result,
 Exception firstForkException)
                            throws org.apache.maven.plugin.MojoFailureException,
org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

createErrorMessage

private static String createErrorMessage(SurefireReportParameters reportParameters,
 RunResult result,
 Exception firstForkException)

isTooFlaky

private static boolean isTooFlaky(RunResult result,
 SurefireReportParameters reportParameters)