Class 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.
    Author:
    Stephen Connolly
    • Constructor Detail

      • AbstractSurefireReportMojo

        public AbstractSurefireReportMojo()
    • Method Detail

      • 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

        public abstract void setTitle​(String title)
      • getTitle

        public abstract String getTitle()
      • setDescription

        public abstract void setDescription​(String description)
      • getDescription

        public abstract String getDescription()
      • executeReport

        public void executeReport​(Locale locale)
                           throws org.apache.maven.reporting.MavenReportException
        Specified by:
        executeReport in class org.apache.maven.reporting.AbstractMavenReport
        Throws:
        org.apache.maven.reporting.MavenReportException
      • canGenerateReport

        public boolean canGenerateReport()
        Specified by:
        canGenerateReport in interface org.apache.maven.reporting.MavenReport
        Overrides:
        canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
      • 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.
      • getDescription

        public String getDescription​(Locale locale)
      • getOutputName

        public abstract String getOutputName()
      • getConsoleLogger

        protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger getConsoleLogger()