Class SurefireReport
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.reporting.AbstractMavenReport
-
- org.apache.maven.plugins.surefire.report.AbstractSurefireReport
-
- org.apache.maven.plugins.surefire.report.SurefireReport
-
- 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:
SurefireOnlyReport
@Mojo(name="report") @Execute(lifecycle="surefire", phase=TEST) public class SurefireReport extends AbstractSurefireReport
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
outputName
The filename to use for the report.private boolean
skipSurefireReport
If set to true, the surefire report generation will be skipped.-
Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool
-
-
Constructor Summary
Constructors Constructor Description SurefireReport(org.codehaus.plexus.i18n.I18N i18n)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getI18Nsection()
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.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.-
Methods inherited from class org.apache.maven.plugins.surefire.report.AbstractSurefireReport
canGenerateReport, executeReport, getConsoleLogger, getDescription, getI18N, getI18nString, getName, getProject, getReactorProjects
-
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectory
-
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
-
-
-
Field Detail
-
outputName
@Parameter(defaultValue="surefire", 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
-
-
Method Detail
-
getSurefireReportsDirectory
protected java.io.File getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject)
Description copied from class:AbstractSurefireReport
Gets the default surefire reports directory for the specified project.- Specified by:
getSurefireReportsDirectory
in classAbstractSurefireReport
- 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:AbstractSurefireReport
- Specified by:
getOutputName
in interfaceorg.apache.maven.reporting.MavenReport
- Specified by:
getOutputName
in classAbstractSurefireReport
-
isSkipped
protected boolean isSkipped()
Description copied from class:AbstractSurefireReport
Whether the report should be generated or not.- Overrides:
isSkipped
in classAbstractSurefireReport
- Returns:
true
if and only if the report should be generated.
-
isGeneratedWhenNoResults
protected boolean isGeneratedWhenNoResults()
Description copied from class:AbstractSurefireReport
Whether the report should be generated when there are no test results.- Overrides:
isGeneratedWhenNoResults
in classAbstractSurefireReport
- Returns:
true
if and only if the report should be generated when there are no result files at all.
-
getI18Nsection
protected java.lang.String getI18Nsection()
- Specified by:
getI18Nsection
in classAbstractSurefireReport
- Returns:
- the according string for the section
-
-