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
Fields Modifier and Type Field Description private boolean
alwaysGenerateSurefireReport
If set to true the surefire report will be generated even when there are no surefire result files.private java.lang.String
description
A custom description for the project reports page.private java.lang.String
outputName
The filename to use for the report.private boolean
skipSurefireReport
If set to true the surefire report generation will be skipped.private java.lang.String
title
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
-
-
Constructor Summary
Constructors Constructor Description SurefireReportMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected LocalizedProperties
getBundle(java.util.Locale locale, java.lang.ClassLoader resourceBundleClassLoader)
java.lang.String
getDescription()
java.lang.String
getOutputName()
protected java.io.File
getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject)
Gets the default surefire reports directory for the specified project.java.lang.String
getTitle()
protected boolean
isGeneratedWhenNoResults()
Whether the report should be generated when there are no test results.protected boolean
isSkipped()
Whether the report should be generated or not.void
setDescription(java.lang.String description)
void
setTitle(java.lang.String title)
-
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
-
-
-
-
Field Detail
-
outputName
@Parameter(defaultValue="surefire-report", property="outputName", required=true) private java.lang.String outputName
The filename to use for the report.
-
alwaysGenerateSurefireReport
@Parameter(defaultValue="true", property="alwaysGenerateSurefireReport") private boolean alwaysGenerateSurefireReport
If 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 skipSurefireReport
If set to true the surefire report generation will be skipped.- Since:
- 2.11
-
title
@Parameter(defaultValue="", property="surefire.report.title") private java.lang.String title
A custom title of the report for the menu and the project reports page.- Since:
- 2.21.0
-
description
@Parameter(defaultValue="", property="surefire.report.description") private java.lang.String description
A custom description for the project reports page.- Since:
- 2.21.0
-
-
Method Detail
-
getSurefireReportsDirectory
protected java.io.File getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject)
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
public java.lang.String getOutputName()
Description copied from class:AbstractSurefireReportMojo
- Specified by:
getOutputName
in interfaceorg.apache.maven.reporting.MavenReport
- Specified by:
getOutputName
in classAbstractSurefireReportMojo
-
getBundle
protected LocalizedProperties getBundle(java.util.Locale locale, java.lang.ClassLoader resourceBundleClassLoader)
- 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
public void setTitle(java.lang.String title)
- Specified by:
setTitle
in classAbstractSurefireReportMojo
-
getTitle
public java.lang.String getTitle()
- Specified by:
getTitle
in classAbstractSurefireReportMojo
-
setDescription
public void setDescription(java.lang.String description)
- Specified by:
setDescription
in classAbstractSurefireReportMojo
-
getDescription
public java.lang.String getDescription()
- Specified by:
getDescription
in classAbstractSurefireReportMojo
-
-