lejosunit.framework
Class TestCase

java.lang.Object
  lejosunit.framework.Assert
      lejosunit.framework.TestCase

All Implemented Interfaces:

Test

Direct Known Subclasses:

AssertTest, FreeMemoryTest, HelloWorldTest, MyTestCase, MyTestCaseTest, OneTest, SimpleTest, TestCaseTest, TestRunnerTest, TwoTest, UtilTest

public abstract class TestCase

extends Assert

implements Test

A test case defines the fixture to run multiple tests. To define a test case

1. implement a subclass of TestCase
   
2. define instance variables that store the state of the fixture
   
3. initialize the fixture state by overriding setUp
   
4. clean-up after a test by overriding tearDown.
   

Each test runs in its own fixture so there can be no side effects among test runs. Here is an example:

 public class MathTest extends TestCase {
     protected double fValue1;
     protected double fValue2;

     public MathTest(String name) {
         super(name);
     }

    protected void setUp() {
         fValue1= 2.0;
         fValue2= 3.0;
     }
 }
 

For each test implement a method which interacts with the fixture. Verify the expected results with assertions specified by calling assert with a boolean.

    protected void testAdd() {
        double result= fValue1 + fValue2;
        assert(result == 5.0);
    }
 

lejosunit does NOT support Java Reflection. Therefore, only a static type safe call of test methods can be used. So, a test case is responsible to call the right test method. This can be done by overriding the runTest() method. Example: Define the runTest () as dispatcher method:

 public void runTest () {
   if ("testAdd".equals (getName ()) {
     testAdd ();
   } else if ("testDivideByZero".equals (getName ()) {{
     testSubtract ();
   }
 }
 

Create a new test and run it:

 Test test = new MathTest ("testAdd");
 test.run ();
 

A convenient way to do so is with an anonymous inner class.

 Test test= new MathTest("add") {
        public void runTest() {
            testAdd();
        }
 };
 test.run();
 

The tests to be run can be collected into a TestSuite. leJOSUnit provides different test runners which can run a test suite and collect the results. A test runner either expects a static method suite as the entry point to get a test to run or it will extract the suite automatically.

 public static Test suite() {
      TestSuite suite = new TestSuite ();
      suite.addTest(new MathTest("testAdd"));
      suite.addTest(new MathTest("testDivideByZero"));
      return suite;
  }
 

Author:

Jochen Hiller

See Also:

TestResult, TestSuite

Constructor Summary

TestCase()
No-arg constructor to enable serialization.

TestCase(java.lang.String name)
Constructs a test case with the given name.

Method Summary

int	countTestCases() Counts the number of test cases executed by run(TestResult result).
protected TestResult	createResult() Creates a default TestResult object
java.lang.String	getName() Gets the name of a TestCase
TestResult	run() A convenience method to run this test, collecting the results with a default TestResult object.
void	run(TestResult result) Runs the test case and collects the results in TestResult.
void	runBare() Runs the bare test sequence.
protected abstract void	runTest() Override to run the test and assert its state.
protected void	setUp() Sets up the fixture, for example, open a network connection.
protected void	tearDown() Tears down the fixture, for example, close a network connection.
java.lang.String	toString() Returns a string representation of the test case

Methods inherited from class lejosunit.framework.Assert

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, fail, fail, failNotEquals, failSame

Methods inherited from class java.lang.Object

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

Constructor Detail

TestCase

public TestCase()

No-arg constructor to enable serialization. This method is not intended to be used by mere mortals.

TestCase

public TestCase(java.lang.String name)

Constructs a test case with the given name.

Parameters:

name - the name of the test has to be specified at object creation time

Method Detail

countTestCases

public int countTestCases()

Counts the number of test cases executed by run(TestResult result).

Specified by:

countTestCases in interface Test

Returns:

always 1

createResult

protected TestResult createResult()

Creates a default TestResult object

See Also:

TestResult

run

public TestResult run()

A convenience method to run this test, collecting the results with a default TestResult object.

See Also:

TestResult

run

public void run(TestResult result)

Runs the test case and collects the results in TestResult.

Specified by:

run in interface Test

Parameters:

result - the test results to write into

runBare

public void runBare()
             throws java.lang.Throwable

Runs the bare test sequence.

Throws:

java.lang.Throwable - if any exception is thrown

runTest

protected abstract void runTest()
                         throws java.lang.Throwable

Override to run the test and assert its state.

Throws:

java.lang.Throwable - if any exception is thrown

setUp

protected void setUp()
              throws java.lang.Exception

Sets up the fixture, for example, open a network connection. This method is called before a test is executed.

Throws:

java.lang.Exception - can be raised in general

tearDown

protected void tearDown()
                 throws java.lang.Exception

Tears down the fixture, for example, close a network connection. This method is called after a test is executed.

Throws:

java.lang.Exception - can be raised in general

toString

public java.lang.String toString()

Returns a string representation of the test case

Returns:

the string representation of a test case

getName

public java.lang.String getName()

Gets the name of a TestCase

Returns:

returns a String