org.apache.derbyTesting.unitTests.harness

Class T_Generic

java.lang.Object

org.apache.derbyTesting.unitTests.harness.T_Generic

All Implemented Interfaces:

org.apache.derby.iapi.services.monitor.ModuleControl, UnitTest

Direct Known Subclasses:

T_AccessFactory, T_CacheService, T_Cipher, T_Heap, T_Like, T_MarkedLimitInputStream, T_MultiIterations, T_RecoverBadLog, T_RecoverFullLog, T_Recovery, T_SortController, T_UUIDFactory, T_XA

public abstract class T_Generic
extends java.lang.Object
implements UnitTest, org.apache.derby.iapi.services.monitor.ModuleControl

Abstract class which executes a unit test.

To write a test, extend this class with a class which implements the two abstract methods:

• runTests
• setUp

See Also:

UnitTest, ModuleControl

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.derby.iapi.services.stream.HeaderPrintWriter	out The HeaderPrintWriter for test output.
protected java.lang.String	shortModuleToTestName The unqualified name for the module to test.
protected java.util.Properties	startParams The start parameters for your test.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	T_Generic()

Method Summary

Modifier and Type	Method and Description
void	boot(boolean create, java.util.Properties startParams) ModuleControl.start
boolean	Execute(org.apache.derby.iapi.services.stream.HeaderPrintWriter out) UnitTest.Execute
protected boolean	FAIL(java.lang.String msg) Emit a message indicating why the test failed.
protected abstract java.lang.String	getModuleToTestProtocolName() Get the name of the protocol for the module to test.
protected boolean	PASS(java.lang.String testName) Emit a message saying the test passed.
void	REPORT(java.lang.String msg) Emit a message during a unit test run, indent the message to allow the PASS/FAIL messages to stand out.
protected abstract void	runTests() Run the test.
void	stop() ModuleControl.stop
int	UnitTestDuration() UnitTest.UnitTestDuration
int	UnitTestType() UnitTest.UnitTestType

Methods inherited from class java.lang.Object

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

Field Detail

shortModuleToTestName

protected java.lang.String shortModuleToTestName

The unqualified name for the module to test. This is set by the generic code.

startParams

protected java.util.Properties startParams

The start parameters for your test. This is set by generic code.

out

protected org.apache.derby.iapi.services.stream.HeaderPrintWriter out

The HeaderPrintWriter for test output. This is set by the generic code.

Constructor Detail

T_Generic

protected T_Generic()

Method Detail

boot

public void boot(boolean create,
                 java.util.Properties startParams)
          throws org.apache.derby.iapi.error.StandardException

ModuleControl.start

Specified by:

boot in interface org.apache.derby.iapi.services.monitor.ModuleControl

Throws:

org.apache.derby.iapi.error.StandardException - Module cannot be started.

See Also:

ModuleControl.boot(boolean, java.util.Properties)

stop

public void stop()

ModuleControl.stop

Specified by:

stop in interface org.apache.derby.iapi.services.monitor.ModuleControl

See Also:

ModuleControl.stop()

Execute

public boolean Execute(org.apache.derby.iapi.services.stream.HeaderPrintWriter out)

UnitTest.Execute

Specified by:

Execute in interface UnitTest

Parameters:

out - A HeaderPrintWriter the test may use for tracing. To disable tracing the caller may provide a HeaderPrintWriter which throws away all the data the test writes.

Returns:

true iff the test passes

See Also:

UnitTest.Execute(org.apache.derby.iapi.services.stream.HeaderPrintWriter)

UnitTestDuration

public int UnitTestDuration()

UnitTest.UnitTestDuration

Specified by:

UnitTestDuration in interface UnitTest

Returns:

UnitTestConstants.DURATION_MICRO

See Also:

UnitTest.UnitTestDuration(), UnitTestConstants

UnitTestType

public int UnitTestType()

UnitTest.UnitTestType

Specified by:

UnitTestType in interface UnitTest

Returns:

UnitTestConstants.TYPE_COMMON

See Also:

UnitTest.UnitTestType(), UnitTestConstants

FAIL

protected boolean FAIL(java.lang.String msg)

Emit a message indicating why the test failed. RESOLVE: Should this be localized?

Parameters:

msg - the message.

Returns:

false

PASS

protected boolean PASS(java.lang.String testName)

Emit a message saying the test passed. You may use this to emit messages indicating individual test cases within a unit test passed.

RESOLVE:Localize this.

Parameters:

testName - the test which passed.

Returns:

true

REPORT

public void REPORT(java.lang.String msg)

Emit a message during a unit test run, indent the message to allow the PASS/FAIL messages to stand out.

runTests

protected abstract void runTests()
                          throws java.lang.Exception

Run the test. The test should raise an exception if it fails. runTests should return if the tests pass.

Throws:

java.lang.Exception - Test code throws these

getModuleToTestProtocolName

protected abstract java.lang.String getModuleToTestProtocolName()

Get the name of the protocol for the module to test. This is the 'factory.MODULE' variable. 'moduleName' to the name of the module to test.