Class AbstractSurefireReportMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.surefire.report.AbstractSurefireReportMojo
- 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:
FailsafeReportMojo
,SurefireReportMojo
public abstract class AbstractSurefireReportMojo
extends org.apache.maven.reporting.AbstractMavenReport
Abstract base class for reporting test results using Surefire.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Whether to build an aggregated report at the root, or build individual reports.private boolean
Whether to link the XRef if found.private List<org.apache.maven.project.MavenProject>
The projects in the reactor for aggregation report.private File[]
Directories containing the XML Report files that will be parsed and rendered to HTML format.private File
Deprecated.private boolean
If set to false, only failures are shown.private File
Location of the Xrefs to link.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 TypeMethodDescriptionboolean
private String
void
executeReport
(Locale locale) (package private) final LocalizedProperties
protected abstract LocalizedProperties
getBundle
(Locale locale, ClassLoader resourceBundleClassLoader) protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger
abstract String
getDescription
(Locale locale) abstract String
private List<org.apache.maven.project.MavenProject>
protected abstract File
getSurefireReportsDirectory
(org.apache.maven.project.MavenProject subProject) Gets the default surefire reports directory for the specified project.abstract String
getTitle()
private boolean
protected boolean
Whether the report should be generated when there are no test results.protected boolean
Whether the report should be generated or not.abstract void
setDescription
(String description) abstract void
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
-
showSuccess
@Parameter(defaultValue="true", required=true, property="showSuccess") private boolean showSuccessIf set to false, only failures are shown. -
reportsDirectories
Directories containing the XML Report files that will be parsed and rendered to HTML format. -
reportsDirectory
Deprecated.(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format. -
reactorProjects
@Parameter(defaultValue="${reactorProjects}", readonly=true) private List<org.apache.maven.project.MavenProject> reactorProjectsThe projects in the reactor for aggregation report. -
xrefLocation
Location of the Xrefs to link. -
linkXRef
@Parameter(defaultValue="true", property="linkXRef") private boolean linkXRefWhether to link the XRef if found. -
aggregate
@Parameter(defaultValue="false", property="aggregate") private boolean aggregateWhether to build an aggregated report at the root, or build individual reports. -
resolvedReportsDirectories
-
-
Constructor Details
-
AbstractSurefireReportMojo
public AbstractSurefireReportMojo()
-
-
Method Details
-
isSkipped
protected boolean isSkipped()Whether the report should be generated or not.- Returns:
true
if and only if the report should be generated.- Since:
- 2.11
-
isGeneratedWhenNoResults
protected boolean isGeneratedWhenNoResults()Whether the report should be generated when there are no test results.- Returns:
true
if and only if the report should be generated when there are no result files at all.- Since:
- 2.11
-
setTitle
-
getTitle
-
setDescription
-
getDescription
-
executeReport
- Specified by:
executeReport
in classorg.apache.maven.reporting.AbstractMavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- Overrides:
canGenerateReport
in classorg.apache.maven.reporting.AbstractMavenReport
-
hasReportDirectories
private boolean hasReportDirectories() -
getReportsDirectories
-
getSurefireReportsDirectory
protected abstract File getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject) Gets the default surefire reports directory for the specified project.- Parameters:
subProject
- the project to query.- Returns:
- the default surefire reports directory for the specified project.
-
getProjectsWithoutRoot
-
determineXrefLocation
-
getName
-
getDescription
-
getOutputName
-
getBundle
protected abstract LocalizedProperties getBundle(Locale locale, ClassLoader resourceBundleClassLoader) -
getConsoleLogger
protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger getConsoleLogger() -
getBundle
-