auxtestlib

Class AbstractTestHelper

java.lang.Object

org.junit.Assert

auxtestlib.AbstractTestHelper

Direct Known Subclasses:

ThreadCountTestHelper

public abstract class AbstractTestHelper
extends org.junit.Assert

Super class for all test helpers.

In general, subclasses should override mySetUp() and myTearDown() to create and destroy (using the tearDown() method) helpers they depend on. All test preparation should be done in the myPrepareFixture() and all clean up done in myCleanUp().

Clean up should be an idempotent operation (meaning it should be able to run several times and have the same effect as running a single one). This is important because test case execution may be aborted and disposal of resources may not be done. myPrepareFixture() is always called after clean up so it can assume the test fixture has been previously cleaned.

As a general example, temporary tables should be dropped in the clean up method and created in the prepare fixture. However, the clean up method should be prepared to cope with the error arising from the table not existing. The prepare fixture method, on the other hand, should not catch errors because it is guaranteed that the table has been previously removed.

Note that all helper variables should be static as the mySetUp() method is called when the first helper (of a specific class) is created and the myTearDown() is called when the last helper (of a specific class) is destroyed.

Constructor Summary

Constructors

Constructor and Description
AbstractTestHelper() Creates a new test helper.

Method Summary

Modifier and Type	Method and Description
double	getPropDouble(String key) Gets a test property which has to be defined.
int	getPropInt(String key) Gets a test property which has to be defined.
String	getPropMString(String key) Gets a test property which has to be defined.
static int	getTotalHelperCount() Obtains the total number of helpers created.
protected abstract void	myCleanUp() Cleans all data that may have been generated by this run or previous run of the helper.
protected abstract void	myPrepareFixture() Prepares data for the test.
protected abstract void	mySetUp() Prepares the helper for execution.
protected abstract void	myTearDown() Destroys the helper.
void	tearDown() Destroys a test helper.

Methods inherited from class org.junit.Assert

assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTestHelper

public AbstractTestHelper()
                   throws Exception

Creates a new test helper.

Throws:

Exception - failed

Method Detail

tearDown

public final void tearDown()
                    throws Exception

Destroys a test helper.

Throws:

Exception - failed

getPropMString

public final String getPropMString(String key)

Gets a test property which has to be defined. The property is obtained as a string.

Parameters:

key - the property key (the package name will be automatically prepended)

Returns:

the property value

getPropInt

public final int getPropInt(String key)

Gets a test property which has to be defined. The property is obtained as an integer.

Parameters:

key - the property key (the package name will be automatically prepended)

Returns:

the property value

getPropDouble

public final double getPropDouble(String key)

Gets a test property which has to be defined. The property is obtained as a double.

Parameters:

key - the property key (the package name will be automatically prepended)

Returns:

the property value

getTotalHelperCount

public static int getTotalHelperCount()

Obtains the total number of helpers created. This may be useful to check if we leak helpers.

Returns:

the total number of helpers created

mySetUp

protected abstract void mySetUp()
                         throws Exception

Prepares the helper for execution. This method is invoked when the first helper of this class is created.

Throws:

Exception - failed

myTearDown

protected abstract void myTearDown()
                            throws Exception

Destroys the helper. This method is invoked when the last helper of this class is destroyed.

Throws:

Exception - failed

myCleanUp

protected abstract void myCleanUp()
                           throws Exception

Cleans all data that may have been generated by this run or previous run of the helper.

Throws:

Exception - failed

myPrepareFixture

protected abstract void myPrepareFixture()
                                  throws Exception

Prepares data for the test.

Throws:

Exception - failed