org.apache.maven.plugins.surefire.report

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 and 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

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
SurefireReportMojo()

Method Summary

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

canGenerateReport, executeReport, 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="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 to true 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

Constructor Detail

SurefireReportMojo

public SurefireReportMojo()

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

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.