surefire-report:report

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

Full name:

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

Description:

Creates a nicely formatted Surefire Test Report in html format.

Attributes:

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

Required Parameters

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

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.
linkXRef boolean - Whether to link the XRef if found.
Default value is: true.
outputDirectory File - Location where generated html will be created.
reportsDirectories File[] - Directories containing the XML Report files that will be parsed and rendered to HTML format.
reportsDirectory File - (Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.
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
  • Expression: ${aggregate}
  • Default: false

linkXRef:

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

outputDirectory:

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

outputName:

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

project:

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

reportsDirectories:

Directories containing the XML Report files that will be parsed and rendered to HTML format.
  • Type: java.io.File[]
  • 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
  • Required: No

showSuccess:

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

xrefLocation:

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