View Javadoc
1   package org.apache.maven.plugin.failsafe;
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.BufferedInputStream;
23  import java.io.File;
24  import java.io.FileInputStream;
25  import java.io.IOException;
26  import java.io.InputStreamReader;
27  import java.io.Reader;
28  import org.apache.maven.plugin.AbstractMojo;
29  import org.apache.maven.plugin.MojoExecutionException;
30  import org.apache.maven.plugin.MojoFailureException;
31  import org.apache.maven.plugin.surefire.SurefireHelper;
32  import org.apache.maven.plugin.surefire.SurefireReportParameters;
33  import org.apache.maven.plugins.annotations.LifecyclePhase;
34  import org.apache.maven.plugins.annotations.Mojo;
35  import org.apache.maven.plugins.annotations.Parameter;
36  import org.apache.maven.shared.utils.ReaderFactory;
37  import org.apache.maven.shared.utils.StringUtils;
38  import org.apache.maven.shared.utils.io.IOUtil;
39  import org.apache.maven.surefire.suite.RunResult;
40  
41  /**
42   * Verify integration tests ran using Surefire.
43   *
44   * @author Stephen Connolly
45   * @author Jason van Zyl
46   */
47  @Mojo( name = "verify", defaultPhase = LifecyclePhase.VERIFY, requiresProject = true, threadSafe = true )
48  public class VerifyMojo
49      extends AbstractMojo
50      implements SurefireReportParameters
51  {
52  
53      /**
54       * Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite
55       * convenient on occasion.
56       *
57       * @since 2.4
58       */
59      @Parameter( property = "skipTests" )
60      private boolean skipTests;
61  
62      /**
63       * Set this to 'true' to skip running integration tests, but still compile them. Its use is NOT RECOMMENDED, but
64       * quite convenient on occasion.
65       *
66       * @since 2.4.3-alpha-2
67       */
68      @Parameter( property = "skipITs" )
69      private boolean skipITs;
70  
71      /**
72       * This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec.
73       *
74       * @since 2.3
75       * @deprecated Use -DskipTests instead.
76       */
77      @Parameter( property = "maven.test.skip.exec" )
78      private boolean skipExec;
79  
80      /**
81       * Set this to 'true' to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you
82       * enable it using the "maven.test.skip" property, because maven.test.skip disables both running the
83       * tests and compiling the tests.  Consider using the skipTests parameter instead.
84       */
85      @Parameter( property = "maven.test.skip", defaultValue = "false" )
86      private boolean skip;
87  
88      /**
89       * Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on
90       * occasion.
91       */
92      @Parameter( property = "maven.test.failure.ignore", defaultValue = "false" )
93      private boolean testFailureIgnore;
94  
95      /**
96       * The base directory of the project being tested. This can be obtained in your unit test by
97       * System.getProperty("basedir").
98       */
99      @Parameter( defaultValue = "${basedir}" )
100     private File basedir;
101 
102     /**
103      * The directory containing generated test classes of the project being tested.
104      * This will be included at the beginning the test classpath.
105      */
106     @Parameter( defaultValue = "${project.build.testOutputDirectory}" )
107     private File testClassesDirectory;
108 
109     /**
110      * Base directory where all reports are written to.
111      */
112     @Parameter( defaultValue = "${project.build.directory}/failsafe-reports" )
113     private File reportsDirectory;
114 
115     /**
116      * The summary file to read integration test results from.
117      *
118      * @noinspection UnusedDeclaration
119      */
120     @Parameter( defaultValue = "${project.build.directory}/failsafe-reports/failsafe-summary.xml", required = true )
121     private File summaryFile;
122 
123     /**
124      * Additional summary files to read integration test results from.
125      *
126      * @noinspection UnusedDeclaration, MismatchedReadAndWriteOfArray
127      * @since 2.6
128      */
129     @Parameter
130     private File[] summaryFiles;
131 
132     /**
133      * Set this to "true" to cause a failure if there are no tests to run.
134      *
135      * @since 2.4
136      */
137     @Parameter( property = "failIfNoTests" )
138     private Boolean failIfNoTests;
139 
140     /**
141      * The character encoding scheme to be applied.
142      *
143      * @noinspection UnusedDeclaration
144      */
145     @Parameter( property = "encoding", defaultValue = "${project.reporting.outputEncoding}" )
146     private String encoding;
147 
148 
149     public void execute()
150         throws MojoExecutionException, MojoFailureException
151     {
152         if ( verifyParameters() )
153         {
154             getLog().info(
155                 StringUtils.capitalizeFirstLetter( getPluginName() ) + " report directory: " + getReportsDirectory() );
156 
157             RunResult summary;
158             try
159             {
160                 String encoding;
161                 if ( StringUtils.isEmpty( this.encoding ) )
162                 {
163                     getLog().warn(
164                         "File encoding has not been set, using platform encoding " + ReaderFactory.FILE_ENCODING
165                             + ", i.e. build is platform dependent!" );
166                     encoding = ReaderFactory.FILE_ENCODING;
167                 }
168                 else
169                 {
170                     encoding = this.encoding;
171                 }
172 
173                 if ( !summaryFile.isFile() && summaryFiles != null )
174                 {
175                     summary = RunResult.noTestsRun();
176                 }
177                 else
178                 {
179                     summary = readSummary( encoding, summaryFile );
180                 }
181                 if ( summaryFiles != null )
182                 {
183                     for ( File file : summaryFiles )
184                     {
185                         summary = summary.aggregate( readSummary( encoding, file ) );
186                     }
187                 }
188             }
189             catch ( IOException e )
190             {
191                 throw new MojoExecutionException( e.getMessage(), e );
192             }
193 
194             SurefireHelper.reportExecution( this, summary, getLog() );
195         }
196     }
197 
198     private RunResult readSummary( String encoding, File summaryFile )
199         throws IOException
200     {
201         FileInputStream fileInputStream = null;
202         BufferedInputStream bufferedInputStream = null;
203         Reader reader = null;
204         try
205         {
206             fileInputStream = new FileInputStream( summaryFile );
207             bufferedInputStream = new BufferedInputStream( fileInputStream );
208             reader = new InputStreamReader( bufferedInputStream, encoding );
209             return RunResult.fromInputStream( bufferedInputStream, encoding );
210         }
211         finally
212         {
213             IOUtil.close( reader );
214             IOUtil.close( bufferedInputStream );
215             IOUtil.close( fileInputStream );
216         }
217     }
218 
219     protected boolean verifyParameters()
220         throws MojoFailureException
221     {
222         if ( isSkip() || isSkipTests() || isSkipITs() || isSkipExec() )
223         {
224             getLog().info( "Tests are skipped." );
225             return false;
226         }
227 
228         if ( !getTestClassesDirectory().exists() )
229         {
230             if ( getFailIfNoTests() != null && getFailIfNoTests() )
231             {
232                 throw new MojoFailureException( "No tests to run!" );
233             }
234             getLog().info( "No tests to run." );
235             return false;
236         }
237 
238         return true;
239     }
240 
241     protected String getPluginName()
242     {
243         return "failsafe";
244     }
245 
246     protected String[] getDefaultIncludes()
247     {
248         return null;
249     }
250 
251     public boolean isSkipTests()
252     {
253         return skipTests;
254     }
255 
256     public void setSkipTests( boolean skipTests )
257     {
258         this.skipTests = skipTests;
259     }
260 
261     public boolean isSkipITs()
262     {
263         return skipITs;
264     }
265 
266     public void setSkipITs( boolean skipITs )
267     {
268         this.skipITs = skipITs;
269     }
270 
271     @Deprecated
272     public boolean isSkipExec()
273     {
274         return skipExec;
275     }
276 
277     @Deprecated
278     public void setSkipExec( boolean skipExec )
279     {
280         this.skipExec = skipExec;
281     }
282 
283     public boolean isSkip()
284     {
285         return skip;
286     }
287 
288     public void setSkip( boolean skip )
289     {
290         this.skip = skip;
291     }
292 
293     public boolean isTestFailureIgnore()
294     {
295         return testFailureIgnore;
296     }
297 
298     public void setTestFailureIgnore( boolean testFailureIgnore )
299     {
300         this.testFailureIgnore = testFailureIgnore;
301     }
302 
303     public File getBasedir()
304     {
305         return basedir;
306     }
307 
308     public void setBasedir( File basedir )
309     {
310         this.basedir = basedir;
311     }
312 
313     public File getTestClassesDirectory()
314     {
315         return testClassesDirectory;
316     }
317 
318     public void setTestClassesDirectory( File testClassesDirectory )
319     {
320         this.testClassesDirectory = testClassesDirectory;
321     }
322 
323     public File getReportsDirectory()
324     {
325         return reportsDirectory;
326     }
327 
328     public void setReportsDirectory( File reportsDirectory )
329     {
330         this.reportsDirectory = reportsDirectory;
331     }
332 
333     public Boolean getFailIfNoTests()
334     {
335         return failIfNoTests;
336     }
337 
338     public void setFailIfNoTests( Boolean failIfNoTests )
339     {
340         this.failIfNoTests = failIfNoTests;
341     }
342 
343 }