TestCase represent a factory for TestEnvironments
* creation and disposing for a given implementation object. The
* TestEnvironment contains an instance of the implementation
* object and all additional objects needed to perform tests on the object.
*
* The TestCase provides four methods for its subclasses to
* define its functionality: initialize(), cleanup(),
* createTestEnvironment() and disposeTestEnvironment().
* The first two are intended to initialize and cleanup common objects shared
* among all instances of TestEnvironment produced by the
* TestCase, and they are called at the beginning and at the end of
* the TestCase lifecycle accordingly.
*
*
The other two are intended to produce and dispose
* TestEnvironment instances. The
* createTestEnvironment() is called to create a
* TestEnvironment instance and the
* disposeTestEnvironment() is called when the instane is not used
* anymore.
*
* @see lib.TestEnvironment
*/
public abstract class TestCase {
/**
* Specifies the PrintWriter to log information.
*/
public PrintWriter log;
//public static TestCase tCase;
/**
* Sets the log to write information during testing.
*/
public void setLogWriter( PrintWriter log ) {
this.log = log;
}
/**
* Initializes the TestCase. Calls initialize()
* method.
*
* @param tParam test parameters.
*/
public void initializeTestCase( TestParameters tParam ) {
initialize( tParam, log );
}
/**
* Called while the TestCase initialization. In the
* implementation does nothing. Subclasses can override to initialize
* objects shared among all TestEnvironments.
*
* @param tParam test parameters
* @param log writer to log information while testing
*
* @see #initializeTestCase()
*/
protected void initialize( TestParameters tParam, PrintWriter log ) {
}
/**
* Cleans up the TestCase. Calls cleanup().
*
* @param tParam test parameters
*/
public void cleanupTestCase( TestParameters tParam ) {
cleanup( tParam, log );
}
/**
* Called while the TestCase cleanup. In the implementation
* does nothing. Subclasses can override to cleanup objects shared among
* all TestEnvironments.
*
* @param tParam test parameters
* @param log writer to log information while testing
*
* @see #cleanupTestCase
*/
protected void cleanup( TestParameters tParam, PrintWriter log ) {
}
/**
* Creates a TestEnvironment containing an instance of the
* implementation object and related objects needed to perform test.
*
* @param tParam test parameters
*
* @return the created TestEnvironment
*
* @see #createTestEnvironment()
* @see lib.TestEnvironment
*/
public synchronized TestEnvironment getTestEnvironment( TestParameters tParam ) {
TestEnvironment tEnv = null;
try {
tEnv = createTestEnvironment( tParam, log );
System.out.println("Environment created");
if (tEnv != null) {
tEnv.setTestCase(this);
}
} catch (Exception e) {
String message = e.getMessage();
if (message == null)
message = e.toString();
System.out.println("Exception while getting Environment "+message);
e.printStackTrace();
}
return tEnv;
}
/**
* Disposes the TestEnvironment when it is not needed anymore.
* The method calls cleanupTestEnvironment().
*
* @param tEnv the environment to dispose
* @param tParam test parameters
*
* @see #cleanupTestEnvironment()
*/
public synchronized void disposeTestEnvironment( TestEnvironment tEnv,
TestParameters tParam ) {
cleanup( tParam, log );
}
/**
* Called to create an instance of TestEnvironment with an
* object to test and related objects. Subclasses should implement this
* method to provide the implementation and related objects. The method is
* called from getTestEnvironment().
*
* @param tParam test parameters
* @param log writer to log information while testing
*
* @see TestEnvironment
* @see #getTestEnvironment()
*/
protected abstract TestEnvironment createTestEnvironment(
TestParameters tParam, PrintWriter log );
/**
* Called while disposing a TestEnvironment. In the
* implementation does nothing. Subclasses can override to clean up
* the environments created by them.
*
* @param tParam test parameters
* @param tEnv the environment to cleanup
* @param log writer to log information while testing
*
* @see TestEnvironment
* @see #disposeTestEnvironment()
*/
protected void cleanupTestEnvironment( TestParameters Param,
TestEnvironment tEnv, PrintWriter log ) {
}
/**
* @return the name of the object
*/
public String getObjectName() {
String clName = this.getClass().getName();
return clName.substring( clName.lastIndexOf('.') + 1 );
}
}