Package org.apache.maven.plugin.surefire

Class SurefirePlugin

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.surefire.AbstractSurefireMojo
org.apache.maven.plugin.surefire.SurefirePlugin
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, SurefireExecutionParameters, SurefireReportParameters
@Mojo(name="test", defaultPhase=TEST, threadSafe=true, requiresDependencyResolution=TEST) public class SurefirePlugin extends AbstractSurefireMojo implements SurefireReportParameters
Run tests using Surefire.

  • Field Details

    • classesDirectory

      @Parameter(defaultValue="${project.build.outputDirectory}") private File classesDirectory
      The directory containing generated classes of the project being tested. This will be included after the test classes in the test classpath.

    • testFailureIgnore

      @Parameter(property="maven.test.failure.ignore", defaultValue="false") private boolean testFailureIgnore
      Set this to "true" to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.

    • reportsDirectory

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

    • test

      @Parameter(property="test") private String test

    • printSummary

      @Parameter(property="surefire.printSummary", defaultValue="true") private boolean printSummary
      Option to print summary of test suites or just print the test cases that have errors.

    • reportFormat

      @Parameter(property="surefire.reportFormat", defaultValue="brief") private String reportFormat
      Selects the formatting for the test report to be generated. Can be set as "brief" or "plain". Only applies to the output format of the output files (target/surefire-reports/testName.txt)

    • useFile

      @Parameter(property="surefire.useFile", defaultValue="true") private boolean useFile
      Option to generate a file test report or just output the test report to the console.

    • failIfNoSpecifiedTests

      @Parameter(property="surefire.failIfNoSpecifiedTests", defaultValue="true") private boolean failIfNoSpecifiedTests
      Set this to "true" to cause a failure if none of the tests specified in -Dtest=... are run. Defaults to "true".
      Since:
      2.12

    • debugForkedProcess

      @Parameter(property="maven.surefire.debug") private String debugForkedProcess
      Attach a debugger to the forked JVM. If set to "true", the process will suspend and wait for a debugger to attach on port 5005. If set to some other string, that string will be appended to the argLine, allowing you to configure arbitrary debuggability options (without overwriting the other options specified through the argLine parameter).
      Since:
      2.4

    • forkedProcessTimeoutInSeconds

      @Parameter(property="surefire.timeout") private int forkedProcessTimeoutInSeconds
      Kill the forked test process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.
      Since:
      2.4

    • forkedProcessExitTimeoutInSeconds

      @Parameter(property="surefire.exitTimeout", defaultValue="30") private int forkedProcessExitTimeoutInSeconds
      Forked process is normally terminated without any significant delay after given tests have completed. If the particular tests started non-daemon Thread(s), the process hangs instead of been properly terminated by System.exit(). Use this parameter in order to determine the timeout of terminating the process. see the documentation: http://maven.apache.org/surefire/maven-surefire-plugin/examples/shutdown.html Turns to default fallback value of 30 seconds if negative integer.
      Since:
      2.20

    • parallelTestsTimeoutInSeconds

      @Parameter(property="surefire.parallel.timeout") private double parallelTestsTimeoutInSeconds
      Stop executing queued parallel JUnit tests after a certain number of seconds.
      Example values: "3.5", "4"

      If set to 0, wait forever, never timing out. Makes sense with specified parallel different from "none".
      Since:
      2.16

    • parallelTestsTimeoutForcedInSeconds

      @Parameter(property="surefire.parallel.forcedTimeout") private double parallelTestsTimeoutForcedInSeconds
      Stop executing queued parallel JUnit tests and interrupt currently running tests after a certain number of seconds.
      Example values: "3.5", "4"

      If set to 0, wait forever, never timing out. Makes sense with specified parallel different from "none".
      Since:
      2.16

    • includes

      @Parameter(property="surefire.includes") private List<String> includes

    • excludes

      @Parameter(property="surefire.excludes") private List<String> excludes
      A list of <exclude> elements specifying the tests (by pattern) that should be excluded in testing. When not specified and when the test parameter is not specified, the default excludes will be 
      
 <excludes>
     <exclude>**/*$*</exclude>
 </excludes>
      (which excludes all inner classes).
      This parameter is ignored if the TestNG suiteXmlFiles parameter is specified.
      Each exclude item may also contain a comma-separated sub-list of items, which will be treated as multiple <exclude> entries.
      Since 2.19 a complex syntax is supported in one parameter (JUnit 4, JUnit 4.7+, TestNG): 
      
 <exclude>%regex[pkg.*Slow.*.class], Unstable*</exclude>

      Notice that these values are relative to the directory containing generated test classes of the project being tested. This directory is declared by the parameter testClassesDirectory which defaults to the POM property ${project.build.testOutputDirectory}, typically src/test/java unless overridden.

    • useSystemClassLoader

      @Parameter(property="surefire.useSystemClassLoader", defaultValue="true") private boolean useSystemClassLoader
      Option to pass dependencies to the system's classloader instead of using an isolated class loader when forking. Prevents problems with JDKs which implement the service provider lookup mechanism by using the system's ClassLoader.
      Since:
      2.3

    • useManifestOnlyJar

      @Parameter(property="surefire.useManifestOnlyJar", defaultValue="true") private boolean useManifestOnlyJar
      By default, Surefire forks your tests using a manifest-only JAR; set this parameter to "false" to force it to launch your tests with a plain old Java classpath. (See the http://maven.apache.org/plugins/maven-surefire-plugin/examples/class-loading.html for a more detailed explanation of manifest-only JARs and their benefits.)
      Beware, setting this to "false" may cause your tests to fail on Windows if your classpath is too long.
      Since:
      2.4.3

    • encoding

      @Parameter(property="surefire.encoding", defaultValue="${project.reporting.outputEncoding}") private String encoding
      The character encoding scheme to be applied while generating test report files (see target/surefire-reports/yourTestName.txt). The report output files (*-out.txt) are encoded in UTF-8 if not set otherwise.
      Since:
      3.0.0-M1

    • rerunFailingTestsCount

      @Parameter(property="surefire.rerunFailingTestsCount", defaultValue="0") private int rerunFailingTestsCount
      (JUnit 4+ providers and JUnit 5+ providers since 3.0.0-M4) The number of times each failing test will be rerun. If set larger than 0, rerun failing tests immediately after they fail. If a failing test passes in any of those reruns, it will be marked as pass and reported as a "flake". However, all the failing attempts will be recorded.

    • failOnFlakeCount

      @Parameter(property="surefire.failOnFlakeCount", defaultValue="0") private int failOnFlakeCount
      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

    • suiteXmlFiles

      @Parameter(property="surefire.suiteXmlFiles") private File[] suiteXmlFiles
      (TestNG) List of <suiteXmlFile> elements specifying TestNG suite xml file locations. Note that suiteXmlFiles is incompatible with several other parameters of this plugin, like includes and excludes.
      This parameter is ignored if the test parameter is specified (allowing you to run a single test instead of an entire suite).
      Since:
      2.2

    • runOrder

      @Parameter(property="surefire.runOrder", defaultValue="filesystem") private String runOrder
      Defines the order the tests will be run in. Supported values are alphabetical, reversealphabetical, random, hourly (alphabetical on even hours, reverse alphabetical on odd hours), failedfirst, balanced and filesystem.

      Odd/Even for hourly is determined at the time the of scanning the classpath, meaning it could change during a multi-module build.

      Failed first will run tests that failed on previous run first, as well as new tests for this run.

      Balanced is only relevant with parallel=classes, and will try to optimize the run-order of the tests reducing the overall execution time. Initially a statistics file is created and every next test run will reorder classes.

      Note that the statistics are stored in a file named .surefire-XXXXXXXXX beside pom.xml and should not be checked into version control. The "XXXXX" is the SHA1 checksum of the entire surefire configuration, so different configurations will have different statistics files, meaning if you change any configuration settings you will re-run once before new statistics data can be established.
      Since:
      2.7

    • runOrderRandomSeed

      @Parameter(property="surefire.runOrder.random.seed") private Long runOrderRandomSeed
      Sets the random seed that will be used to order the tests if surefire.runOrder is set to random.

      If no seeds are set and surefire.runOrder is set to random, then the seed used will be outputted (search for "To reproduce ordering use flag -Dsurefire.runOrder.random.seed").

      To deterministically reproduce any random test order that was run before, simply set the seed to be the same value.
      Since:
      3.0.0-M6

    • includesFile

      @Parameter(property="surefire.includesFile") private File includesFile
      A file containing include patterns. Blank lines, or lines starting with # are ignored. If includes are also specified, these patterns are appended. Example with path, simple and regex includes: 
      
 */test/*
 **/NotIncludedByDefault.java
 %regex[.*Test.*|.*Not.*]

      Since 3.0.0-M6, method filtering support is provided in the inclusions file as well, example: 
      
 pkg.SomeTest#testMethod
      Since:
      2.13

    • excludesFile

      @Parameter(property="surefire.excludesFile") private File excludesFile
      A file containing exclude patterns. Blank lines, or lines starting with # are ignored. If excludes are also specified, these patterns are appended. Example with path, simple and regex excludes:
      
 */test/*
 **/DontRunTest.*
 %regex[.*Test.*|.*Not.*]
      Since 3.0.0-M6, method filtering support is provided in the exclusions file as well, example: 
      
 pkg.SomeTest#testMethod
      Since:
      2.13

    • skipAfterFailureCount

      @Parameter(property="surefire.skipAfterFailureCount", defaultValue="0") private int skipAfterFailureCount
      Set to error/failure count in order to skip remaining tests. Due to race conditions in parallel/forked execution this may not be fully guaranteed.
      Enable with system property -Dsurefire.skipAfterFailureCount=1 or any number greater than zero. Defaults to "0".
      See the prerequisites and limitations in documentation:
      http://maven.apache.org/plugins/maven-surefire-plugin/examples/skip-after-failure.html
      Since:
      2.19

    • shutdown

      @Parameter(property="surefire.shutdown", defaultValue="exit") private String shutdown
      After the plugin process is shutdown by sending SIGTERM signal (CTRL+C), SHUTDOWN command is received by every forked JVM.
      The value is set to (shutdown=exit) by default (changed in version 3.0.0-M4).
      The parameter can be configured with other two values testset and kill.
      With(shutdown=testset) the test set may still continue to run in forked JVM.
      Using exit forked JVM executes System.exit(1) after the plugin process has received SIGTERM signal.
      Using kill the JVM executes Runtime.halt(1) and kills itself.
      Since:
      2.19

    • useModulePath

      @Parameter(property="surefire.useModulePath", defaultValue="true") private boolean useModulePath
      When true, uses the modulepath when executing with JDK 9+ and module-info.java is present. When false, always uses the classpath.
      Defaults to true.
      Since:
      3.0.0-M2

    • forkNode

      @Parameter(property="surefire.forkNode") private ForkNodeFactory forkNode
      This parameter configures the forked node. Currently, you can select the communication protocol, i.e. process pipes or TCP/IP sockets. The plugin uses process pipes by default which will be turned to TCP/IP in the version 3.0.0. Alternatively, you can implement your own factory and SPI.
      See the documentation for more details:
      https://maven.apache.org/plugins/maven-surefire-plugin/examples/process-communication.html
      Since:
      3.0.0-M5

    • excludedEnvironmentVariables

      @Parameter(property="surefire.excludedEnvironmentVariables") private String[] excludedEnvironmentVariables
      You can selectively exclude individual environment variables by enumerating their keys.
      The environment is a system-dependent mapping from keys to values which is inherited from the Maven process to the forked Surefire processes. The keys must literally (case sensitive) match in order to exclude their environment variable.
      Example to exclude three environment variables:
      mvn test -Dsurefire.excludedEnvironmentVariables=ACME1,ACME2,ACME3
      Since:
      3.0.0-M4

    • enableProcessChecker

      @Parameter(property="surefire.enableProcessChecker") private String enableProcessChecker
      Since 3.0.0-M4 the process checkers are disabled. You can enable them namely by setting ping and native or all in this parameter.
      The checker is useful in situations when you kill the build on a CI system and you want the Surefire forked JVM to kill the tests asap and free all handlers on the file system been previously used by the JVM and by the tests.
      The ping should be safely used together with ZGC or Shenandoah Garbage Collector. Due to the ping relies on timing of the PING (triggered every 30 seconds), slow GCs may pause the timers and pretend that the parent process of the forked JVM does not exist.
      The native is very fast checker. It is useful mechanism on Unix based systems, Linux distributions and Alpine/BusyBox Linux. See the JIRA SUREFIRE-1631 for Windows issues.
      Another useful configuration parameter is forkedProcessTimeoutInSeconds.
      See the Frequently Asked Questions page with more details:
      http://maven.apache.org/surefire/maven-surefire-plugin/faq.html#kill-jvm
      http://maven.apache.org/surefire/maven-failsafe-plugin/faq.html#kill-jvm
      Example of use:
      mvn test -Dsurefire.enableProcessChecker=all
      Since:
      3.0.0-M4

    • systemPropertiesFile

      @Parameter(property="surefire.systemPropertiesFile") private File systemPropertiesFile

    • includeJUnit5Engines

      @Parameter(property="includeJUnit5Engines") private String[] includeJUnit5Engines
      Provide the ID/s of an JUnit engine to be included in the test run.
      Since:
      3.0.0-M6

    • excludeJUnit5Engines

      @Parameter(property="excludeJUnit5Engines") private String[] excludeJUnit5Engines
      Provide the ID/s of an JUnit engine to be excluded in the test run.
      Since:
      3.0.0-M6

  • Constructor Details

    • SurefirePlugin

      public SurefirePlugin()

  • Method Details