Fork me on GitHub
Built by Maven

surefire-report:report

Note:

This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-surefire-report-plugin:3.2.5:report

Description:

Creates a nicely formatted Surefire Test Report in html format.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.
  • Invokes the execution of the following lifecycle phase prior to executing itself: test.
  • Executes in its own lifecycle: surefire.
  • Is NOT inherited by default in multi-project builds.

Required Parameters

Name Type Since Description
<outputName> String - The filename to use for the report.
Default: surefire-report
User Property: outputName
<showSuccess> boolean - If set to false, only failures are shown.
Default: true
User Property: showSuccess

Optional Parameters

Name Type Since Description
<aggregate> boolean - Whether to build an aggregated report at the root, or build individual reports.
Default: false
User Property: aggregate
<alwaysGenerateSurefireReport> boolean 2.11 If set to true the surefire report will be generated even when there are no surefire result files. Defaults to true to preserve legacy behaviour pre 2.10.
Default: true
User Property: alwaysGenerateSurefireReport
<customBundle> String 3.1.0 Path for a custom bundle instead of using the default one.
Using this field, you could change the texts in the generated reports.
Default: ${basedir}/src/site/custom/surefire-report.properties
<linkXRef> boolean - Whether to link the XRef if found.
Default: true
User Property: linkXRef
<reportsDirectories> File[] - Directories containing the XML Report files that will be parsed and rendered to HTML format.
<reportsDirectory> File - Deprecated. (Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.
<skipSurefireReport> boolean 2.11 If set to true the surefire report generation will be skipped.
Default: false
User Property: skipSurefireReport
<xrefLocation> File - Location of the Xrefs to link.
Default: ${project.reporting.outputDirectory}/xref-test

Parameter Details

<aggregate>

Whether to build an aggregated report at the root, or build individual reports.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: aggregate
  • Default: false

<alwaysGenerateSurefireReport>

If set to true the surefire report will be generated even when there are no surefire result files. Defaults to true to preserve legacy behaviour pre 2.10.
  • Type: boolean
  • Since: 2.11
  • Required: report.plugin.goal.no
  • User Property: alwaysGenerateSurefireReport
  • Default: true

<customBundle>

Path for a custom bundle instead of using the default one.
Using this field, you could change the texts in the generated reports.
  • Type: java.lang.String
  • Since: 3.1.0
  • Required: report.plugin.goal.no
  • Default: ${basedir}/src/site/custom/surefire-report.properties

<linkXRef>

Whether to link the XRef if found.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: linkXRef
  • Default: true

<outputName>

The filename to use for the report.
  • Type: java.lang.String
  • Required: report.plugin.goal.yes
  • User Property: outputName
  • Default: surefire-report

<reportsDirectories>

Directories containing the XML Report files that will be parsed and rendered to HTML format.
  • Type: java.io.File[]
  • Required: report.plugin.goal.no

<reportsDirectory>

Deprecated. No reason given
(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.
  • Type: java.io.File
  • Required: report.plugin.goal.no

<showSuccess>

If set to false, only failures are shown.
  • Type: boolean
  • Required: report.plugin.goal.yes
  • User Property: showSuccess
  • Default: true

<skipSurefireReport>

If set to true the surefire report generation will be skipped.
  • Type: boolean
  • Since: 2.11
  • Required: report.plugin.goal.no
  • User Property: skipSurefireReport
  • Default: false

<xrefLocation>

Location of the Xrefs to link.
  • Type: java.io.File
  • Required: report.plugin.goal.no
  • Default: ${project.reporting.outputDirectory}/xref-test