Class AbstractSurefireReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.surefire.report.AbstractSurefireReport
- 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:
FailsafeOnlyReport
,SurefireReport
public abstract class AbstractSurefireReport
extends org.apache.maven.reporting.AbstractMavenReport
Abstract base class for reporting test results using Surefire.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Whether to build an aggregated report at the root, or build individual reports.private String
Path for a custom bundle instead of using the default one.private org.codehaus.plexus.i18n.I18N
Internationalization componentprivate boolean
Link the violation line numbers to the (Test) Source XRef.private File[]
Directories containing the XML Report files that will be parsed and rendered to HTML format.private File
Deprecated.private org.apache.maven.settings.Settings
The current user system settings for use in Maven.private boolean
If set to false, only failures are shown.private File
Location where Test Source XRef is generated for this project.Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, 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
ConstructorsModifierConstructorDescriptionprotected
AbstractSurefireReport
(org.codehaus.plexus.i18n.I18N i18n) -
Method Summary
Modifier and TypeMethodDescriptionboolean
void
executeReport
(Locale locale) protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger
getDescription
(Locale locale) protected org.codehaus.plexus.i18n.I18N
protected abstract String
protected String
getI18nString
(Locale locale, String key) abstract String
protected org.apache.maven.project.MavenProject
private List
<org.apache.maven.project.MavenProject> protected 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.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.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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.maven.reporting.MavenReport
getOutputPath
-
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. -
linkXRef
@Parameter(property="linkXRef", defaultValue="true") private boolean linkXRefLink the violation line numbers to the (Test) Source XRef. Links will be created automatically if the JXR plugin is being used. -
xrefTestLocation
Location where Test Source XRef is generated for this project.
Default:AbstractMavenReport.getReportOutputDirectory()
+/xref-test
-
aggregate
@Parameter(defaultValue="false", property="aggregate") private boolean aggregateWhether to build an aggregated report at the root, or build individual reports. -
settings
@Parameter(defaultValue="${settings}", readonly=true, required=true) private org.apache.maven.settings.Settings settingsThe current user system settings for use in Maven. -
customBundle
@Parameter(defaultValue="${basedir}/src/site/custom/surefire-report.properties") private String customBundlePath for a custom bundle instead of using the default one.
Using this field, you could change the texts in the generated reports.- Since:
- 3.1.0
-
resolvedReportsDirectories
-
i18n
private org.codehaus.plexus.i18n.I18N i18nInternationalization component
-
-
Constructor Details
-
AbstractSurefireReport
protected AbstractSurefireReport(org.codehaus.plexus.i18n.I18N i18n)
-
-
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
-
executeReport
- Specified by:
executeReport
in classorg.apache.maven.reporting.AbstractMavenReport
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- Overrides:
canGenerateReport
in classorg.apache.maven.reporting.AbstractMavenReport
-
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
-
getI18nString
- Parameters:
locale
- the localekey
- the key to search fo- Returns:
- the text appropriate for the locale.
-
getI18N
- Parameters:
locale
- the locale- Returns:
- I18N for the locale
-
getI18Nsection
- Returns:
- the according string for the section
-
getName
-
getDescription
-
getOutputName
-
getConsoleLogger
protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger getConsoleLogger() -
getProject
protected org.apache.maven.project.MavenProject getProject()- Overrides:
getProject
in classorg.apache.maven.reporting.AbstractMavenReport
-
getReactorProjects
-