Class FailsafeReportMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.surefire.report.AbstractSurefireReportMojo
org.apache.maven.plugins.surefire.report.FailsafeReportMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,org.apache.maven.reporting.MavenMultiPageReport
,org.apache.maven.reporting.MavenReport
@Mojo(name="failsafe-report-only")
public class FailsafeReportMojo
extends AbstractSurefireReportMojo
Creates a nicely formatted Failsafe Test Report in html format.
This goal does not run the tests, it only builds the reports.
See
https://issues.apache.org/jira/browse/SUREFIRE-257
- Since:
- 2.10
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
If set to true the failsafe report will be generated even when there are no failsafe result files.private String
The filename to use for the report.private boolean
If set to true the failsafe report generation will be skipped.Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
localRepository, outputDirectory, project, remoteRepositories, siteRenderer, siteTool
Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
protected File
getSurefireReportsDirectory
(org.apache.maven.project.MavenProject subProject) Gets the default surefire reports directory for the specified project.protected boolean
Whether the report should be generated when there are no test results.protected boolean
Whether the report should be generated or not.Methods inherited from class org.apache.maven.plugins.surefire.report.AbstractSurefireReportMojo
canGenerateReport, executeReport, getConsoleLogger, getDescription, getI18N, getI18nString, getName, getProject
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
outputName
@Parameter(defaultValue="failsafe-report", property="outputName", required=true) private String outputNameThe filename to use for the report. -
alwaysGenerateFailsafeReport
@Parameter(defaultValue="false", property="alwaysGenerateFailsafeReport") private boolean alwaysGenerateFailsafeReportIf set to true the failsafe report will be generated even when there are no failsafe result files. Defaults tofalse
to preserve legacy behaviour pre 2.10.- Since:
- 2.11
-
skipFailsafeReport
@Parameter(defaultValue="false", property="skipFailsafeReport") private boolean skipFailsafeReportIf set to true the failsafe report generation will be skipped.- Since:
- 2.11
-
-
Constructor Details
-
FailsafeReportMojo
public FailsafeReportMojo()
-
-
Method Details
-
getSurefireReportsDirectory
Description copied from class:AbstractSurefireReportMojo
Gets the default surefire reports directory for the specified project.- Specified by:
getSurefireReportsDirectory
in classAbstractSurefireReportMojo
- Parameters:
subProject
- the project to query.- Returns:
- the default surefire reports directory for the specified project.
-
getOutputName
Description copied from class:AbstractSurefireReportMojo
- Specified by:
getOutputName
in interfaceorg.apache.maven.reporting.MavenReport
- Specified by:
getOutputName
in classAbstractSurefireReportMojo
-
isSkipped
protected boolean isSkipped()Description copied from class:AbstractSurefireReportMojo
Whether the report should be generated or not.- Overrides:
isSkipped
in classAbstractSurefireReportMojo
- Returns:
true
if and only if the report should be generated.
-
isGeneratedWhenNoResults
protected boolean isGeneratedWhenNoResults()Description copied from class:AbstractSurefireReportMojo
Whether the report should be generated when there are no test results.- Overrides:
isGeneratedWhenNoResults
in classAbstractSurefireReportMojo
- Returns:
true
if and only if the report should be generated when there are no result files at all.
-
getI18Nsection
- Specified by:
getI18Nsection
in classAbstractSurefireReportMojo
- Returns:
- The according string for the section.
-