Maven Surefire Report Plugin – Plugin Documentation

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Report?	Description
surefire-report:failsafe-report-only	Yes	Creates a nicely formatted Failsafe Test Report in html format. This goal does not run the tests, it only builds the reports. See https://issues.apache.org/jira/browse/SUREFIRE-257
surefire-report:help	No	Display help information on maven-surefire-report-plugin. Call `mvn surefire-report:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
surefire-report:report	Yes	Creates a nicely formatted Surefire Test Report in html format.
surefire-report:report-only	Yes	Creates a nicely formatted Surefire Test Report in html format. This goal does not run the tests, it only builds the reports. This is a workaround for https://issues.apache.org/jira/browse/SUREFIRE-257

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.6.3
JDK	1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version	Maven	JDK
from 3.3.0 to 3.5.2	3.6.3	8
from 3.0.0-M6 to 3.2.5	3.2.5	8
from 3.0.0-M1 to 3.0.0-M5	3.0	7
from 2.20 to 2.22.2	2.2.1	6
from 2.18 to 2.19.1	2.2.1	5
from 2.12 to 2.17	2.0.9	5
from 2.7.2 to 2.11	2.0.9	1.4
from 2.6 to 2.7.1	2.0.6	1.4
2.5	2.0.6	1.3
from 2.3 to 2.4.3	2.0.3	1.3
2.0	2.0.3	-

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-surefire-report-plugin</artifactId>
          <version>3.5.2</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-report-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-report-plugin</artifactId>
        <version>3.5.2</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"