Maven Failsafe Plugin

https://maven.apache.org/surefire/maven-failsafe-plugin/
Admin
The Failsafe Plugin is designed to run integration tests as part of the Maven build lifecycle,...
Tokens:60,275
Snippets:697
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure dependenciesToScan patterns

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Examples of dependency patterns for scanning test classes.

```text
group or, equivalently, group:*
```

```text
g*p:*rtifac*
```

```text
group:*:jar
```

```text
group:artifact:*:1.0.0
```

```text
group:*:test-jar:tests
```

```text
*:artifact:*:*:1.0.0
```

--------------------------------

### Test Execution Pattern Examples

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/xref/org/apache/maven/plugin/failsafe/IntegrationTestMojo.html

Examples of complex syntax for the it.test parameter to filter integration tests.

```text
"-Dit.test=???IT, !Unstable*, pkg/**/Ci*leIT.java, *IT#test*One+testTwo?????, #fast*+slowTest"
```

```text
"-Dit.test=Basic*, !%regex[.*.Unstable.*], !%regex[.*.MyIT.class#one.*|two.*], %regex[#fast.*|slow.*]"
```

--------------------------------

### Configure Failsafe Process Checker

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/xref/org/apache/maven/plugin/failsafe/IntegrationTestMojo.html

Example of enabling the process checker via command line.

```bash
mvn test -Dfailsafe.enableProcessChecker=all
```

--------------------------------

### Configure Jetty to Stop Before Starting

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/usage.html

Add the stop goal to the pre-integration-test phase to ensure any existing Jetty instance is terminated before starting a new one.

```xml
  1. <project>
  2.   [...]
  3.   <build>
  4.     [...]
  5.     <plugins>
  6.       [...]
  7.       <plugin>
  8.         <groupId>org.eclipse.jetty</groupId>
  9.         <artifactId>jetty-maven-plugin</artifactId>
  10.         <version>9.2.2.v20140723</version>
  11.         [...]
  12.         <executions>
  13.           [...]
  14.           <execution>
  15.             <id>start-jetty</id>
  16.             <phase>pre-integration-test</phase>
  17.             <goals>
  18.               <!-- stop any previous instance to free up the port -->
  19.               <goal>stop</goal>
  20.               <goal>start</goal>
  21.             </goals>
  22.             [...]
  23.           </execution>
  24.           [...]
  25.         </executions>
  26.         [...]
  27.       </plugin>
  28.       [...]
  29.     </plugins>
  30.     [...]
  31.   </build>
  32.   [...]
  33. </project>
```

--------------------------------

### Include patterns configuration

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Example of defining path, simple, and regex include patterns within an includes file.

```text
  1.   2. */it/*
  3. **/NotIncludedByDefault.java
  4. %regex[.*IT.*|.*Not.*]
```

--------------------------------

### Example toolchains.xml for JDK Toolchains

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/java9.html

Define toolchain configurations for different JDK versions, including paths, in the toolchains.xml file.

```xml
<toolchains xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/TOOLCHAINS/1.1.0 https://maven.apache.org/xsd/toolchains-1.1.0.xsd">
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>1.8</version>
      <vendor>sun</vendor>
      <id>jdk8</id>
    </provides>
    <configuration>
      <jdkHome>/path/to/openjdk8</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>11</version>
      <vendor>sun</vendor>
      <id>jdk11</id>
    </provides>
    <configuration>
      <jdkHome>/path/to/openjdk/11</jdkHome>
    </configuration>
  </toolchain>
</toolchains>

```

--------------------------------

### Enable Detailed Console Logs

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/logging.html

Example output showing detailed logs enabled by using Maven CLI debug options.

```text
  1. [INFO] Surefire report directory: /path/to/project/target/surefire-reports
  2. [INFO] Using configured provider org.apache.maven.surefire.junitcore.JUnitCoreProvider
  3. [INFO] parallel='none', perCoreThreadCount=true, threadCount=0, useUnlimitedThreads=false, threadCountSuites=0, threadCountClasses=0, threadCountMethods=0, parallelOptimized=true
  4. Configuring TestNG with: TestNGMapConfigurator
```

--------------------------------

### Configure Maven Failsafe and Jetty Plugins

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/usage.html

Bind jetty:start to pre-integration-test and jetty:stop to post-integration-test to manage the server lifecycle during integration tests.

```xml
  1. <project>
  2.   [...]
  3.   <build>
  4.     [...]
  5.     <plugins>
  6.       [...]
  7.       <plugin>
  8.         <groupId>org.apache.maven.plugins</groupId>
  9.         <artifactId>maven-failsafe-plugin</artifactId>
  10.         <version>3.6.0-M1</version>
  11.         <executions>
  12.           <execution>
  13.             <id>integration-test</id>
  14.             <goals>
  15.               <goal>integration-test</goal>
  16.             </goals>
  17.           </execution>
  18.           <execution>
  19.             <id>verify</id>
  20.             <goals>
  21.               <goal>verify</goal>
  22.             </goals>
  23.           </execution>
  24.         </executions>
  25.       </plugin>
  26.       <plugin>
  27.         <groupId>org.eclipse.jetty</groupId>
  28.         <artifactId>jetty-maven-plugin</artifactId>
  29.         <version>9.2.2.v20140723</version>
  30.         [...]
  31.         <configuration>
  32.           [...]
  33.           <scanIntervalSeconds>10</scanIntervalSeconds>
  34.           <stopPort>8005</stopPort>
  35.           <stopKey>STOP</stopKey>
  36.           [...]
  37.         </configuration>
  38.         [...]
  39.         <executions>
  40.           [...]
  41.           <execution>
  42.             <id>start-jetty</id>
  43.             <phase>pre-integration-test</phase>
  44.             <goals>
  45.               <goal>start</goal>
  46.             </goals>
  47.             <configuration>
  48.               <scanIntervalSeconds>0</scanIntervalSeconds>
  49.               <daemon>true</daemon>
  50.             </configuration>
  51.           </execution>
  52.           <execution>
  53.             <id>stop-jetty</id>
  54.             <phase>post-integration-test</phase>
  55.             <goals>
  56.               <goal>stop</goal>
  57.             </goals>
  58.           </execution>
  59.           [...]
  60.         </executions>
  61.         [...]
  62.       </plugin>
  63.       [...]
  64.     </plugins>
  65.     [...]
  66.   </build>
  67.   [...]
  68. </project>
```

--------------------------------

### Example Output for Flaky Test Success

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/rerun-failing-tests.html

Shows the console output format when a test fails initially but passes on a subsequent retry.

```text
  1.   Run 1: ...
  2.   Run 2: PASS
```

--------------------------------

### Example 1-Line Error Summary Output

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/newerrorsummary.html

This output demonstrates the compact one-line format for test failures and errors, highlighting assertion failures and exceptions with trimmed messages and library call indicators.

```text
Failures:
  Test1.assertion1:59 Bending maths expected:<[123]> but was:<[312]>
  Test1.assertion2:64 True is false

Errors:
  Test1.nullPointerInLibrary:38 » NullPointer
  Test1.failInMethod:43->innerFailure:68 NullPointer Fail here
  Test1.failInLibInMethod:48 » NullPointer
  Test1.failInNestedLibInMethod:54->nestedLibFailure:72 » NullPointer
  Test2.test6281:33 Runtime FailHere

```

--------------------------------

### Configure Test Execution Patterns

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Examples of complex syntax for the 'test' parameter to include or exclude specific test classes and methods.

```text
  1. "-Dit.test=???IT, !Unstable*, pkg/**/Ci*leIT.java, *IT#test*One+testTwo?????, #fast*+slowTest"
```

```text
  1. "-Dit.test=Basic*, !%regex[.*.Unstable.*], !%regex[.*.MyIT.class#one.*|two.*], %regex[#fast.*|slow.*]"
```

--------------------------------

### Configure Exclude Patterns in a File

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/xref/org/apache/maven/plugin/failsafe/IntegrationTestMojo.html

Examples of patterns for excluding tests, including path-based, regex, and method-level filtering.

```text
* /it/*
 /DontRunIT.*
 %regex[.*IT.*|.*Not.*]
```

```text
pkg.SomeIT#testMethod
```

--------------------------------

### Define Include Patterns

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/xref/org/apache/maven/plugin/failsafe/IntegrationTestMojo.html

Examples of patterns used in an inclusions file to specify which tests to run.

```text
*/it/*
**/NotIncludedByDefault.java
%regex[.*IT.*|.*Not.*]
```

```text
pkg.SomeIT#testMethod
```

--------------------------------

### Define Exclude Patterns in a File

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Example content for an excludes file, supporting paths, wildcards, and regex patterns.

```text
  1.   2. */it/*
  3. **/DontRunIT.*
  4. %regex[.*IT.*|.*Not.*]
```

--------------------------------

### Summary Output for Flaky Tests

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/rerun-failing-tests.html

Example of the final test summary indicating the count of flaky tests detected during the build.

```text
  1.   Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Flakes: 1
```

--------------------------------

### Example Output for Persistent Test Failure

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/rerun-failing-tests.html

Shows the console output format when a test fails across all configured retry attempts.

```text
  1.   Run 1: ...
  2.   Run 2: ...
  3.   Run 3: ...
```

--------------------------------

### Configure Shutdown Behavior in Maven Failsafe Plugin

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/shutdown.html

Example configuration to set the shutdown mode to 'kill', which forces the JVM to execute Runtime.halt(1) upon receiving a SIGTERM.

```xml
  1. <project>
  2.   [...]
  3.   <build>
  4.     <plugins>
  5.       <plugin>
  6.         <groupId>org.apache.maven.plugins</groupId>
  7.         <artifactId>maven-failsafe-plugin</artifactId>
  8.         <version>3.6.0-M1</version>
  9.         <configuration>
  10.           <shutdown>kill</shutdown>
  11.         </configuration>
  12.       </plugin>
  13.     </plugins>
  14.   </build>
  15.   [...]
  16. </project>
```

--------------------------------

### Configure Forked Test Execution

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/fork-options-and-parallel-execution.html

Example configuration for spawning three concurrent JVM processes with isolated system properties and working directories.

```xml
  <plugins>
  2. [...]
  3.   <plugin>
  4.     <groupId>org.apache.maven.plugins</groupId>
  5.     <artifactId>maven-failsafe-plugin</artifactId>
  6.     <version>3.6.0-M1</version>
  7.     <configuration>
  8.         <forkCount>3</forkCount>
  9.         <reuseForks>true</reuseForks>
  10.         <argLine>-Xmx1024m -XX:MaxPermSize=256m</argLine>
  11.         <systemPropertyVariables>
  12.             <databaseSchema>MY_TEST_SCHEMA_${surefire.forkNumber}</databaseSchema>
  13.         </systemPropertyVariables>
  14.         <workingDirectory>FORK_DIRECTORY_${surefire.forkNumber}</workingDirectory>
  15.     </configuration>
  16.   </plugin>
  17. [...]
  18. </plugins>
```

--------------------------------

### Exclude Specific Test Methods in a File

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Example of using method-level filtering within an excludes file.

```text
  1.   2. pkg.SomeIT#testMethod
```

--------------------------------

### Set JAVA_HOME for Java 9

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/java9.html

Set the JAVA_HOME environment variable to point to your Java 9 installation before running Maven tests.

```bash
$ export JAVA_HOME=/path/to/jdk9
$ mvn test

```

--------------------------------

### Complex Test Exclusion Syntax

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Example of using regex and wildcard patterns within a single exclude parameter.

```xml
  1.   2. <exclude>%regex[pkg.*Slow.*.class], Unstable*</exclude>
```

--------------------------------

### Exclude Environment Variables via Command Line

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Example command to exclude multiple environment variables using the failsafe.excludedEnvironmentVariables property.

```bash
mvn test -Dfailsafe.excludedEnvironmentVariables=ACME1,ACME2,ACME3
```

--------------------------------

### Display help information for a goal

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/plugin-info.html

Use this command to view detailed parameter information for a specific plugin goal.

```bash
mvn failsafe:help -Ddetail=true -Dgoal=<goal-name>
```

--------------------------------

### Original Multi-line Exception Message

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/multilineexceptions.html

An example of a multi-line exception message before Surefire's special handling.

```java
java.lang.IllegalArgumentException: My Couch
   |
   May not contain whitespace

```

--------------------------------

### Configure VM properties via argLine

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/system-properties.html

Set properties that must be available at VM startup by adding them to the argLine parameter.

```xml
  1.   <argLine>-Djava.endorsed.dirs=...</argLine>
```

--------------------------------

### Clone the Maven Surefire Repository

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/developing.html

Use this command to check out the complete multi-module project for development.

```bash
  1.   git clone https://gitbox.apache.org/repos/asf/maven-surefire.git
```

--------------------------------

### Configure stack trace filters via command line

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/architecture.html

Apply custom stack trace filter prefixes using the surefire.stackTraceFilterPrefixes system property during execution.

```bash
  1. # Command line
  2. mvn test -Dsurefire.stackTraceFilterPrefixes=org.springframework.,org.junit.
```

--------------------------------

### Standard Java Execution

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/class-loading.html

The basic method of launching a Java application with a specified classpath.

```bash
  1. java -classpath foo.jar:bar.jar MyApp
```

--------------------------------

### Execute Maven build and test commands

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/architecture.html

Common Maven commands for building projects, running specific tests, and setting up IDE environments.

```bash
  1. # Full build with unit tests
  2. mvn clean install
  3.   4. # Full build with integration tests
  5. mvn clean install -P run-its
  6.   7. # Build a single module
  8. mvn clean install -pl surefire-booter
  9.   10. # Run a single test
  11. mvn test -pl surefire-booter -Dtest=ForkedBooterTest
  12.   13. # Run a single integration test
  14. mvn verify -pl surefire-its -Prun-its -Dit.test=JUnit47RedirectOutputIT
  15.   16. # IDE setup (required before importing)
  17. mvn install -P ide-development -f surefire-shared-utils/pom.xml
  18. mvn compile -f surefire-grouper/pom.xml
```

--------------------------------

### Run an Integration Test Project

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/developing.html

Execute a specific integration test project from the resources directory to reproduce issues.

```bash
  1.   cd surefire-its/src/test/resources/failsafe-buildfail
  2.   mvn -Dsurefire.version=2.12 verify
```

--------------------------------

### Checksum and System Properties Configuration

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/xref/org/apache/maven/plugin/failsafe/IntegrationTestMojo.html

Methods for handling plugin-specific checksum items and system properties file configuration.

```java
@Override
protected void addPluginSpecificChecksumItems(ChecksumCalculator checksum) {
    checksum.add(skipITs);
    checksum.add(summaryFile);
}

@Override
public File getSystemPropertiesFile() {
    return systemPropertiesFile;
}

@Override
public void setSystemPropertiesFile(File systemPropertiesFile) {
    this.systemPropertiesFile = systemPropertiesFile;
}
```

--------------------------------

### Run Multiple Integration Test Executions

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/usage.html

Configure multiple integration-test goals with unique summary files and aggregate them in a verify goal execution.

```xml

  1. <project>
  2.   [...]
  3.   <reporting>
  4.     <plugins>
  5.       <plugin>
  6.         <groupId>org.apache.maven.plugins</groupId>
  7.         <artifactId>maven-failsafe-plugin</artifactId>
  8.         <version>3.6.0-M1</version>
  9.         <executions>
  10.           <execution>
  11.             <id>integration-test-red-bevels</id>
  12.             <goals>
  13.               <goal>integration-test</goal>
  14.             </goals>
  15.             <configuration>
  16.               <systemPropertyVariables>
  17.                 <bevels>red</bevels>
  18.               </systemPropertyVariables>
  19.               <summaryFile>target/failsafe-reports/failsafe-summary-red-bevels.xml</summaryFile>
  20.             </configuration>
  21.           </execution>
  22.           <execution>
  23.             <id>integration-test-no-bevels</id>
  24.             <goals>
  25.               <goal>integration-test</goal>
  26.             </goals>
  27.             <configuration>
  28.               <systemPropertyVariables>
  29.                 <bevels>none</bevels>
  30.               </systemPropertyVariables>
  31.               <summaryFile>target/failsafe-reports/failsafe-summary-no-bevels.xml</summaryFile>
  32.             </configuration>
  33.           </execution>
  34.           <execution>
  35.             <id>verify</id>
  36.             <goals>
  37.               <goal>verify</goal>
  38.             </goals>
  39.             <configuration>
  40.               <summaryFiles>
  41.                 <summaryFile>target/failsafe-reports/failsafe-summary-red-bevels.xml</summaryFile>
  42.                 <summaryFile>target/failsafe-reports/failsafe-summary-no-bevels.xml</summaryFile>
  43.               </summaryFiles>
  44.             </configuration>
  45.           </execution>
  46.         </executions>
  47.       </plugin>
  48.     </plugins>
  49.   </reporting>
  50.   [...]
  51. </project>

```

--------------------------------

### VerifyMojo Parameter Configuration

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/xref/org/apache/maven/plugin/failsafe/VerifyMojo.html

Defines the configuration parameters for the Mojo, including directories, summary files, and failure thresholds.

```java
@Parameter(defaultValue = "${project.build.testOutputDirectory}")
private File testClassesDirectory;

/**
 * Base directory where all reports are written to.
 */
@Parameter(defaultValue = "${project.build.directory}/failsafe-reports")
private File reportsDirectory;

/**
 * The summary file to read integration test results from.
 */
@Parameter(defaultValue = "${project.build.directory}/failsafe-reports/failsafe-summary.xml", required = true)
private File summaryFile;

/**
 * Additional summary files to read integration test results from.
 *
 * @since 2.6
 */
@Parameter
private File[] summaryFiles;

/**
 * Set this to "true" to cause a failure if there are no tests to run. Defaults to "false".
 *
 * @since 2.4
 */
@Parameter(property = "failIfNoTests", defaultValue = "false")
private boolean failIfNoTests;

/**
 * Set this to a value greater than 0 to fail the whole test set if the cumulative number of flakes reaches
 * this threshold. Set to 0 to allow an unlimited number of flakes.
 *
 * @since 3.0.0-M6
 */
@Parameter(property = "failsafe.failOnFlakeCount", defaultValue = "0")
private int failOnFlakeCount;

/**
 * The current build session instance.
 */
@Parameter(defaultValue = "${session}", readonly = true)
private MavenSession session;
```

--------------------------------

### failsafe:help

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/help-mojo.html

Displays help information for the maven-failsafe-plugin. Users can specify a goal to see detailed parameter information.

```APIDOC
## failsafe:help

### Description
Display help information on maven-failsafe-plugin. Call `mvn failsafe:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.

### Parameters
- **detail** (boolean) - Optional - If true, display all settable properties for each goal. Default: false.
- **goal** (String) - Optional - The name of the goal for which to show help. If unspecified, all goals will be displayed.
- **indentSize** (int) - Optional - The number of spaces per indentation level, should be positive. Default: 2.
- **lineLength** (int) - Optional - The maximum length of a display line, should be positive. Default: 80.
```

--------------------------------

### Define JDK 9 Toolchain in toolchains.xml

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/java9.html

Configure a specific JDK 9 toolchain, including its version and home directory, in the toolchains.xml file.

```xml
<toolchains xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/TOOLCHAINS/1.1.0 https://maven.apache.org/xsd/toolchains-1.1.0.xsd">
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>9</version>
      <vendor>oracle</vendor>
      <id>jdk9</id>
    </provides>
    <configuration>
      <jdkHome>/path/to/jdk9</jdkHome>
    </configuration>
  </toolchain>
</toolchains>

```

--------------------------------

### Debug Forked Tests with Custom Port

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/debugging.html

Configure a different port for remote debugging by specifying the address in the `maven.failsafe.debug` property. This example uses port 8000.

```bash
mvn -Dmaven.failsafe.debug="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=localhost:8000" verify
```

--------------------------------

### Configure Legacy Provider for Surefire 3.6.0

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/whats-new-3-6-0.html

Transitional configuration to use a legacy provider from the 3.5.x line while running Surefire 3.6.0.

```xml

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-surefire-plugin</artifactId>
  4.     <version>3.6.0</version>
  5.     <dependencies>
  6.         <dependency>
  7.             <groupId>org.apache.maven.surefire</groupId>
  8.             <artifactId>surefire-junit4</artifactId>
  9.             <version>3.5.5</version>
  10.         </dependency>
  11.     </dependencies>
  12. </plugin>



```

--------------------------------

### UnsupportedClassVersionError Example

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/toolchains.html

This exception indicates that the Surefire plugin is attempting to run with a Java version that is too old for the current Surefire version. Ensure your toolchain meets the minimum Java version requirements.

```java
Exception in thread "main" java.lang.UnsupportedClassVersionError: org/apache/maven/surefire/booter/ForkedBooter: Unsupported major.minor version 52.0
        at java.lang.ClassLoader.defineClass1(Native Method)
        at java.lang.ClassLoader.defineClass(ClassLoader.java:800)
        at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142)
        at java.net.URLClassLoader.defineClass(URLClassLoader.java:449)
        at java.net.URLClassLoader.access$100(URLClassLoader.java:71)
        at java.net.URLClassLoader$1.run(URLClassLoader.java:361)
        at java.net.URLClassLoader$1.run(URLClassLoader.java:355)
        at java.security.AccessController.doPrivileged(Native Method)
        at java.net.URLClassLoader.findClass(URLClassLoader.java:354)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:425)
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:308)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:358)
        at sun.launcher.LauncherHelper.checkAndLoadMain(LauncherHelper.java:482)
```

--------------------------------

### Run Multiple Test Classes by Name and Pattern

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/single-test.html

Combine specific test class names and patterns, separated by commas, to execute a selected set of tests.

```bash
mvn -Dit.test=ITSquare,ITCi*le verify
```

--------------------------------

### Manifest-Only JAR Execution

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/class-loading.html

Launching an application using a booter JAR that references the actual classpath via a manifest file.

```bash
  1. java -classpath booter.jar MyApp
```

--------------------------------

### Configure JUnit5 Suite

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/junit-platform.html

Include the JUnit Jupiter engine, the suite engine, and configure the Maven Surefire plugin to execute the test suite.

```xml
  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.junit.jupiter</groupId>
  4.         <artifactId>junit-jupiter-engine</artifactId>
  5.         <version>5.9.1</version>
  6.         <scope>test</scope>
  7.     </dependency>
  8.     <dependency>
  9.         <groupId>org.junit.platform</groupId>
  10.         <artifactId>junit-platform-suite-engine</artifactId>
  11.         <version>1.9.1</version>
  12.         <scope>test</scope>
  13.     </dependency>
  14. </dependencies>
  15. <build>
  16.     <plugins>
  17.         <plugin>
  18.             <groupId>org.apache.maven.plugins</groupId>
  19.             <artifactId>maven-surefire-plugin</artifactId>
  20.             <version>3.6.0-M1</version>
  21.             <configuration>
  22.                 <test><!-- your test suite class name should be here --></test>
  23.             </configuration>
  24.         </plugin>
  25.     </plugins>
  26. </build>
```

--------------------------------

### Access Source Repository via Web Browser

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/scm.html

Direct link to the browsable source repository on GitHub.

```text
https://github.com/apache/maven-surefire/tree/surefire-3.6.0-M1/maven-failsafe-plugin
```

--------------------------------

### Run a Single Test Class

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/single-test.html

Execute a specific integration test class by setting the `it.test` property to the test class name.

```bash
mvn -Dit.test=ITCircle verify
```

--------------------------------

### Run Maven Tests with Toolchains XML

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/java9.html

Execute Maven tests using a specified toolchains.xml file to select the appropriate JDK.

```bash
$ mvn -t /path/to/.m2/toolchains.xml test

```

--------------------------------

### Run Tests Using Patterns

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/single-test.html

Use wildcard patterns with the `it.test` property to run multiple test classes that match the pattern.

```bash
mvn -Dit.test=ITCi*le verify
```

--------------------------------

### Invoke Maven Integration Tests

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/index.html

Use the verify goal to ensure the post-integration-test phase executes correctly.

```bash
  1. mvn verify
```

--------------------------------

### Core Classes Reading List

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/developing.html

Key classes and methods to examine for understanding the basic operation of the plugin.

```text
  1. AbstractSurefireMojo#executeAfterPreconditionsChecked
  2. ForkStarter#fork
  3. ForkedBooter#main
```

--------------------------------

### Configure Alternate Toolchain for Failsafe Tests

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/toolchains.html

Use the `jdkToolchain` configuration within the Failsafe plugin to specify an alternate toolchain for running tests. This requires a corresponding entry in your `toolchains.xml`.

```xml
<configuration>
    [...]
    <jdkToolchain>
        <version>8</version>
        <vendor>zulu</vendor>
    </jdkToolchain>
    [...]
</configuration>
```

--------------------------------

### Configure system properties for TestNG

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/testng.html

Pass parameters from Maven to TestNG tests by defining systemPropertyVariables within the maven-failsafe-plugin configuration.

```xml
  1. <plugins>
  2.     [...]
  3.       <plugin>
  4.         <groupId>org.apache.maven.plugins</groupId>
  5.         <artifactId>maven-failsafe-plugin</artifactId>
  6.         <version>3.6.0-M1</version>
  7.         <configuration>
  8.           <systemPropertyVariables>
  9.             <propertyName>firefox</propertyName>
  10.           </systemPropertyVariables>
  11.         </configuration>
  12.       </plugin>
  13.     [...]
  14. </plugins>
```

--------------------------------

### Configure stack trace filtering

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/architecture.html

Define custom prefixes to filter stack traces in the plugin configuration. Default filters apply if this section is omitted.

```xml
  1. <configuration>
  2.     <stackTraceFilterPrefixes>
  3.         <prefix>org.springframework.</prefix>
  4.         <prefix>org.junit.</prefix>
  5.     </stackTraceFilterPrefixes>
  6. </configuration>
```

--------------------------------

### Configure JUnit Jupiter and Vintage Engines

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/junit-platform.html

Include both Jupiter and Vintage engines to run tests from both frameworks.

```xml

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.junit.jupiter</groupId>
  4.         <artifactId>junit-jupiter-engine</artifactId>
  5.         <version>5.9.1</version>
  6.         <scope>test</scope>
  7.     </dependency>
  8.     <dependency>
  9.         <groupId>org.junit.vintage</groupId>
  10.         <artifactId>junit-vintage-engine</artifactId>
  11.         <version>5.9.1</version>
  12.         <scope>test</scope>
  13.     </dependency>
  14. </dependencies>



```

--------------------------------

### includesFile

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Configures a file containing include patterns for integration tests. Supports simple, path-based, regex, and method-level filtering.

```APIDOC
## includesFile

### Description
A file containing include patterns, each on a new line. Blank lines or lines starting with # are ignored. If `includes` are also specified, these patterns are appended.

### Parameters
- **includesFile** (File) - Optional - A file containing include patterns.

### Usage Example
```
*/it/*
**/NotIncludedByDefault.java
%regex[.*IT.*|.*Not.*]
pkg.SomeIT#testMethod
```
```

--------------------------------

### Configure Regex Includes in Maven Failsafe Plugin

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/inclusion-exclusion.html

Use the %regex[] syntax within the <includes> configuration block to match test classes based on regular expressions.

```xml
  1. <project>
  2.   [...]
  3.   <build>
  4.     <plugins>
  5.       <plugin>
  6.         <groupId>org.apache.maven.plugins</groupId>
  7.         <artifactId>maven-failsafe-plugin</artifactId>
  8.         <version>3.6.0-M1</version>
  9.         <configuration>
  10.           <includes>
  11.             <include>%regex[.*(Cat|Dog).*Test.*]</include>
  12.           </includes>
  13.         </configuration>
  14.       </plugin>
  15.     </plugins>
  16.   </build>
  17.   [...]
  18. </project>
```

--------------------------------

### Configure Maven Dependencies and Plugins for Spock

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/spock.html

Required Maven configuration including spock-core, junit-jupiter-engine, gmavenplus-plugin, and maven-failsafe-plugin.

```xml
  1. <dependencies>
  2.     [...]
  3.     <dependency>
  4.         <groupId>org.spockframework</groupId>
  5.         <artifactId>spock-core</artifactId>
  6.         <version>2.0-M2-groovy-3.0</version>
  7.         <scope>test</scope>
  8.     </dependency>
  9.     <dependency>
  10.         <groupId>org.junit.jupiter</groupId>
  11.         <artifactId>junit-jupiter-engine</artifactId>
  12.         <version>5.9.1</version>
  13.         <scope>test</scope>
  14.     </dependency>
  15.     [...]
  16. </dependencies>
  17. ...
  18. <build>
  19.     <plugins>
  20.         [...]
  21.         <plugin>
  22.             <groupId>org.codehaus.gmavenplus</groupId>
  23.             <artifactId>gmavenplus-plugin</artifactId>
  24.             <version>1.9.0</version>
  25.             <executions>
  26.                 <execution>
  27.                     <goals>
  28.                         <goal>compileTests</goal>
  29.                     </goals>
  30.                 </execution>
  31.             </executions>
  32.         </plugin>
  33.         <plugin>
  34.             <groupId>org.apache.maven.plugins</groupId>
  35.             <artifactId>maven-failsafe-plugin</artifactId>
  36.             <version>3.6.0-M1</version>
  37.             <executions>
  38.                 <execution>
  39.                     <id>integration-test</id>
  40.                     <goals>
  41.                         <goal>integration-test</goal>
  42.                     </goals>
  43.                 </execution>
  44.                 <execution>
  45.                     <id>verify</id>
  46.                     <goals>
  47.                         <goal>verify</goal>
  48.                     </goals>
  49.                 </execution>
  50.             </executions>
  51.         </plugin>
  52.         [...]
  53.     </plugins>
  54. </build>
  55. ...
```

--------------------------------

### Add custom resources or JARs to the classpath

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/configuring-classpath.html

Use the additionalClasspathElements configuration to append absolute file system paths to the end of the test classpath.

```xml
  1. <project>
  2.   [...]
  3.   <build>
  4.     <plugins>
  5.       <plugin>
  6.         <groupId>org.apache.maven.plugins</groupId>
  7.         <artifactId>maven-failsafe-plugin</artifactId>
  8.         <version>3.6.0-M1</version>
  9.         <configuration>
  10.           <additionalClasspathElements>
  11.             <additionalClasspathElement>path/to/additional/resources</additionalClasspathElement>
  12.             <additionalClasspathElement>path/to/additional/jar</additionalClasspathElement>
  13.             <additionalClasspathElement>path/to/csv/jar1, path/to/csv/jar2</additionalClasspathElement>
  14.           </additionalClasspathElements>
  15.         </configuration>
  16.       </plugin>
  17.     </plugins>
  18.   </build>
  19.   [...]
  20. </project>
```

--------------------------------

### Implement a Spock Parameterized Test

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/examples/spock.html

A sample Spock specification demonstrating a parameterized test method using the 'where' block.

```groovy
  1. import pkg.Calculator
  2. import spock.lang.Specification
  3.   4. class CalculatorTest extends Specification
  5. {
  6.     def "Multiply: #a * #b = #expectedResult"()
  7.     {
  8.         given: "Calculator"
  9.         def calc = new Calculator()
  10.   11.         when: "multiply"
  12.         def result = calc.multiply( a, b )
  13.   14.         then: "result is as expected"
  15.         result == expectedResult
  16.         println "result = ${result}"
  17.   18.         where:
  19.         a  | b | expectedResult
  20.         1  | 2 | 3
  21.         -5 | 2 | -3
  22.     }
  23. }
```

--------------------------------

### Configure JDK Toolchain

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html

Use these configurations to specify the JDK version or vendor for test execution via Maven toolchains.

```xml
  1.    <configuration>
  2.        ...
  3.        <jdkToolchain>
  4.            <version>1.11</version>
  5.        </jdkToolchain>
  6.    </configuration>
  7.   8.    <configuration>
  9.        ...
  10.        <jdkToolchain>
  11.            <version>1.8</version>
  12.            <vendor>zulu</vendor>
  13.        </jdkToolchain>
  14.    </configuration>
  15.    
```

--------------------------------

### Timeout and Classloader Configuration Methods

Source: https://maven.apache.org/surefire/maven-failsafe-plugin/xref/org/apache/maven/plugin/failsafe/IntegrationTestMojo.html

Methods for managing forked process timeouts, parallel test execution timeouts, and classloader settings.

```java
@Override
public void setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds) {
    this.forkedProcessExitTimeoutInSeconds = forkedProcessExitTimeoutInSeconds;
}

@Override
public double getParallelTestsTimeoutInSeconds() {
    return parallelTestsTimeoutInSeconds;
}

@Override
public void setParallelTestsTimeoutInSeconds(double parallelTestsTimeoutInSeconds) {
    this.parallelTestsTimeoutInSeconds = parallelTestsTimeoutInSeconds;
}

@Override
public double getParallelTestsTimeoutForcedInSeconds() {
    return parallelTestsTimeoutForcedInSeconds;
}

@Override
public void setParallelTestsTimeoutForcedInSeconds(double parallelTestsTimeoutForcedInSeconds) {
    this.parallelTestsTimeoutForcedInSeconds = parallelTestsTimeoutForcedInSeconds;
}

@Override
public boolean isUseSystemClassLoader() {
    return useSystemClassLoader;
}

@Override
public void setUseSystemClassLoader(boolean useSystemClassLoader) {
    this.useSystemClassLoader = useSystemClassLoader;
}

@Override
public boolean isUseManifestOnlyJar() {
    return useManifestOnlyJar;
}

@Override
public void setUseManifestOnlyJar(boolean useManifestOnlyJar) {
    this.useManifestOnlyJar = useManifestOnlyJar;
}
```
Tokens:
Raw