org.apache.maven.plugins.surefire.report

Class FailsafeReportMojo

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.FailsafeReportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="failsafe-report-only")
public class FailsafeReportMojo
extends AbstractSurefireReportMojo

Creates a nicely formatted Failsafe Test Report in html format. This goal does not run the tests, it only builds the reports. See https://issues.apache.org/jira/browse/SUREFIRE-257

Since:

2.10

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	alwaysGenerateFailsafeReport If set to true the failsafe report will be generated even when there are no failsafe 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	skipFailsafeReport If set to true the failsafe 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

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

Constructor and Description
FailsafeReportMojo()

Method Summary

Modifier and Type	Method and 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

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

Field Detail

outputName

@Parameter(defaultValue="failsafe-report",
           property="outputName",
           required=true)
private java.lang.String outputName

The filename to use for the report.

alwaysGenerateFailsafeReport

@Parameter(defaultValue="false",
           property="alwaysGenerateFailsafeReport")
private boolean alwaysGenerateFailsafeReport

If set to true the failsafe report will be generated even when there are no failsafe result files. Defaults to false to preserve legacy behaviour pre 2.10.

Since:

2.11

skipFailsafeReport

@Parameter(defaultValue="false",
           property="skipFailsafeReport")
private boolean skipFailsafeReport

If set to true the failsafe report generation will be skipped.

Since:

2.11

title

@Parameter(defaultValue="",
           property="failsafe.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="failsafe.report.description")
private java.lang.String description

A custom description for the project reports page.

Since:

2.21.0

Constructor Detail

FailsafeReportMojo

public FailsafeReportMojo()

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 class AbstractSurefireReportMojo

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 interface org.apache.maven.reporting.MavenReport

Specified by:

getOutputName in class AbstractSurefireReportMojo

getBundle

protected LocalizedProperties getBundle(java.util.Locale locale,
                                        java.lang.ClassLoader resourceBundleClassLoader)

Specified by:

getBundle in class AbstractSurefireReportMojo

isSkipped

protected boolean isSkipped()

Description copied from class: AbstractSurefireReportMojo

Whether the report should be generated or not.

Overrides:

isSkipped in class AbstractSurefireReportMojo

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 class AbstractSurefireReportMojo

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 class AbstractSurefireReportMojo

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in class AbstractSurefireReportMojo

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in class AbstractSurefireReportMojo

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class AbstractSurefireReportMojo