org.andromda.maven.plugin.cartridge

Class CartridgeTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.andromda.maven.plugin.cartridge.CartridgeTest

All Implemented Interfaces:

junit.framework.Test

public class CartridgeTest
extends junit.framework.TestCase

This is the entry point of the cartridge test suite for AndroMDA. The test checks for a list of expected files that a file with the same name and the same package was generated by AndroMDA and that the APIs of the expected file and the generated file are equal. CartridgeTest acts as the test director which creates the list of files to be compared. The actual API comparison is carried out by instances of FileComparator.

Author:

Ralf Wirdemann, Chad Brandon, Michail Plushnikov, Bob Fields

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTUAL_DIRECTORY Points to the directory where the generated files are located.
static String	BINARY_SUFFIXES Defines the suffixes of binary files (files that will be not be compared as strings).
static String	EXPECTED_DIRECTORY Points to the directory where the expected files are stored which will be compared to the generated ones.

Constructor Summary

Constructors

Constructor and Description
CartridgeTest(String name)

Method Summary

Methods

Modifier and Type	Method and Description
static CartridgeTest	instance() Retrieves the shared instance of this class.
protected void	setActualOutputDirectory(File file) Used when resetting the cartridge test instance, to avoid results overlap
void	setActualOutputPath(String actualOutputPath) Sets the path to the actual directory (that is the directory which contains the actual output being tested.
void	setBinarySuffixes(String binarySuffixes) Sets the value of the suffixes that indicate a binary file (binary files are not compared as text).
protected void	setExpectedOutputDirectory(File file) Resets the expected output directory.
void	setExpectedOutputPath(String expectedOutputPath) Sets the path to the expected directory.
void	shutdown() Releases any resources held by this cartridge test instance.
static junit.framework.Test	suite()

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, setUp, tearDown, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EXPECTED_DIRECTORY

public static final String EXPECTED_DIRECTORY

Points to the directory where the expected files are stored which will be compared to the generated ones.

See Also:

Constant Field Values

ACTUAL_DIRECTORY

public static final String ACTUAL_DIRECTORY

Points to the directory where the generated files are located.

See Also:

Constant Field Values

BINARY_SUFFIXES

public static final String BINARY_SUFFIXES

Defines the suffixes of binary files (files that will be not be compared as strings).

See Also:

Constant Field Values

Constructor Detail

CartridgeTest

public CartridgeTest(String name)

Parameters:

name -

Method Detail

instance

public static final CartridgeTest instance()

Retrieves the shared instance of this class.

Returns:

the shared instance.

setBinarySuffixes

public void setBinarySuffixes(String binarySuffixes)

Sets the value of the suffixes that indicate a binary file (binary files are not compared as text).

Parameters:

binarySuffixes - a comma separated list of binary suffixes.

setActualOutputPath

public void setActualOutputPath(String actualOutputPath)

Sets the path to the actual directory (that is the directory which contains the actual output being tested.

Parameters:

actualOutputPath - the path to the actual directory.

setExpectedOutputPath

public void setExpectedOutputPath(String expectedOutputPath)

Sets the path to the expected directory. This is the directory to which the expected output is extracted.

Parameters:

expectedOutputPath - the path to the expected output directory.

suite

public static junit.framework.Test suite()

Returns:

suite

setExpectedOutputDirectory

protected void setExpectedOutputDirectory(File file)

Resets the expected output directory.

Parameters:

file - the file representing the directory.

setActualOutputDirectory

protected void setActualOutputDirectory(File file)

Used when resetting the cartridge test instance, to avoid results overlap

Parameters:

file -

shutdown

public void shutdown()

Releases any resources held by this cartridge test instance.