Package org.codehaus.gmavenplus.mojo

Class GenerateTestStubsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

org.codehaus.gmavenplus.mojo.AbstractGroovyStubSourcesMojo

org.codehaus.gmavenplus.mojo.AbstractGenerateStubsMojo

org.codehaus.gmavenplus.mojo.GenerateTestStubsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generateTestStubs",
      defaultPhase=GENERATE_TEST_SOURCES,
      requiresDependencyResolution=TEST,
      threadSafe=true)
public class GenerateTestStubsMojo
extends AbstractGenerateStubsMojo

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.

Since:

1.0-beta-1

Author:

Keegan Witt

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	skipTests	Flag to allow test stub generation to be skipped.
protected org.apache.maven.shared.model.fileset.FileSet[]	testSources	The Groovy test source files (relative paths).
protected File	testStubsOutputDirectory	The location for the compiled test classes.

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGenerateStubsMojo

debug, GROOVY_1_8_2, GROOVY_1_8_3, GROOVY_1_9_0_BETA1, GROOVY_1_9_0_BETA3, GROOVY_2_1_3, GROOVY_2_3_3, GROOVY_2_5_3, GROOVY_2_5_7, GROOVY_2_6_0_ALPHA1, GROOVY_2_6_0_ALPHA4, GROOVY_3_0_0_ALPHA1, GROOVY_3_0_0_ALPHA2, GROOVY_3_0_0_ALPHA4, GROOVY_3_0_0_BETA1, GROOVY_3_0_0_BETA2, GROOVY_3_0_3, GROOVY_3_0_6, GROOVY_3_0_8, GROOVY_4_0_0_ALPHA1, GROOVY_4_0_0_ALPHA3, GROOVY_4_0_0_BETA1, GROOVY_4_0_11, GROOVY_4_0_16, GROOVY_4_0_2, GROOVY_4_0_21, GROOVY_4_0_24, GROOVY_4_0_27, GROOVY_4_0_6, GROOVY_5_0_0_ALPHA1, GROOVY_5_0_0_ALPHA11, GROOVY_5_0_0_ALPHA13, GROOVY_5_0_0_ALPHA3, GROOVY_5_0_0_ALPHA8, includeClasspath, skipBytecodeCheck, sourceEncoding, targetBytecode, tolerance, verbose, warningLevel

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

MAIN, TEST

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

classWrangler, GROOVY_1_5_0, GROOVY_SOURCES_PATTERN, JAVA_1_7, JAVA_1_8, JAVA_12, JAVA_SOURCES_PATTERN, minGroovyVersion, mojoExecution, pluginArtifacts, project, session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateTestStubsMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes this mojo.

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGenerateStubsMojo

addGroovySources, doStubGeneration, logGeneratedStubs, resetStubModifiedDates, setupCompilerConfiguration, supportsSettingExtensions, translateJavacTargetToTargetBytecode, verifyGroovyVersionSupportsTargetBytecode

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyStubSourcesMojo

getStubs, removeSourceRoot

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

getFiles, getFilesets, getTestFiles, getTestFilesets

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

getJavaVersion, getJavaVersionString, groovyAtLeast, groovyIs, groovyNewerThan, groovyOlderThan, groovyVersionSupportsAction, isGroovyIndy, isJavaSupportIndy, isJavaSupportParameters, isJavaSupportPreviewFeatures, logPluginClasspath, setupClassWrangler

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 Details

testSources

@Parameter
protected org.apache.maven.shared.model.fileset.FileSet[] testSources

The Groovy test source files (relative paths). Default: "${project.basedir}/src/test/groovy/**/*.groovy"

testStubsOutputDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/groovy-stubs/test")
protected File testStubsOutputDirectory

The location for the compiled test classes.

skipTests

@Parameter(property="maven.test.skip",
           defaultValue="false")
protected boolean skipTests

Flag to allow test stub generation to be skipped.

Constructor Details

GenerateTestStubsMojo

public GenerateTestStubsMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Executes this mojo.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an unexpected problem occurs (causes a "BUILD ERROR" message to be displayed)