Class SurefireReportMojo
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.SurefireReportMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,org.apache.maven.reporting.MavenMultiPageReport
,org.apache.maven.reporting.MavenReport
- Direct Known Subclasses:
SurefireReportOnlyMojo
@Mojo(name="report",
inheritByDefault=false)
@Execute(lifecycle="surefire",
phase=TEST)
public class SurefireReportMojo
extends AbstractSurefireReportMojo
Creates a nicely formatted Surefire Test Report in html format.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
If set to true the surefire report will be generated even when there are no surefire result files.private String
A custom description for the project reports page.private String
The filename to use for the report.private boolean
If set to true the surefire report generation will be skipped.private String
A custom title of the report for the menu and the project reports page.Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
outputDirectory, project, siteRenderer
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 LocalizedProperties
getBundle
(Locale locale, ClassLoader resourceBundleClassLoader) protected File
getSurefireReportsDirectory
(org.apache.maven.project.MavenProject subProject) Gets the default surefire reports directory for the specified project.getTitle()
protected boolean
Whether the report should be generated when there are no test results.protected boolean
Whether the report should be generated or not.void
setDescription
(String description) void
Methods inherited from class org.apache.maven.plugins.surefire.report.AbstractSurefireReportMojo
canGenerateReport, executeReport, getBundle, getConsoleLogger, getDescription, getName
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
outputName
@Parameter(defaultValue="surefire-report", property="outputName", required=true) private String outputNameThe filename to use for the report. -
alwaysGenerateSurefireReport
@Parameter(defaultValue="true", property="alwaysGenerateSurefireReport") private boolean alwaysGenerateSurefireReportIf set to true the surefire report will be generated even when there are no surefire result files. Defaults totrue
to preserve legacy behaviour pre 2.10.- Since:
- 2.11
-
skipSurefireReport
@Parameter(defaultValue="false", property="skipSurefireReport") private boolean skipSurefireReportIf set to true the surefire report generation will be skipped.- Since:
- 2.11
-
title
A custom title of the report for the menu and the project reports page.- Since:
- 2.21.0
-
description
A custom description for the project reports page.- Since:
- 2.21.0
-
-
Constructor Details
-
SurefireReportMojo
public SurefireReportMojo()
-
-
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
-
getBundle
- Specified by:
getBundle
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.
-
setTitle
- Specified by:
setTitle
in classAbstractSurefireReportMojo
-
getTitle
- Specified by:
getTitle
in classAbstractSurefireReportMojo
-
setDescription
- Specified by:
setDescription
in classAbstractSurefireReportMojo
-
getDescription
- Specified by:
getDescription
in classAbstractSurefireReportMojo
-