Package org.apache.maven.plugins.surefire.report

Class FailsafeOnlyReport

  • 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 FailsafeOnlyReport
extends AbstractSurefireReport
    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 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 outputName
      The filename to use for the report.
      private boolean skipFailsafeReport
      If set to true the failsafe 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

      • 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 Description
      FailsafeOnlyReport​(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.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 Detail

      • outputName

        @Parameter(defaultValue="failsafe",
           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

    • Constructor Detail

      • FailsafeOnlyReport

        @Inject
public FailsafeOnlyReport​(org.codehaus.plexus.i18n.I18N i18n)

    • 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 class AbstractSurefireReport
        Parameters:
        subProject - the project to query.
        Returns:
        the default surefire reports directory for the specified project.

      • isGeneratedWhenNoResults

        protected boolean isGeneratedWhenNoResults()
        Description copied from class: AbstractSurefireReport
        Whether the report should be generated when there are no test results.
        Overrides:
        isGeneratedWhenNoResults in class AbstractSurefireReport
        Returns:
        true if and only if the report should be generated when there are no result files at all.