Fork me on GitHub
Built by Maven

failsafe:verify

Full name:

org.apache.maven.plugins:maven-failsafe-plugin:3.6.0:verify

Description:

Verify integration tests ran using Failsafe.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
<summaryFile> File - The summary file to read integration test results from.
Default: ${project.build.directory}/failsafe-reports/failsafe-summary.xml

Optional Parameters

Name Type Since Description
<basedir> File - The base directory of the project being tested. This can be obtained in your unit test by System.getProperty("basedir").
Default: ${basedir}
<failIfNoTests> boolean 2.4 Set this to "true" to cause a failure if there are no tests to run. Defaults to "false".
Default: false
User Property: failIfNoTests
<failOnFlakeCount> int 3.0.0-M6 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.
Default: 0
User Property: failsafe.failOnFlakeCount
<reportsDirectory> File - Base directory where all reports are written to.
Default: ${project.build.directory}/failsafe-reports
<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: false
User Property: maven.test.skip
<skipExec> boolean 2.3
Deprecated.
use -DskipTests instead

This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec.
User Property: maven.test.skip.exec
<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.
User Property: skipITs
<skipTests> boolean 2.4
Deprecated.
use skipITs instead

Set this to 'true' to skip verifying integration test results.

Unlike Surefire's skipTests, this Failsafe parameter is not bound to the skipTests user property. Use -DskipITs on the command line to skip integration tests (including this verification step), or -Dmaven.test.skip to skip everything. The <skipTests> element is still honored when set explicitly in the plugin <configuration>.

<summaryFiles> File[] 2.6 Additional summary files to read integration test results from.
<testClassesDirectory> File - The directory containing generated test classes of the project being tested. This will be included at the beginning the test classpath.
Default: ${project.build.testOutputDirectory}
<testFailureIgnore> boolean - Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.
Default: false
User Property: maven.test.failure.ignore

Parameter Details

<basedir>

The base directory of the project being tested. This can be obtained in your unit test by System.getProperty("basedir").
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}

<failIfNoTests>

Set this to "true" to cause a failure if there are no tests to run. Defaults to "false".
  • Type: boolean
  • Since: 2.4
  • Required: No
  • User Property: failIfNoTests
  • Default: false

<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.
  • Type: int
  • Since: 3.0.0-M6
  • Required: No
  • User Property: failsafe.failOnFlakeCount
  • Default: 0

<reportsDirectory>

Base directory where all reports are written to.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/failsafe-reports

<skip>

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.
  • Type: boolean
  • Required: No
  • User Property: maven.test.skip
  • Default: false

<skipExec>

Deprecated.
use -DskipTests instead

This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: maven.test.skip.exec

<skipITs>

Set this to 'true' to skip running integration tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Since: 2.4.3-alpha-2
  • Required: No
  • User Property: skipITs

<skipTests>

Deprecated.
use skipITs instead

Set this to 'true' to skip verifying integration test results.

Unlike Surefire's skipTests, this Failsafe parameter is not bound to the skipTests user property. Use -DskipITs on the command line to skip integration tests (including this verification step), or -Dmaven.test.skip to skip everything. The <skipTests> element is still honored when set explicitly in the plugin <configuration>.

  • Type: boolean
  • Since: 2.4
  • Required: No

<summaryFile>

The summary file to read integration test results from.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/failsafe-reports/failsafe-summary.xml

<summaryFiles>

Additional summary files to read integration test results from.
  • Type: java.io.File[]
  • Since: 2.6
  • Required: No

<testClassesDirectory>

The directory containing generated test classes of the project being tested. This will be included at the beginning the test classpath.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.testOutputDirectory}

<testFailureIgnore>

Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Required: No
  • User Property: maven.test.failure.ignore
  • Default: false