org.andromda.maven.plugin.cartridge

Class AbstractCartridgeTestMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.andromda.maven.plugin.cartridge.AbstractCartridgeTestMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CartridgeTestMojo, CartridgeTestUpdaterMojo

public abstract class AbstractCartridgeTestMojo
extends org.apache.maven.plugin.AbstractMojo

Abstract base mojo for cartridge tests. Must be subclassed.

Author:

Chad Brandon, Peter Friese, Bob Fields

Field Summary

Fields

Modifier and Type	Field and Description
protected File	actualDirectory Specifies the directory that contains the "actual" output (meaning the output that was currently generated)
protected ArchiverManager	archiverManager To look up Archiver/UnArchiver implementations
protected String	binaryOutputSuffixes Defines the extensions of binary files, binary files are checked for presence and equality, however they aren't compared as strings, like every other file.
protected String	configurationUri This is the URI to the AndroMDA configuration file.
protected File	expectedDirectory Specifies the directory that contains the "expected" output.
protected File	expectedOutputArchive The location of the archive storing the expected output.
protected boolean	lastModifiedCheck Set this to 'true' to skip code generation if code has not changed since the latest model date.
protected org.apache.maven.project.MavenProject	project
protected List<String>	propertyFiles
protected File	reportDirectory Base directory to which the cartridge test report is written
protected Settings	settings The current user system settings for use in Maven.
protected boolean	skip Set this to 'true' to bypass cartridge tests entirely.
protected boolean	skipTests Set this to 'true' to skip running tests, but still compile them.
protected boolean	testFailureIgnore Set this to true to ignore a failure during testing.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCartridgeTestMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	changeScopeForTestDependencies() Adds any dependencies for the cartridge plugin to the current dependencies of the project.
protected void	unpack(File file, File location) Unpacks the expected archive file to the expected directory

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

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

execute

Field Detail

reportDirectory

protected File reportDirectory

Base directory to which the cartridge test report is written

actualDirectory

protected File actualDirectory

Specifies the directory that contains the "actual" output (meaning the output that was currently generated)

expectedDirectory

protected File expectedDirectory

Specifies the directory that contains the "expected" output.

expectedOutputArchive

protected File expectedOutputArchive

The location of the archive storing the expected output.

configurationUri

protected String configurationUri

This is the URI to the AndroMDA configuration file.

project

protected org.apache.maven.project.MavenProject project

propertyFiles

protected List<String> propertyFiles

settings

protected Settings settings

The current user system settings for use in Maven. (allows us to pass the user settings to the AndroMDA configuration).

binaryOutputSuffixes

protected String binaryOutputSuffixes

Defines the extensions of binary files, binary files are checked for presence and equality, however they aren't compared as strings, like every other file.

archiverManager

protected ArchiverManager archiverManager

To look up Archiver/UnArchiver implementations

skip

protected boolean skip

Set this to 'true' to bypass cartridge tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion.

skipTests

protected boolean skipTests

Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.

testFailureIgnore

protected boolean testFailureIgnore

Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.

lastModifiedCheck

protected boolean lastModifiedCheck

Set this to 'true' to skip code generation if code has not changed since the latest model date.

Constructor Detail

AbstractCartridgeTestMojo

public AbstractCartridgeTestMojo()

Method Detail

changeScopeForTestDependencies

protected void changeScopeForTestDependencies()

Adds any dependencies for the cartridge plugin to the current dependencies of the project.

unpack

protected void unpack(File file,
          File location)
               throws org.apache.maven.plugin.MojoExecutionException

Unpacks the expected archive file to the expected directory

Parameters:

file - File to be unpacked.

location - Location where to put the unpacked files.

Throws:

org.apache.maven.plugin.MojoExecutionException - Error unpacking file