Fork me on GitHub

surefire-report:report-only

Note:This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-surefire-report-plugin:2.14.1:report-only

Description:

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 http://jira.codehaus.org/browse/SUREFIRE-257

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 2.3.
  • Invokes the execution of the lifecycle phase validate prior to executing itself.
  • Executes in its own lifecycle: surefire.

Required Parameters

Name Type Since Description
outputName String 2.3 The filename to use for the report.
Default value is: surefire-report.
project MavenProject 2.3 Maven Project
showSuccess boolean 2.3 If set to false, only failures are shown.
Default value is: true.

Optional Parameters

Name Type Since Description
aggregate boolean 2.3 Whether to build an aggregated report at the root, or build individual reports.
Default value is: false.
alwaysGenerateSurefireReport boolean 2.11 If set to true the surefire report will be generated even when there are no surefire result files. Defaulyts to true to preserve legacy behaviour pre 2.10.
Default value is: true.
linkXRef boolean 2.3 Whether to link the XRef if found.
Default value is: true.
outputDirectory File 2.3 Location where generated html will be created.
reportsDirectories File[] 2.3 Directories containing the XML Report files that will be parsed and rendered to HTML format.
reportsDirectory File 2.3 (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.
xrefLocation File 2.3 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
  • Since: 2.3
  • Required: No
  • Expression: ${aggregate}
  • Default: false

alwaysGenerateSurefireReport:

If set to true the surefire report will be generated even when there are no surefire result files. Defaulyts to true to preserve legacy behaviour pre 2.10.
  • Type: boolean
  • Since: 2.11
  • Required: No
  • Expression: ${alwaysGenerateSurefireReport}
  • Default: true

linkXRef:

Whether to link the XRef if found.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Expression: ${linkXRef}
  • Default: true

outputDirectory:

Location where generated html will be created.
  • Type: java.io.File
  • Since: 2.3
  • Required: No
  • Expression: ${project.reporting.outputDirectory}

outputName:

The filename to use for the report.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${outputName}
  • Default: surefire-report

project:

Maven Project
  • Type: org.apache.maven.project.MavenProject
  • Since: 2.3
  • Required: Yes
  • Expression: ${project}

reportsDirectories:

Directories containing the XML Report files that will be parsed and rendered to HTML format.
  • Type: java.io.File[]
  • Since: 2.3
  • Required: No

reportsDirectory:

(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.
  • Type: java.io.File
  • Since: 2.3
  • Required: No

showSuccess:

If set to false, only failures are shown.
  • Type: boolean
  • Since: 2.3
  • Required: Yes
  • Expression: ${showSuccess}
  • Default: true

skipSurefireReport:

If set to true the surefire report generation will be skipped.
  • Type: boolean
  • Since: 2.11
  • Required: No
  • Expression: ${skipSurefireReport}
  • Default: false

xrefLocation:

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