Package 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
    Description
    private boolean
    alwaysGenerateSurefireReport
    If set to true the surefire report will be generated even when there are no surefire result files.
    private String
    description
    A custom description for the project reports page.
    private String
    outputName
    The filename to use for the report.
    private boolean
    skipSurefireReport
    If set to true the surefire report generation will be skipped.
    private 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

    localRepository, outputDirectory, project, remoteRepositories, 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
    SurefireReportMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected LocalizedProperties
    getBundle(Locale locale, ClassLoader resourceBundleClassLoader)
     
    String
    getDescription()
     
    String
    getOutputName()
    protected File
    getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject)
    Gets the default surefire reports directory for the specified project.
    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(String description)
     
    void
    setTitle(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 Details

    • outputName

      @Parameter(defaultValue="surefire-report", property="outputName", required=true) private 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

    • title

      @Parameter(defaultValue="", property="surefire.report.title") private String title
      A custom title of the report for the menu and the project reports page.
      Since:
      2.21.0

    • description

      @Parameter(defaultValue="", property="surefire.report.description") private String description
      A custom description for the project reports page.
      Since:
      2.21.0

  • Constructor Details

    • SurefireReportMojo

      public SurefireReportMojo()

  • Method Details