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.0.0: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 lifecycle phase test prior to executing itself.
  • 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 value is: surefire-report.
User property is: outputName.
<showSuccess> boolean - If set to false, only failures are shown.
Default value is: true.
User property is: showSuccess.

Optional Parameters

Name Type Since Description
<aggregate> boolean - Whether to build an aggregated report at the root, or build individual reports.
Default value is: false.
User property is: 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 value is: true.
User property is: alwaysGenerateSurefireReport.
<description> String 2.21.0 A custom description for the project reports page.
User property is: surefire.report.description.
<linkXRef> boolean - Whether to link the XRef if found.
Default value is: true.
User property is: 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 value is: false.
User property is: skipSurefireReport.
<title> String 2.21.0 A custom title of the report for the menu and the project reports page.
User property is: surefire.report.title.
<xrefLocation> File - Location of the Xrefs to link.
Default value is: ${project.reporting.outputDirectory}/xref-test.

Parameter Details

<aggregate>

Whether to build an aggregated report at the root, or build individual reports.
  • Type: boolean
  • Required: 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: No
  • User Property: alwaysGenerateSurefireReport
  • Default: true

<description>

A custom description for the project reports page.
  • Type: java.lang.String
  • Since: 2.21.0
  • Required: No
  • User Property: surefire.report.description

<linkXRef>

Whether to link the XRef if found.
  • Type: boolean
  • Required: No
  • User Property: linkXRef
  • Default: true

<outputName>

The filename to use for the report.
  • Type: java.lang.String
  • Required: 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: 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: No

<showSuccess>

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

<skipSurefireReport>

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

<title>

A custom title of the report for the menu and the project reports page.
  • Type: java.lang.String
  • Since: 2.21.0
  • Required: No
  • User Property: surefire.report.title

<xrefLocation>

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