Required Parameters

Name	Type	Since	Description
summaryFile	File	-	The summary file to write integration test results to.
testSourceDirectory	File	2.2	The test source directory containing test class sources. Default value is: ${project.build.testSourceDirectory}.

Optional Parameters

Name	Type	Since	Description
additionalClasspathElements	List	2.4	Additional elements to be appended to the classpath.
argLine	String	2.1	Arbitrary JVM options to set on the command line.
basedir	File	-	The base directory of the project being tested. This can be obtained in your integration test via System.getProperty("basedir"). Default value is: ${basedir}.
childDelegation	boolean	2.1	When false it makes tests run using the standard classloader delegation instead of the default Maven isolated classloader. Only used when forking (forkMode is not "none"). Setting it to false helps with some problems caused by conflicts between xml parsers in the classpath and the Java 5 provider parser. Default value is: false.
classesDirectory	File	-	The directory containing generated classes of the project being tested. This will be included after the test classes in the test classpath. Default value is: ${project.build.outputDirectory}.
classpathDependencyExcludes	List	2.6	List of dependencies to exclude from the test classpath. Each dependency string must follow the format groupId:artifactId. For example: org.acme:project-a
classpathDependencyScopeExclude	String	2.6	A dependency scope to exclude from the test classpath. The scope should be one of the scopes defined by org.apache.maven.artifact.Artifact. This includes the following: compile - system, provided, compile runtime - compile, runtime compile+runtime - system, provided, compile, runtime runtime+system - system, compile, runtime test - system, provided, compile, runtime, test
debugForkedProcess	String	2.4	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).
disableXmlReport	boolean	2.2	Flag to disable the generation of report files in xml format. Default value is: false.
enableAssertions	boolean	2.3.1	By default, Surefire enables JVM assertions for the execution of your test cases. To disable the assertions, set this flag to "false". Default value is: true.
encoding	String	-	The character encoding scheme to be applied. Default value is: ${project.reporting.outputEncoding}.
environmentVariables	Map	2.1.3	Additional environment variables to set on the command line.
excludedGroups	String	2.2	(TestNG only) Excluded groups. Any methods/classes/etc with one of the groups specified in this list will specifically not be run. This parameter is ignored if the suiteXmlFiles parameter is specified.
excludes	List	-	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 sublist of items, which will be treated as multiple  <exclude> entries.
failIfNoTests	Boolean	2.4	Set this to "true" to cause a failure if there are no tests to run. Defaults to "false".
forkMode	String	2.1	Option to specify the forking mode. Can be "never", "once" or "always". "none" and "pertest" are also accepted for backwards compatibility. "always" forks for each test-class. Default value is: once.
forkedProcessTimeoutInSeconds	int	2.4	Kill the forked test process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.
groups	String	2.2	(TestNG only) Groups for this test. Only classes/methods/etc decorated with one of the groups specified here will be included in test run, if specified. This parameter is ignored if the suiteXmlFiles parameter is specified.
includes	List	-	A list of <include> elements specifying the tests (by pattern) that should be included in testing. When not specified and when the test parameter is not specified, the default includes will be <includes>  <include>**/IT*.java</include>  <include>**/*IT.java</include>  <include>**/*ITCase.java</include> </includes> Each include item may also contain a comma-separated sublist of items, which will be treated as multiple  <include> entries. This parameter is ignored if the TestNG suiteXmlFiles parameter is specified.
junitArtifactName	String	2.3.1	Allows you to specify the name of the JUnit artifact. If not set, junit:junit will be used. Default value is: junit:junit.
jvm	String	2.1	Option to specify the jvm (or path to the java executable) to use with the forking options. For the default, the jvm will be a new instance of the same VM as the one used to run Maven. JVM settings are not inherited from MAVEN_OPTS.
objectFactory	String	2.5	(TestNG only) Define the factory class used to create all test instances.
parallel	String	2.2	(TestNG only) When you use the parallel attribute, TestNG will try to run all your test methods in separate threads, except for methods that depend on each other, which will be run in the same thread in order to respect their order of execution. (JUnit 4.7 provider) Supports values "classes"/"methods"/"both" to run in separate threads, as controlled by threadCount.
perCoreThreadCount	boolean	2.5	(JUnit 4.7 provider) Indicates that threadCount is per cpu core. Default value is: true.
printSummary	boolean	-	Option to print summary of test suites or just print the test cases that have errors. Default value is: true.
properties	Properties	2.4	List of properties for configuring all TestNG related configurations. This is the new preferred method of configuring TestNG.
redirectTestOutputToFile	boolean	2.3	When forking, set this to "true" to redirect the unit test standard output to a file (found in reportsDirectory/testName-output.txt). Default value is: false.
remoteRepositories	List	2.2	The remote plugin repositories declared in the POM.
reportFormat	String	-	Selects the formatting for the test report to be generated. Can be set as "brief" or "plain". Default value is: brief.
reportsDirectory	File	-	Base directory where all reports are written to. Default value is: ${project.build.directory}/failsafe-reports.
runOrder	String	2.7	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) 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. Default value is: filesystem.
skip	boolean	-	Set this to "true" to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable it using the "maven.test.skip" property, because maven.test.skip disables both running the tests and compiling the tests. Consider using the skipTests parameter instead. Default value is: false.
skipExec	boolean	2.3	Deprecated. Use skipTests instead.
skipITs	boolean	2.4.3-alpha-2	Set this to "true" to skip running integration tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
skipTests	boolean	2.4	Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion. Default value is: false.
suiteXmlFiles	File[]	2.2	(TestNG only) List of <suiteXmlFile> elements specifying TestNG suite xml file locations. Note that suiteXmlFiles is incompatible with several other parameters of this plugin, like includes/excludes. This parameter is ignored if the test parameter is specified (allowing you to run a single test instead of an entire suite).
systemProperties	Properties	-	Deprecated. Use systemPropertyVariables instead.
systemPropertyVariables	Map	2.5	List of System properties to pass to the JUnit tests.
test	String	-	Specify this parameter to run individual tests by file name, overriding the includes/excludes parameters. Each pattern you specify here will be used to create an include pattern formatted like **/${test}.java, so you can just type "-Dtest=MyTest" to run a single test called "foo/MyTest.java". This parameter overrides the includes/excludes parameters, and the TestNG suiteXmlFiles parameter.
testClassesDirectory	File	-	The directory containing generated test classes of the project being tested. This will be included at the beginning of the test classpath. Default value is: ${project.build.testOutputDirectory}.
testNGArtifactName	String	2.3.1	Allows you to specify the name of the TestNG artifact. If not set, org.testng:testng will be used. Default value is: org.testng:testng.
threadCount	int	2.2	(TestNG/JUnit 4.7 provider only) The attribute thread-count allows you to specify how many threads should be allocated for this execution. Only makes sense to use in conjunction with the parallel parameter.
trimStackTrace	boolean	2.2	Whether to trim the stack trace in the reports to just the lines within the test, or show the full trace. Default value is: true.
useFile	boolean	-	Option to generate a file test report or just output the test report to the console. Default value is: true.
useManifestOnlyJar	boolean	2.4.3	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 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. Default value is: true.
useSystemClassLoader	boolean	2.3	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. Default value is: true.
useUnlimitedThreads	boolean	2.5	(JUnit 4.7 provider) Indicates that the thread pool will be unlimited. The parallel parameter and the actual number of classes/methods will decide. Setting this to "true" effectively disables perCoreThreadCount and threadCount. Defaults to "false". Default value is: false.
workingDirectory	File	2.1.3	Command line working directory.

Parameter Details

additionalClasspathElements:

• Type: java.util.List
• Since: 2.4
• Required: No

---

argLine:

• Type: java.lang.String
• Since: 2.1
• Required: No
• Expression: ${argLine}

---

basedir:

• Type: java.io.File
• Required: No
• Default: ${basedir}

---

childDelegation:

• Type: boolean
• Since: 2.1
• Required: No
• Expression: ${childDelegation}
• Default: false

---

classesDirectory:

• Type: java.io.File
• Required: No
• Default: ${project.build.outputDirectory}

---

classpathDependencyExcludes:

• Type: java.util.List
• Since: 2.6
• Required: No

---

classpathDependencyScopeExclude:

• Type: java.lang.String
• Since: 2.6
• Required: No

---

debugForkedProcess:

• Type: java.lang.String
• Since: 2.4
• Required: No
• Expression: ${maven.failsafe.debug}

---

disableXmlReport:

• Type: boolean
• Since: 2.2
• Required: No
• Expression: ${disableXmlReport}
• Default: false

---

enableAssertions:

• Type: boolean
• Since: 2.3.1
• Required: No
• Expression: ${enableAssertions}
• Default: true

---

encoding:

• Type: java.lang.String
• Required: No
• Expression: ${encoding}
• Default: ${project.reporting.outputEncoding}

---

environmentVariables:

• Type: java.util.Map
• Since: 2.1.3
• Required: No

---

excludedGroups:

• Type: java.lang.String
• Since: 2.2
• Required: No
• Expression: ${excludedGroups}

---

excludes:

• Type: java.util.List
• Required: No

---

failIfNoTests:

• Type: java.lang.Boolean
• Since: 2.4
• Required: No
• Expression: ${failIfNoTests}

---

forkMode:

• Type: java.lang.String
• Since: 2.1
• Required: No
• Expression: ${forkMode}
• Default: once

---

forkedProcessTimeoutInSeconds:

• Type: int
• Since: 2.4
• Required: No
• Expression: ${failsafe.timeout}

---

groups:

• Type: java.lang.String
• Since: 2.2
• Required: No
• Expression: ${groups}

---

includes:

• Type: java.util.List
• Required: No

---

junitArtifactName:

• Type: java.lang.String
• Since: 2.3.1
• Required: No
• Expression: ${junitArtifactName}
• Default: junit:junit

---

jvm:

• Type: java.lang.String
• Since: 2.1
• Required: No
• Expression: ${jvm}

---

objectFactory:

• Type: java.lang.String
• Since: 2.5
• Required: No
• Expression: ${objectFactory}

---

parallel:

• Type: java.lang.String
• Since: 2.2
• Required: No
• Expression: ${parallel}

---

perCoreThreadCount:

• Type: boolean
• Since: 2.5
• Required: No
• Expression: ${perCoreThreadCount}
• Default: true

---

printSummary:

• Type: boolean
• Required: No
• Expression: ${failsafe.printSummary}
• Default: true

---

properties:

• Type: java.util.Properties
• Since: 2.4
• Required: No

---

redirectTestOutputToFile:

• Type: boolean
• Since: 2.3
• Required: No
• Expression: ${maven.test.redirectTestOutputToFile}
• Default: false

---

remoteRepositories:

• Type: java.util.List
• Since: 2.2
• Required: No
• Expression: ${project.pluginArtifactRepositories}

---

reportFormat:

• Type: java.lang.String
• Required: No
• Expression: ${failsafe.reportFormat}
• Default: brief

---

reportsDirectory:

• Type: java.io.File
• Required: No
• Default: ${project.build.directory}/failsafe-reports

---

runOrder:

• Type: java.lang.String
• Since: 2.7
• Required: No
• Default: filesystem

---

skip:

• Type: boolean
• Required: No
• Expression: ${maven.test.skip}
• Default: false

---

skipExec:

• Type: boolean
• Since: 2.3
• Required: No
• Expression: ${maven.test.skip.exec}

---

skipITs:

• Type: boolean
• Since: 2.4.3-alpha-2
• Required: No
• Expression: ${skipITs}

---

skipTests:

• Type: boolean
• Since: 2.4
• Required: No
• Expression: ${skipTests}
• Default: false

---

suiteXmlFiles:

• Type: java.io.File[]
• Since: 2.2
• Required: No

---

summaryFile:

• Type: java.io.File
• Required: Yes
• Expression: ${project.build.directory}/failsafe-reports/failsafe-summary.xml

---

systemProperties:

• Type: java.util.Properties
• Required: No

---

systemPropertyVariables:

• Type: java.util.Map
• Since: 2.5
• Required: No

---

test:

• Type: java.lang.String
• Required: No
• Expression: ${it.test}

---

testClassesDirectory:

• Type: java.io.File
• Required: No
• Default: ${project.build.testOutputDirectory}

---

testNGArtifactName:

• Type: java.lang.String
• Since: 2.3.1
• Required: No
• Expression: ${testNGArtifactName}
• Default: org.testng:testng

---

testSourceDirectory:

• Type: java.io.File
• Since: 2.2
• Required: Yes
• Default: ${project.build.testSourceDirectory}

---

threadCount:

• Type: int
• Since: 2.2
• Required: No
• Expression: ${threadCount}

---

trimStackTrace:

• Type: boolean
• Since: 2.2
• Required: No
• Expression: ${trimStackTrace}
• Default: true

---

useFile:

• Type: boolean
• Required: No
• Expression: ${failsafe.useFile}
• Default: true

---

useManifestOnlyJar:

• Type: boolean
• Since: 2.4.3
• Required: No
• Expression: ${failsafe.useManifestOnlyJar}
• Default: true

---

useSystemClassLoader:

• Type: boolean
• Since: 2.3
• Required: No
• Expression: ${failsafe.useSystemClassLoader}
• Default: true

---

useUnlimitedThreads:

• Type: boolean
• Since: 2.5
• Required: No
• Expression: ${useUnlimitedThreads}
• Default: false

---

workingDirectory:

• Type: java.io.File
• Since: 2.1.3
• Required: No
• Expression: ${basedir}