org.apache.maven.archetype.mojos

Class IntegrationTestMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.archetype.mojos.IntegrationTestMojo

All Implemented Interfaces:

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

@Mojo(name="integration-test",
      requiresProject=true)
public class IntegrationTestMojo
extends org.apache.maven.plugin.AbstractMojo

Execute the archetype integration tests, consisting in generating projects from the current archetype and optionally comparing generated projects with reference copy.

Each IT consists of a sub-directory in src/test/resources/projects containing:

• a goal.txt file, containing a list of goals to run against the generated project (can be empty, content ignored before maven-archetype-plugin 2.1),
• an archetype.properties file, containing properties for project generation,
• an optional reference/ directory containing a reference copy of the expected project created from the IT.

Notice that it is expected to be run as part as of a build after the package phase and not directly as a goal from CLI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	IntegrationTestMojo.CompositeMap
(package private) class	IntegrationTestMojo.IntegrationTestFailure

Field Summary

Fields

Modifier and Type	Field and Description
private ArchetypeGenerator	archetypeGenerator
private boolean	debug Whether to show debug statements in the build output.
private java.lang.String	encoding The file encoding for the post-build script.
private java.util.Map<java.lang.String,java.lang.String>	filterProperties A list of additional properties which will be used to filter tokens in settings.xml
private boolean	ignoreEOLStyle Ignores the EOL encoding for comparing files (default and original behaviour is false).
private org.apache.maven.shared.invoker.Invoker	invoker
private java.io.File	localRepositoryPath The local repository to run maven instance.
private boolean	noLog Suppress logging to the build.log file.
private java.lang.String	postBuildHookScript Relative path of a cleanup/verification hook script to run after executing the build.
private org.apache.maven.project.MavenProject	project The archetype project to execute the integration tests on.
private org.apache.maven.settings.Settings	settings The current user system settings for use in Maven.
private java.io.File	settingsFile Path to an alternate settings.xml to use for Maven invocation with all ITs.
private boolean	showVersion flag to enable show mvn version used for running its (cli option : -V,--show-version )
private boolean	skip Skip the integration test.
private boolean	streamLogs Flag used to determine whether the build logs should be output to the normal mojo log.
private java.io.File	testProjectsDirectory Directory of test projects

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

ROLE

Constructor Summary

Constructors

Constructor and Description
IntegrationTestMojo()

Method Summary

Modifier and Type	Method and Description
private void	assertDirectoryEquals(java.io.File reference, java.io.File actual) Checks that actual directory content is the same as reference.
protected void	buildInterpolatedFile(java.io.File originalFile, java.io.File interpolatedFile)
private boolean	contentEquals(java.io.File referenceFile, java.io.File actualFile) Uses the ignoreEOLStyle attribute to compare the two files.
void	execute()
private java.util.Map<java.lang.String,java.lang.Object>	getInterpolationValueSource() Returns the map-based value source used to interpolate settings and other stuff.
private java.util.Properties	getProperties(java.io.File goalFile)
private void	invokePostArchetypeGenerationGoals(java.lang.String goals, java.io.File basedir, java.io.File goalFile)
private java.util.Properties	loadProperties(java.io.File propertiesFile)
private void	processIntegrationTest(java.io.File goalFile, java.io.File archetypeFile)
private FileLogger	setupLogger(java.io.File basedir)
private static java.lang.String	toUrl(java.lang.String filename) Converts the specified filesystem path to a URL.

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 Detail

archetypeGenerator

@Component
private ArchetypeGenerator archetypeGenerator

invoker

@Component
private org.apache.maven.shared.invoker.Invoker invoker

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
private org.apache.maven.project.MavenProject project

The archetype project to execute the integration tests on.

skip

@Parameter(property="archetype.test.skip")
private boolean skip

Skip the integration test.

testProjectsDirectory

@Parameter(property="archetype.test.projectsDirectory",
           defaultValue="${project.build.testOutputDirectory}/projects",
           required=true)
private java.io.File testProjectsDirectory

Directory of test projects

Since:

2.2

postBuildHookScript

@Parameter(property="archetype.test.verifyScript",
           defaultValue="verify")
private java.lang.String postBuildHookScript

Relative path of a cleanup/verification hook script to run after executing the build. This script may be written with either BeanShell or Groovy. If the file extension is omitted (e.g. verify), the plugin searches for the file by trying out the well-known extensions .bsh and .groovy. If this script exists for a particular project but returns any non-null value different from true or throws an exception, the corresponding build is flagged as a failure.

Since:

2.2

noLog

@Parameter(property="archetype.test.noLog",
           defaultValue="false")
private boolean noLog

Suppress logging to the build.log file.

Since:

2.2

streamLogs

@Parameter(property="archetype.test.streamLogs",
           defaultValue="true")
private boolean streamLogs

Flag used to determine whether the build logs should be output to the normal mojo log.

Since:

2.2

encoding

@Parameter(property="encoding",
           defaultValue="${project.build.sourceEncoding}")
private java.lang.String encoding

The file encoding for the post-build script.

Since:

2.2

localRepositoryPath

@Parameter(property="archetype.test.localRepositoryPath",
           defaultValue="${settings.localRepository}",
           required=true)
private java.io.File localRepositoryPath

The local repository to run maven instance.

Since:

2.2

showVersion

@Parameter(property="archetype.test.showVersion",
           defaultValue="false")
private boolean showVersion

flag to enable show mvn version used for running its (cli option : -V,--show-version )

Since:

2.2

ignoreEOLStyle

@Parameter(property="archetype.test.ignoreEOLStyle",
           defaultValue="false")
private boolean ignoreEOLStyle

Ignores the EOL encoding for comparing files (default and original behaviour is false).

Since:

2.3

debug

@Parameter(property="archetype.test.debug",
           defaultValue="false")
private boolean debug

Whether to show debug statements in the build output.

Since:

2.2

filterProperties

@Parameter
private java.util.Map<java.lang.String,java.lang.String> filterProperties

A list of additional properties which will be used to filter tokens in settings.xml

Since:

2.2

settings

@Parameter(defaultValue="${settings}",
           required=true,
           readonly=true)
private org.apache.maven.settings.Settings settings

The current user system settings for use in Maven.

Since:

2.2

settingsFile

@Parameter(property="archetype.test.settingsFile")
private java.io.File settingsFile

Path to an alternate settings.xml to use for Maven invocation with all ITs. Note that the <localRepository> element of this settings file is always ignored, i.e. the path given by the parameter localRepositoryPath is dominant.

Since:

2.2

Constructor Detail

IntegrationTestMojo

public IntegrationTestMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

assertDirectoryEquals

private void assertDirectoryEquals(java.io.File reference,
                                   java.io.File actual)
                            throws IntegrationTestMojo.IntegrationTestFailure,
                                   java.io.IOException

Checks that actual directory content is the same as reference.

Parameters:

reference - the reference directory

actual - the actual directory to compare with the reference

Throws:

IntegrationTestMojo.IntegrationTestFailure - if content differs

java.io.IOException

contentEquals

private boolean contentEquals(java.io.File referenceFile,
                              java.io.File actualFile)
                       throws java.io.IOException

Uses the ignoreEOLStyle attribute to compare the two files. If ignoreEOLStyle is true, then the comparison does not take care about the EOL (aka newline) character.

Throws:

java.io.IOException

loadProperties

private java.util.Properties loadProperties(java.io.File propertiesFile)
                                     throws java.io.IOException,
                                            java.io.FileNotFoundException

Throws:

java.io.IOException

java.io.FileNotFoundException

processIntegrationTest

private void processIntegrationTest(java.io.File goalFile,
                                    java.io.File archetypeFile)
                             throws IntegrationTestMojo.IntegrationTestFailure,
                                    org.apache.maven.plugin.MojoExecutionException

Throws:

IntegrationTestMojo.IntegrationTestFailure

org.apache.maven.plugin.MojoExecutionException

getProperties

private java.util.Properties getProperties(java.io.File goalFile)
                                    throws java.io.IOException

Throws:

java.io.IOException

invokePostArchetypeGenerationGoals

private void invokePostArchetypeGenerationGoals(java.lang.String goals,
                                                java.io.File basedir,
                                                java.io.File goalFile)
                                         throws IntegrationTestMojo.IntegrationTestFailure,
                                                java.io.IOException,
                                                org.apache.maven.plugin.MojoExecutionException

Throws:

IntegrationTestMojo.IntegrationTestFailure

java.io.IOException

org.apache.maven.plugin.MojoExecutionException

setupLogger

private FileLogger setupLogger(java.io.File basedir)
                        throws java.io.IOException

Throws:

java.io.IOException

getInterpolationValueSource

private java.util.Map<java.lang.String,java.lang.Object> getInterpolationValueSource()

Returns the map-based value source used to interpolate settings and other stuff.

Returns:

The map-based value source for interpolation, never null.

buildInterpolatedFile

protected void buildInterpolatedFile(java.io.File originalFile,
                                     java.io.File interpolatedFile)
                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

toUrl

private static java.lang.String toUrl(java.lang.String filename)

Converts the specified filesystem path to a URL. The resulting URL has no trailing slash regardless whether the path denotes a file or a directory.

Parameters:

filename - The filesystem path to convert, must not be null.

Returns:

The file: URL for the specified path, never null.