surefire-report:report
Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-surefire-report-plugin:2.12:report
Description:
Creates a nicely formatted Surefire Test Report in html format.
Attributes:
- Requires a Maven 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. |
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 | - | 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. |
skipSurefireReport | boolean | 2.11 | If set to true the surefire report generation will be skipped. Default value is: false. |
xrefLocation | File | - | Location of the Xrefs to link. Default value is: ${project.reporting.outputDirectory}/xref-test. |
Parameter Details
Whether to build an aggregated report at the root, or build
individual reports.
- Type: boolean
- Required: No
- Expression: ${aggregate}
- Default: false
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
Whether to link the XRef if found.
- Type: boolean
- Required: No
- Expression: ${linkXRef}
- Default: true
Location where generated html will be created.
- Type: java.io.File
- Required: No
- Expression: ${project.reporting.outputDirectory}
The filename to use for the report.
- Type: java.lang.String
- Required: Yes
- Expression: ${outputName}
- Default: surefire-report
Maven Project
- Type: org.apache.maven.project.MavenProject
- Required: Yes
- Expression: ${project}
Directories containing the XML Report files that will be parsed and
rendered to HTML format.
- Type: java.io.File[]
- Required: No
(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
If set to false, only failures are shown.
- Type: boolean
- Required: Yes
- Expression: ${showSuccess}
- Default: true
If set to true the surefire report generation will be skipped.
- Type: boolean
- Since: 2.11
- Required: No
- Expression: ${skipSurefireReport}
- Default: false
Location of the Xrefs to link.
- Type: java.io.File
- Required: No
- Default: ${project.reporting.outputDirectory}/xref-test