View Javadoc
1   /*
2    * Copyright (C) 2011 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.codehaus.gmavenplus.mojo;
18  
19  import org.apache.maven.artifact.DependencyResolutionRequiredException;
20  import org.apache.maven.plugin.MojoExecutionException;
21  import org.apache.maven.plugins.annotations.LifecyclePhase;
22  import org.apache.maven.plugins.annotations.Mojo;
23  import org.apache.maven.plugins.annotations.Parameter;
24  import org.apache.maven.plugins.annotations.ResolutionScope;
25  import org.apache.maven.shared.model.fileset.FileSet;
26  
27  import java.io.File;
28  import java.lang.reflect.InvocationTargetException;
29  import java.net.MalformedURLException;
30  
31  
32  /**
33   * Generates stubs for the test Groovy sources and adds them to Maven's test sources for the Maven compiler plugin to find.
34   * Note that this mojo requires Groovy >= 1.8.2.
35   *
36   * @author Keegan Witt
37   * @since 1.0-beta-1
38   */
39  @Mojo(name = "generateTestStubs", defaultPhase = LifecyclePhase.GENERATE_TEST_SOURCES, requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
40  public class GenerateTestStubsMojo extends AbstractGenerateStubsMojo {
41  
42      /**
43       * The Groovy test source files (relative paths).
44       * Default: "${project.basedir}/src/test/groovy/**/*.groovy"
45       */
46      @Parameter
47      protected FileSet[] testSources;
48  
49      /**
50       * The location for the compiled test classes.
51       */
52      @Parameter(defaultValue = "${project.build.directory}/generated-sources/groovy-stubs/test")
53      protected File testStubsOutputDirectory;
54  
55      /**
56       * Flag to allow test stub generation to be skipped.
57       */
58      @Parameter(property = "maven.test.skip", defaultValue = "false")
59      protected boolean skipTests;
60  
61      /**
62       * Executes this mojo.
63       *
64       * @throws MojoExecutionException If an unexpected problem occurs (causes a "BUILD ERROR" message to be displayed)
65       */
66      @Override
67      public void execute() throws MojoExecutionException {
68          if (!skipTests) {
69              minGroovyVersion = GROOVY_1_8_2;
70              try {
71                  try {
72                      getLog().debug("Project test classpath:\n" + project.getTestClasspathElements());
73                  } catch (DependencyResolutionRequiredException e) {
74                      getLog().debug("Unable to log project test classpath");
75                  }
76  
77                  doStubGeneration(getTestFiles(testSources, false), project.getTestClasspathElements(), testStubsOutputDirectory);
78                  logGeneratedStubs(testStubsOutputDirectory);
79                  resetStubModifiedDates(getStubs(testStubsOutputDirectory));
80  
81                  // add stubs to project source so the Maven Compiler Plugin can find them
82                  project.addTestCompileSourceRoot(testStubsOutputDirectory.getAbsolutePath());
83              } catch (ClassNotFoundException e) {
84                  throw new MojoExecutionException("Unable to get a Groovy class from classpath (" + e.getMessage() + "). Do you have Groovy as a compile dependency in your project?", e);
85              } catch (InvocationTargetException e) {
86                  throw new MojoExecutionException("Error occurred while calling a method on a Groovy class from classpath.", e);
87              } catch (InstantiationException e) {
88                  throw new MojoExecutionException("Error occurred while instantiating a Groovy class from classpath.", e);
89              } catch (IllegalAccessException e) {
90                  throw new MojoExecutionException("Unable to access a method on a Groovy class from classpath.", e);
91              } catch (DependencyResolutionRequiredException e) {
92                  throw new MojoExecutionException("Test dependencies weren't resolved.", e);
93              } catch (MalformedURLException e) {
94                  throw new MojoExecutionException("Unable to add project test dependencies to classpath.", e);
95              }
96          } else {
97              getLog().info("Generation of test stubs is skipped.");
98          }
99      }
100 
101 }