org.codehaus.gmavenplus.mojo.GenerateTestStubsMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gmavenplus-plugin Show documentation
Integrates Groovy into Maven projects.
There is a newer version: 4.0.1
/*
 * Copyright (C) 2011 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.codehaus.gmavenplus.mojo;

import java.lang.reflect.InvocationTargetException;
import java.net.MalformedURLException;

import org.apache.maven.artifact.DependencyResolutionRequiredException;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.codehaus.gmavenplus.model.Version;


/**
 * Generates stubs for the test Groovy sources and adds them to Maven's test sources for the Maven compiler plugin to find.
 * Note that this mojo requires Groovy >= 1.8.2.
 *
 * @author Keegan Witt
 * @since 1.0-beta-1
 *
 * @goal testGenerateStubs
 * @phase generate-test-sources
 * @configurator include-project-test-dependencies
 * @requiresDependencyResolution test
 * @threadSafe
 */
public class GenerateTestStubsMojo extends AbstractGenerateStubsMojo {

    /**
     * Flag to allow test compilation to be skipped.
     *
     * @parameter property="maven.test.skip" default-value="false"
     */
    protected boolean skip;

    /**
     * Executes this mojo.
     *
     * @throws MojoExecutionException If an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed
     * @throws MojoFailureException If an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed
     */
    public void execute() throws MojoExecutionException, MojoFailureException {
        if (!skip) {
            minGroovyVersion = new Version(1, 8, 2);
            if (groovyVersionSupportsAction()) {
                logGroovyVersion("testGenerateStubs");

                try {
                    doStubGeneration(getTestSources(), project.getTestClasspathElements(), testStubsOutputDirectory);

                    resetStubModifiedDates(getTestStubs());

                    // add stubs to project source so the Maven Compiler Plugin can find them
                    project.addTestCompileSourceRoot(testStubsOutputDirectory.getAbsolutePath());
                } catch (ClassNotFoundException e) {
                    throw new MojoExecutionException("Unable to get a Groovy class from classpath.  Do you have Groovy as a compile dependency in your project?", e);
                } catch (InvocationTargetException e) {
                    throw new MojoExecutionException("Error occurred while calling a method on a Groovy class from classpath.", e);
                } catch (InstantiationException e) {
                    throw new MojoExecutionException("Error occurred while instantiating a Groovy class from classpath.", e);
                } catch (IllegalAccessException e) {
                    throw new MojoExecutionException("Unable to access a method on a Groovy class from classpath.", e);
                } catch (DependencyResolutionRequiredException e) {
                    throw new MojoExecutionException("Test dependencies weren't resolved.", e);
                } catch (MalformedURLException e) {
                    throw new MojoExecutionException("Unable to add project dependencies to classpath.", e);
                }
            } else {
                getLog().error("Your Groovy version (" + getGroovyVersion() + ") doesn't support stub generation.  The minimum version of Groovy required is " + minGroovyVersion + ".  Skipping stub generation.");
            }
        } else {
            getLog().info("Skipping generation of test stubs because ${maven.test.skip} was set to true.");
        }
    }

}