View Javadoc
1   package org.apache.maven.plugins.surefire.report;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.File;
23  import java.util.Locale;
24  import java.util.ResourceBundle;
25  import org.apache.maven.plugins.annotations.Mojo;
26  import org.apache.maven.plugins.annotations.Parameter;
27  import org.apache.maven.project.MavenProject;
28  
29  
30  /**
31   * Creates a nicely formatted Failsafe Test Report in html format.
32   * This goal does not run the tests, it only builds the reports.
33   * See <a href="http://jira.codehaus.org/browse/SUREFIRE-257">http://jira.codehaus.org/browse/SUREFIRE-257</a>
34   *
35   * @author Stephen Connolly
36   * @since 2.10
37   */
38  @Mojo( name = "failsafe-report-only" )
39  public class FailsafeReportMojo
40      extends AbstractSurefireReportMojo
41  {
42  
43      /**
44       * The filename to use for the report.
45       *
46       * @noinspection UnusedDeclaration
47       */
48      @Parameter( defaultValue = "failsafe-report", property = "outputName", required = true )
49      private String outputName;
50  
51      /**
52       * If set to true the failsafe report will be generated even when there are no failsafe result files.
53       * Defaults to <code>false</code> to preserve legacy behaviour pre 2.10
54       *
55       * @noinspection UnusedDeclaration
56       * @since 2.11
57       */
58      @Parameter( defaultValue = "false", property = "alwaysGenerateFailsafeReport" )
59      private boolean alwaysGenerateFailsafeReport;
60  
61      /**
62       * If set to true the failsafe report generation will be skipped.
63       *
64       * @noinspection UnusedDeclaration
65       * @since 2.11
66       */
67      @Parameter( defaultValue = "false", property = "skipFailsafeReport" )
68      private boolean skipFailsafeReport;
69  
70      protected File getSurefireReportsDirectory( MavenProject subProject )
71      {
72          String buildDir = subProject.getBuild().getDirectory();
73          return new File( buildDir + "/failsafe-reports" );
74      }
75  
76      public String getOutputName()
77      {
78          return outputName;
79      }
80  
81      protected boolean isSkipped()
82      {
83          return skipFailsafeReport;
84      }
85  
86      protected boolean isGeneratedWhenNoResults()
87      {
88          return alwaysGenerateFailsafeReport;
89      }
90  
91      /**
92       * {@inheritDoc}
93       */
94      public String getName( Locale locale )
95      {
96          return getBundle( locale ).getString( "report.failsafe.name" );
97      }
98  
99      /**
100      * {@inheritDoc}
101      */
102     public String getDescription( Locale locale )
103     {
104         return getBundle( locale ).getString( "report.failsafe.description" );
105     }
106 
107 
108     /*
109     * This is currently a copy of the getBundle() method of the AbstractSurefireReportMojo class,
110     * cause the failsafe report only different in two names for the bundles.
111     */
112     private ResourceBundle getBundle( Locale locale )
113     {
114         return ResourceBundle.getBundle( "surefire-report", locale, this.getClass().getClassLoader() );
115     }
116 }