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

Class AbstractSurefireReportMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.surefire.report.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.

  • Field Details

    • showSuccess

      @Parameter(defaultValue="true", required=true, property="showSuccess") private boolean showSuccess
      If set to false, only failures are shown.

    • reportsDirectories

      @Parameter private File[] reportsDirectories
      Directories containing the XML Report files that will be parsed and rendered to HTML format.

    • reportsDirectory

      @Deprecated @Parameter private File reportsDirectory
      Deprecated.
      (Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.

    • reactorProjects

      @Parameter(defaultValue="${reactorProjects}", readonly=true) private List<org.apache.maven.project.MavenProject> reactorProjects
      The projects in the reactor for aggregation report.

    • xrefLocation

      @Parameter(defaultValue="${project.reporting.outputDirectory}/xref-test") private File xrefLocation
      Location of the Xrefs to link.

    • linkXRef

      @Parameter(defaultValue="true", property="linkXRef") private boolean linkXRef
      Whether to link the XRef if found.

    • aggregate

      @Parameter(defaultValue="false", property="aggregate") private boolean aggregate
      Whether to build an aggregated report at the root, or build individual reports.

    • resolvedReportsDirectories

      private List<File> resolvedReportsDirectories

  • Constructor Details

    • AbstractSurefireReportMojo

      public AbstractSurefireReportMojo()

  • 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

    • 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

    • hasReportDirectories

      private boolean hasReportDirectories()

    • getReportsDirectories

      private List<File> 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

      private List<org.apache.maven.project.MavenProject> getProjectsWithoutRoot()

    • determineXrefLocation

      private String determineXrefLocation()

    • getName

      public String getName(Locale locale)

    • getDescription

      public String getDescription(Locale locale)

    • getOutputName

      public abstract String getOutputName()

    • getBundle

      protected abstract LocalizedProperties getBundle(Locale locale, ClassLoader resourceBundleClassLoader)

    • getConsoleLogger

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

    • getBundle

      final LocalizedProperties getBundle(Locale locale)