Package org.apache.maven.plugin.failsafe
Class IntegrationTestMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugin.surefire.AbstractSurefireMojo
-
- org.apache.maven.plugin.failsafe.IntegrationTestMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,SurefireExecutionParameters
@Mojo(name="integration-test", requiresProject=true, requiresDependencyResolution=TEST, defaultPhase=INTEGRATION_TEST, threadSafe=true) public class IntegrationTestMojo extends AbstractSurefireMojo
Run integration tests using Surefire.
-
-
Field Summary
Fields Modifier and Type Field Description private java.io.File
classesDirectory
The path representing project JAR file, if exists; Otherwise the directory containing generated classes of the project being tested.private java.lang.String
debugForkedProcess
Attach a debugger to the forked JVM.private java.io.File
defaultClassesDirectory
private java.lang.String
enableProcessChecker
Since 3.0.0-M4 the process checkers are disabled.private java.lang.String
encoding
The character encoding scheme to be applied while generating test report files (see target/surefire-reports/yourTestName.txt).private java.lang.String[]
excludedEnvironmentVariables
You can selectively exclude individual environment variables by enumerating their keys.private java.lang.String[]
excludeJUnit5Engines
Provide the ID/s of an JUnit engine to be excluded in the test run.private java.util.List<java.lang.String>
excludes
A list of <exclude> elements specifying the tests (by pattern) that should be excluded in testing.private java.io.File
excludesFile
A file containing exclude patterns, each in a next line.private boolean
failIfNoSpecifiedTests
Set this to "true" to cause a failure if none of the tests specified in -Dtest=...private static java.lang.String
FAILSAFE_IN_PROGRESS_CONTEXT_KEY
private int
forkedProcessExitTimeoutInSeconds
Forked process is normally terminated without any significant delay after given tests have completed.private int
forkedProcessTimeoutInSeconds
Kill the forked test process after a certain number of seconds.private ForkNodeFactory
forkNode
This parameter configures the forked node.private java.lang.String[]
includeJUnit5Engines
Provide the ID/s of an JUnit engine to be included in the test run.private java.util.List<java.lang.String>
includes
private java.io.File
includesFile
A file containing include patterns, each in a next line.private double
parallelTestsTimeoutForcedInSeconds
Stop executing queued parallel JUnit tests and interrupt currently running tests after a certain number of seconds.private double
parallelTestsTimeoutInSeconds
Stop executing queued parallel JUnit tests after a certain number of seconds.private boolean
printSummary
Option to print summary of test suites or just print the test cases that have errors.private java.lang.String
reportFormat
Selects the formatting for the test report to be generated.private java.io.File
reportsDirectory
Base directory where all reports are written to.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.private java.lang.String
runOrder
Defines the order the tests will be run in.private java.lang.Long
runOrderRandomSeed
Sets the random seed that will be used to order the tests iffailsafe.runOrder
is set torandom
.private java.lang.String
shutdown
After the plugin process is shutdown by sending SIGTERM signal (CTRL+C), SHUTDOWN command is received by every forked JVM.private int
skipAfterFailureCount
Set to error/failure count in order to skip remaining tests.private boolean
skipITs
Set this to "true" to skip running integration tests, but still compile them.private java.io.File[]
suiteXmlFiles
(TestNG) List of <suiteXmlFile> elements specifying TestNG suite xml file locations.private java.io.File
summaryFile
The summary file to write integration test results to.private java.io.File
systemPropertiesFile
private java.lang.String
test
private boolean
useFile
Option to generate a file test report or just output the test report to the console.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.private boolean
useModulePath
Whentrue
, uses the modulepath when executing with JDK 9+ and module-info.java is present.private boolean
useSystemClassLoader
Option to pass dependencies to the system's classloader instead of using an isolated class loader when forking.-
Fields inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo
basedir, skip, skipExec, skipTests, testClassesDirectory
-
-
Constructor Summary
Constructors Constructor Description IntegrationTestMojo()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addPluginSpecificChecksumItems(ChecksumCalculator checksum)
java.io.File
getBasedir()
java.lang.String
getDebugForkedProcess()
protected java.lang.String[]
getDefaultIncludes()
protected java.lang.String
getEnableProcessChecker()
java.lang.String
getEncoding()
protected java.lang.String[]
getExcludedEnvironmentVariables()
java.lang.String[]
getExcludeJUnit5Engines()
java.util.List<java.lang.String>
getExcludes()
java.io.File
getExcludesFile()
boolean
getFailIfNoSpecifiedTests()
int
getForkedProcessExitTimeoutInSeconds()
int
getForkedProcessTimeoutInSeconds()
protected ForkNodeFactory
getForkNode()
java.lang.String[]
getIncludeJUnit5Engines()
java.util.List<java.lang.String>
getIncludes()
java.io.File
getIncludesFile()
java.io.File
getMainBuildPath()
double
getParallelTestsTimeoutForcedInSeconds()
double
getParallelTestsTimeoutInSeconds()
protected java.lang.String
getPluginName()
java.lang.String
getReportFormat()
protected java.lang.String
getReportSchemaLocation()
java.io.File
getReportsDirectory()
protected int
getRerunFailingTestsCount()
java.lang.String
getRunOrder()
java.lang.Long
getRunOrderRandomSeed()
java.lang.String
getShutdown()
int
getSkipAfterFailureCount()
java.io.File[]
getSuiteXmlFiles()
java.io.File
getSummaryFile()
java.io.File
getSystemPropertiesFile()
List of System properties, loaded from a file, to pass to the JUnit tests.java.lang.String
getTest()
java.io.File
getTestClassesDirectory()
protected void
handleSummary(RunResult summary, java.lang.Exception firstForkException)
protected boolean
hasSuiteXmlFiles()
private boolean
isJarArtifact(java.io.File artifactFile)
boolean
isPrintSummary()
boolean
isSkip()
boolean
isSkipExec()
Deprecated.protected boolean
isSkipExecution()
boolean
isSkipITs()
boolean
isSkipTests()
boolean
isTestFailureIgnore()
boolean
isUseFile()
boolean
isUseManifestOnlyJar()
boolean
isUseSystemClassLoader()
void
setBasedir(java.io.File basedir)
void
setDebugForkedProcess(java.lang.String debugForkedProcess)
void
setDefaultClassesDirectory(java.io.File defaultClassesDirectory)
void
setEncoding(java.lang.String encoding)
(package private) void
setExcludedEnvironmentVariables(java.lang.String[] excludedEnvironmentVariables)
void
setExcludeJUnit5Engines(java.lang.String[] excludeJUnit5Engines)
void
setExcludes(java.util.List<java.lang.String> excludes)
void
setFailIfNoSpecifiedTests(boolean failIfNoSpecifiedTests)
void
setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds)
void
setForkedProcessTimeoutInSeconds(int forkedProcessTimeoutInSeconds)
void
setIncludeJUnit5Engines(java.lang.String[] includeJUnit5Engines)
void
setIncludes(java.util.List<java.lang.String> includes)
void
setMainBuildPath(java.io.File mainBuildPath)
void
setParallelTestsTimeoutForcedInSeconds(double parallelTestsTimeoutForcedInSeconds)
void
setParallelTestsTimeoutInSeconds(double parallelTestsTimeoutInSeconds)
void
setPrintSummary(boolean printSummary)
void
setReportFormat(java.lang.String reportFormat)
void
setReportsDirectory(java.io.File reportsDirectory)
void
setRunOrder(java.lang.String runOrder)
void
setRunOrderRandomSeed(java.lang.Long runOrderRandomSeed)
void
setSkip(boolean skip)
void
setSkipExec(boolean skipExec)
Deprecated.void
setSkipITs(boolean skipITs)
void
setSkipTests(boolean skipTests)
Deprecated.void
setSuiteXmlFiles(java.io.File[] suiteXmlFiles)
void
setSummaryFile(java.io.File summaryFile)
void
setSystemPropertiesFile(java.io.File systemPropertiesFile)
void
setTest(java.lang.String test)
void
setTestClassesDirectory(java.io.File testClassesDirectory)
void
setTestFailureIgnore(boolean testFailureIgnore)
void
setUseFile(boolean useFile)
void
setUseManifestOnlyJar(boolean useManifestOnlyJar)
protected void
setUseModulePath(boolean useModulePath)
void
setUseSystemClassLoader(boolean useSystemClassLoader)
protected java.util.List<java.io.File>
suiteXmlFiles()
CallsAbstractSurefireMojo.getSuiteXmlFiles()
aslist
.private static java.io.File
toAbsoluteCanonical(java.io.File f)
protected boolean
useModulePath()
-
Methods inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo
cleanupForkConfiguration, convertWithCoreCount, createCopyAndReplaceForkNumPlaceholder, createProviders, effectiveIsEnableAssertions, execute, getAdditionalClasspathElements, getArgLine, getClassLoaderConfiguration, getClasspathDependencyExcludes, getClasspathDependencyScopeExclude, getConsoleLogger, getDependenciesToScan, getEffectiveForkCount, getEnvironmentVariables, getExcludedGroups, getFailIfNoTests, getForkCount, getForkMode, getGroups, getJdkToolchain, getJunitArtifactName, getJvm, getLocalRepository, getMojoArtifact, getObjectFactory, getParallel, getPerCoreThreadCount, getPluginArtifactMap, getPluginDescriptor, getProject, getProjectArtifactMap, getProjectBuildDirectory, getProjectRemoteRepositories, getRemoteRepositories, getReportNameSuffix, getRepositorySystem, getSession, getSpecificTests, getSystemProperties, getSystemPropertyVariables, getTempDir, getTestNGArtifactName, getTestSourceDirectory, getThreadCount, getThreadCountClasses, getThreadCountMethods, getThreadCountSuites, getToolchainManager, getUseUnlimitedThreads, getWorkingDirectory, hasExecutedBefore, isAnyConcurrencySelected, isAnyGroupsSelected, isChildDelegation, isDisableXmlReport, isEnableAssertions, isForking, isMavenParallel, isParallelOptimized, isRedirectTestOutputToFile, isReuseForks, isTrimStackTrace, logDebugOrCliShowErrors, logReportsDirectory, setAdditionalClasspathElements, setArgLine, setChildDelegation, setClasspathDependencyExcludes, setClasspathDependencyScopeExclude, setDependenciesToScan, setDisableXmlReport, setEnableAssertions, setEnvironmentVariables, setExcludedGroups, setFailIfNoTests, setForkMode, setGroups, setJdkToolchain, setJunitArtifactName, setLocalRepository, setObjectFactory, setParallel, setParallelOptimized, setPerCoreThreadCount, setPluginArtifactMap, setProject, setProjectArtifactMap, setProjectBuildDirectory, setProjectRemoteRepositories, setProperties, setRedirectTestOutputToFile, setRemoteRepositories, setReportNameSuffix, setRepositorySystem, setResolutionErrorHandler, setSession, setSystemProperties, setSystemPropertyVariables, setTempDir, setTestNGArtifactName, setTestSourceDirectory, setThreadCount, setThreadCountClasses, setThreadCountMethods, setThreadCountSuites, setToolchainManager, setTrimStackTrace, setUseUnlimitedThreads, setWorkingDirectory, warnIfIllegalFailOnFlakeCount
-
-
-
-
Field Detail
-
FAILSAFE_IN_PROGRESS_CONTEXT_KEY
private static final java.lang.String FAILSAFE_IN_PROGRESS_CONTEXT_KEY
- See Also:
- Constant Field Values
-
classesDirectory
@Parameter private java.io.File classesDirectory
The path representing project JAR file, if exists; Otherwise the directory containing generated classes of the project being tested. This will be included after the test classes in the test classpath. Defaults to built artifact JAR file or${project.build.outputDirectory}
.
-
defaultClassesDirectory
@Parameter(defaultValue="${project.build.outputDirectory}", readonly=true, required=true) private java.io.File defaultClassesDirectory
-
skipITs
@Parameter(property="skipITs") private boolean skipITs
Set this to "true" to skip running integration tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.- Since:
- 2.4.3-alpha-2
-
reportsDirectory
@Parameter(defaultValue="${project.build.directory}/failsafe-reports") private java.io.File reportsDirectory
Base directory where all reports are written to.
-
test
@Parameter(property="it.test") private java.lang.String test
-
summaryFile
@Parameter(defaultValue="${project.build.directory}/failsafe-reports/failsafe-summary.xml", required=true) private java.io.File summaryFile
The summary file to write integration test results to.
-
printSummary
@Parameter(property="failsafe.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="failsafe.reportFormat", defaultValue="brief") private java.lang.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="failsafe.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="it.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.failsafe.debug") private java.lang.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 debugging ability options (without overwriting the other options specified through theargLine
parameter).- Since:
- 2.4
-
forkedProcessTimeoutInSeconds
@Parameter(property="failsafe.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="failsafe.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 bySystem.exit()
. Use this parameter in order to determine the timeout of terminating the process. see the documentation: http://maven.apache.org/surefire/maven-failsafe-plugin/examples/shutdown.html- Since:
- 2.20
-
parallelTestsTimeoutInSeconds
@Parameter(property="failsafe.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 specifiedparallel
different from "none".- Since:
- 2.16
-
parallelTestsTimeoutForcedInSeconds
@Parameter(property="failsafe.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 specifiedparallel
different from "none".- Since:
- 2.16
-
includes
@Parameter(property="failsafe.includes") private java.util.List<java.lang.String> includes
-
excludes
@Parameter(property="failsafe.excludes") private java.util.List<java.lang.String> excludes
A list of <exclude> elements specifying the tests (by pattern) that should be excluded in testing. When not specified and when thetest
parameter is not specified, the default excludes will be
(which excludes all inner classes).<excludes> <exclude>**/*$*</exclude> </excludes>
This parameter is ignored if the TestNGsuiteXmlFiles
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 parametertestClassesDirectory
which defaults to the POM property${project.build.testOutputDirectory}
, typicallysrc/test/java
unless overridden.
-
useSystemClassLoader
@Parameter(property="failsafe.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="failsafe.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-failsafe-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="encoding", defaultValue="${project.reporting.outputEncoding}") private java.lang.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 still encoded with JVM's encoding used in standard out/err pipes.- Since:
- 3.0.0-M1
-
rerunFailingTestsCount
@Parameter(property="failsafe.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.
-
suiteXmlFiles
@Parameter(property="failsafe.suiteXmlFiles") private java.io.File[] suiteXmlFiles
(TestNG) List of <suiteXmlFile> elements specifying TestNG suite xml file locations. Note thatsuiteXmlFiles
is incompatible with several other parameters of this plugin, likeincludes
andexcludes
.
This parameter is ignored if thetest
parameter is specified (allowing you to run a single test instead of an entire suite).- Since:
- 2.2
-
runOrder
@Parameter(property="failsafe.runOrder", defaultValue="filesystem") private java.lang.String runOrder
Defines the order the tests will be run in. Supported values arealphabetical
,reversealphabetical
,random
,hourly
(alphabetical on even hours, reverse alphabetical on odd hours),failedfirst
,balanced
andfilesystem
.
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="failsafe.runOrder.random.seed") private java.lang.Long runOrderRandomSeed
Sets the random seed that will be used to order the tests iffailsafe.runOrder
is set torandom
.
If no seeds are set andfailsafe.runOrder
is set torandom
, then the seed used will be outputted (search for "To reproduce ordering use flag -Dfailsafe.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="failsafe.includesFile") private java.io.File includesFile
A file containing include patterns, each in a next line. Blank lines, or lines starting with # are ignored. Ifincludes
are also specified, these patterns are appended. Example with path, simple and regex includes:*/it/* **/NotIncludedByDefault.java %regex[.*IT.*|.*Not.*]
Since 3.0.0-M6, method filtering support is provided in the inclusions file as well, example:pkg.SomeIT#testMethod
- Since:
- 2.13
-
excludesFile
@Parameter(property="failsafe.excludesFile") private java.io.File excludesFile
A file containing exclude patterns, each in a next line. Blank lines, or lines starting with # are ignored. Ifexcludes
are also specified, these patterns are appended. Example with path, simple and regex excludes:*/it/* **/DontRunIT.* %regex[.*IT.*|.*Not.*]
Since 3.0.0-M6, method filtering support is provided in the exclusions file as well, example:pkg.SomeIT#testMethod
- Since:
- 2.13
-
skipAfterFailureCount
@Parameter(property="failsafe.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-Dfailsafe.skipAfterFailureCount=1
or any number greater than zero. Defaults to "0".
See the prerequisites and limitations in documentation:
http://maven.apache.org/plugins/maven-failsafe-plugin/examples/skip-after-failure.html- Since:
- 2.19
-
shutdown
@Parameter(property="failsafe.shutdown", defaultValue="exit") private java.lang.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 valuestestset
andkill
.
With(shutdown=testset
) the test set may still continue to run in forked JVM.
Usingexit
forked JVM executesSystem.exit(1)
after the plugin process has received SIGTERM signal.
Usingkill
the JVM executesRuntime.halt(1)
and kills itself.- Since:
- 2.19
-
useModulePath
@Parameter(property="failsafe.useModulePath", defaultValue="true") private boolean useModulePath
Whentrue
, uses the modulepath when executing with JDK 9+ and module-info.java is present. Whenfalse
, always uses the classpath.
Defaults totrue
.- Since:
- 3.0.0-M2
-
forkNode
@Parameter(property="failsafe.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="failsafe.excludedEnvironmentVariables") private java.lang.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 -Dfailsafe.excludedEnvironmentVariables=ACME1,ACME2,ACME3- Since:
- 3.0.0-M4
-
enableProcessChecker
@Parameter(property="failsafe.enableProcessChecker") private java.lang.String enableProcessChecker
Since 3.0.0-M4 the process checkers are disabled. You can enable them namely by settingping
andnative
orall
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.
Theping
should be safely used together with ZGC or Shenandoah Garbage Collector. Due to theping
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.
Thenative
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 isforkedProcessTimeoutInSeconds
.
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 -Dfailsafe.enableProcessChecker=all- Since:
- 3.0.0-M4
-
systemPropertiesFile
@Parameter(property="failsafe.systemPropertiesFile") private java.io.File systemPropertiesFile
-
includeJUnit5Engines
@Parameter(property="includeJUnit5Engines") private java.lang.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 java.lang.String[] excludeJUnit5Engines
Provide the ID/s of an JUnit engine to be excluded in the test run.- Since:
- 3.0.0-M6
-
-
Method Detail
-
getRerunFailingTestsCount
protected int getRerunFailingTestsCount()
- Specified by:
getRerunFailingTestsCount
in classAbstractSurefireMojo
-
handleSummary
protected void handleSummary(RunResult summary, java.lang.Exception firstForkException) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
- Specified by:
handleSummary
in classAbstractSurefireMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
-
isJarArtifact
private boolean isJarArtifact(java.io.File artifactFile)
-
toAbsoluteCanonical
private static java.io.File toAbsoluteCanonical(java.io.File f)
-
isSkipExecution
protected boolean isSkipExecution()
- Specified by:
isSkipExecution
in classAbstractSurefireMojo
-
getPluginName
protected java.lang.String getPluginName()
- Specified by:
getPluginName
in classAbstractSurefireMojo
-
getDefaultIncludes
protected java.lang.String[] getDefaultIncludes()
- Specified by:
getDefaultIncludes
in classAbstractSurefireMojo
-
getReportSchemaLocation
protected java.lang.String getReportSchemaLocation()
- Specified by:
getReportSchemaLocation
in classAbstractSurefireMojo
-
isSkipTests
public boolean isSkipTests()
-
setSkipTests
@Deprecated public void setSkipTests(boolean skipTests)
Deprecated.
-
isSkipITs
public boolean isSkipITs()
-
setSkipITs
public void setSkipITs(boolean skipITs)
-
isSkipExec
@Deprecated public boolean isSkipExec()
Deprecated.
-
setSkipExec
@Deprecated public void setSkipExec(boolean skipExec)
Deprecated.
-
isSkip
public boolean isSkip()
-
setSkip
public void setSkip(boolean skip)
-
getBasedir
public java.io.File getBasedir()
-
setBasedir
public void setBasedir(java.io.File basedir)
-
getTestClassesDirectory
public java.io.File getTestClassesDirectory()
-
setTestClassesDirectory
public void setTestClassesDirectory(java.io.File testClassesDirectory)
-
getMainBuildPath
public java.io.File getMainBuildPath()
- Returns:
- Output directory, or artifact file if artifact type is "jar". If not forking the JVM, parameter
useSystemClassLoader
is ignored and theIsolatedClassLoader
is used instead. See the resolution ofClassLoaderConfiguration
.
-
setMainBuildPath
public void setMainBuildPath(java.io.File mainBuildPath)
-
setDefaultClassesDirectory
public void setDefaultClassesDirectory(java.io.File defaultClassesDirectory)
-
getReportsDirectory
public java.io.File getReportsDirectory()
-
setReportsDirectory
public void setReportsDirectory(java.io.File reportsDirectory)
-
getTest
public java.lang.String getTest()
-
setTest
public void setTest(java.lang.String test)
-
getSummaryFile
public java.io.File getSummaryFile()
-
setSummaryFile
public void setSummaryFile(java.io.File summaryFile)
-
isPrintSummary
public boolean isPrintSummary()
-
setPrintSummary
public void setPrintSummary(boolean printSummary)
-
getReportFormat
public java.lang.String getReportFormat()
-
setReportFormat
public void setReportFormat(java.lang.String reportFormat)
-
isUseFile
public boolean isUseFile()
-
setUseFile
public void setUseFile(boolean useFile)
-
getDebugForkedProcess
public java.lang.String getDebugForkedProcess()
-
setDebugForkedProcess
public void setDebugForkedProcess(java.lang.String debugForkedProcess)
-
getForkedProcessTimeoutInSeconds
public int getForkedProcessTimeoutInSeconds()
-
setForkedProcessTimeoutInSeconds
public void setForkedProcessTimeoutInSeconds(int forkedProcessTimeoutInSeconds)
-
getForkedProcessExitTimeoutInSeconds
public int getForkedProcessExitTimeoutInSeconds()
-
setForkedProcessExitTimeoutInSeconds
public void setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds)
-
getParallelTestsTimeoutInSeconds
public double getParallelTestsTimeoutInSeconds()
-
setParallelTestsTimeoutInSeconds
public void setParallelTestsTimeoutInSeconds(double parallelTestsTimeoutInSeconds)
-
getParallelTestsTimeoutForcedInSeconds
public double getParallelTestsTimeoutForcedInSeconds()
-
setParallelTestsTimeoutForcedInSeconds
public void setParallelTestsTimeoutForcedInSeconds(double parallelTestsTimeoutForcedInSeconds)
-
isUseSystemClassLoader
public boolean isUseSystemClassLoader()
-
setUseSystemClassLoader
public void setUseSystemClassLoader(boolean useSystemClassLoader)
-
isUseManifestOnlyJar
public boolean isUseManifestOnlyJar()
-
setUseManifestOnlyJar
public void setUseManifestOnlyJar(boolean useManifestOnlyJar)
-
getEncoding
public java.lang.String getEncoding()
-
setEncoding
public void setEncoding(java.lang.String encoding)
-
isTestFailureIgnore
public boolean isTestFailureIgnore()
-
setTestFailureIgnore
public void setTestFailureIgnore(boolean testFailureIgnore)
-
addPluginSpecificChecksumItems
protected void addPluginSpecificChecksumItems(ChecksumCalculator checksum)
- Overrides:
addPluginSpecificChecksumItems
in classAbstractSurefireMojo
-
getSystemPropertiesFile
public java.io.File getSystemPropertiesFile()
Description copied from class:AbstractSurefireMojo
List of System properties, loaded from a file, to pass to the JUnit tests.- Specified by:
getSystemPropertiesFile
in classAbstractSurefireMojo
-
setSystemPropertiesFile
public void setSystemPropertiesFile(java.io.File systemPropertiesFile)
- Specified by:
setSystemPropertiesFile
in classAbstractSurefireMojo
-
getFailIfNoSpecifiedTests
public boolean getFailIfNoSpecifiedTests()
-
setFailIfNoSpecifiedTests
public void setFailIfNoSpecifiedTests(boolean failIfNoSpecifiedTests)
-
getSkipAfterFailureCount
public int getSkipAfterFailureCount()
-
getShutdown
public java.lang.String getShutdown()
-
getIncludes
public java.util.List<java.lang.String> getIncludes()
- Specified by:
getIncludes
in interfaceSurefireExecutionParameters
- Specified by:
getIncludes
in classAbstractSurefireMojo
-
setIncludes
public void setIncludes(java.util.List<java.lang.String> includes)
- Specified by:
setIncludes
in interfaceSurefireExecutionParameters
- Specified by:
setIncludes
in classAbstractSurefireMojo
-
getExcludes
public java.util.List<java.lang.String> getExcludes()
-
setExcludes
public void setExcludes(java.util.List<java.lang.String> excludes)
-
getSuiteXmlFiles
public java.io.File[] getSuiteXmlFiles()
- Specified by:
getSuiteXmlFiles
in classAbstractSurefireMojo
-
setSuiteXmlFiles
public void setSuiteXmlFiles(java.io.File[] suiteXmlFiles)
- Specified by:
setSuiteXmlFiles
in classAbstractSurefireMojo
-
getRunOrder
public java.lang.String getRunOrder()
- Specified by:
getRunOrder
in classAbstractSurefireMojo
-
setRunOrder
public void setRunOrder(java.lang.String runOrder)
- Specified by:
setRunOrder
in classAbstractSurefireMojo
-
getRunOrderRandomSeed
public java.lang.Long getRunOrderRandomSeed()
- Specified by:
getRunOrderRandomSeed
in classAbstractSurefireMojo
-
setRunOrderRandomSeed
public void setRunOrderRandomSeed(java.lang.Long runOrderRandomSeed)
- Specified by:
setRunOrderRandomSeed
in classAbstractSurefireMojo
-
getIncludesFile
public java.io.File getIncludesFile()
- Specified by:
getIncludesFile
in classAbstractSurefireMojo
-
getExcludesFile
public java.io.File getExcludesFile()
- Specified by:
getExcludesFile
in classAbstractSurefireMojo
-
useModulePath
protected boolean useModulePath()
- Specified by:
useModulePath
in classAbstractSurefireMojo
-
setUseModulePath
protected void setUseModulePath(boolean useModulePath)
- Specified by:
setUseModulePath
in classAbstractSurefireMojo
-
suiteXmlFiles
protected final java.util.List<java.io.File> suiteXmlFiles()
Description copied from class:AbstractSurefireMojo
- Specified by:
suiteXmlFiles
in classAbstractSurefireMojo
- Returns:
- list of TestNG suite XML files provided by MOJO
-
hasSuiteXmlFiles
protected final boolean hasSuiteXmlFiles()
- Specified by:
hasSuiteXmlFiles
in classAbstractSurefireMojo
- Returns:
true
ifsuite-xml files array
is not empty.
-
getForkNode
protected final ForkNodeFactory getForkNode()
- Specified by:
getForkNode
in classAbstractSurefireMojo
-
getExcludedEnvironmentVariables
protected final java.lang.String[] getExcludedEnvironmentVariables()
- Specified by:
getExcludedEnvironmentVariables
in classAbstractSurefireMojo
-
setExcludedEnvironmentVariables
void setExcludedEnvironmentVariables(java.lang.String[] excludedEnvironmentVariables)
-
getEnableProcessChecker
protected final java.lang.String getEnableProcessChecker()
- Specified by:
getEnableProcessChecker
in classAbstractSurefireMojo
-
getIncludeJUnit5Engines
public java.lang.String[] getIncludeJUnit5Engines()
-
setIncludeJUnit5Engines
public void setIncludeJUnit5Engines(java.lang.String[] includeJUnit5Engines)
-
getExcludeJUnit5Engines
public java.lang.String[] getExcludeJUnit5Engines()
-
setExcludeJUnit5Engines
public void setExcludeJUnit5Engines(java.lang.String[] excludeJUnit5Engines)
-
-