Class 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 java.lang.String description
      A custom description for the project reports page.
      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.
      private java.lang.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

        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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected LocalizedProperties getBundle​(java.util.Locale locale, java.lang.ClassLoader resourceBundleClassLoader)  
      java.lang.String getDescription()  
      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.
      java.lang.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​(java.lang.String description)  
      void setTitle​(java.lang.String title)  
      • 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
      • title

        @Parameter(defaultValue="",
                   property="surefire.report.title")
        private java.lang.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 java.lang.String description
        A custom description for the project reports page.
        Since:
        2.21.0
    • Constructor Detail

      • SurefireReportMojo

        public SurefireReportMojo()