Package org.jtiger.framework

Provides a framework for performing automated testing based on fixtures and test cases.

See:
          Description

Interface Summary
ClassAliasMapping Provides a mapping between user-friendly alias names for class names that are used by the framework.
FixtureResult Represents the result of the execution of all the test case methods in a test fixture class.
FixtureResults Represents the fixture results of the execution of all the test case methods in a test fixture class.
FixtureResultsHandler Handle the result of a test run.
FixturesRunner Executes a test configuration and returns the result of the test run.
FixturesRunnerConfig Represents the configuration for a test execution.
Positionable A position can be conceptualised as a point between two elements in a structure.
PositionableIterator Deprecated. Use Positionable instead.
ReadOnlyArray<E> A wrapper type typically backed by an array that provides read-only access to the elements of the array.
Sequence<E> A sequentially ordered set of elements that cannot be mutated (changed).
SequenceIterator<E> An iterator of a Sequence that permits bidirectional traversal.
SetUpTearDown Provides an implementation of setting up and tearing down a test fixture.
TestDefinition Determines whether or not a given java.lang.reflect.Method is to be considered a test case method.
TestResult Represents the result after execution of a test case method.
 

Class Summary
ClassAliasMappingFactory Provides an alias name to a class name using a resource as the mapping.
DefaultFixtureResultsHandlerFactory The default implementation to handle fixture results sends output to the standard output stream with a summary of the result.
DefaultSetUpTearDownFactory The default implementation of setting up and tearing down a unit test case.
DefaultTestDefinitionFactory Provides a default implementation of defining a unit test case method.
FixturesRunnerConfigFactory Returns instances of FixturesRunnerConfig.
FixturesRunnerFactory Returns instances of FixturesRunner.
FixturesRunnerMain Provides an entry point into a test execution by using a main method.
ReadOnlyArrayFactory Deprecated. Use SequenceFactory instead.
SequenceFactory Returns instances of Sequence such that state cannot be modified.
 

Enum Summary
TestResultType An enumeration of the possible result types of a test case execution.
 

Exception Summary
FixtureResultsHandlerException An exception that may be thrown during the handling of test results.
PositionOutOfBoundsException An exception that is thrown when a structure's position is specified that is outside of the permissible bounds for that structure.
RunnerException An exception that may be thrown during the creation or execution of test fixture classes.
SetUpException An exception that may be thrown during the setting up of a test case.
TearDownException An exception that may be thrown during the tearing down of a test case.
 

Annotation Types Summary
Category Used to annotate test case methods or test fixture classes by specifying which category(ies) it is in.
ExpectException Used to annotate a test case method that is expecting an exception to occur.
Fixture Used to annotate a class as one which contains test cases.
Ignore Used to annotate a test fixture class or test case method to indicate that it should be ignored during test execution.
Repeat Used to annotate a test case method to have it executed more than once during test execution.
SetUp Used to annotate a method in a test fixture class that it should be executed prior to each test case method execution.
TearDown Used to annotate a method in a test fixture class that it should be executed after each test case method execution.
Test Used to annotate a test case method in a test fixture class.
 

Package org.jtiger.framework Description

Provides a framework for performing automated testing based on fixtures and test cases. A test fixture class is optionally annotated with Fixture and each test case method within the class is annotated with Test to indicate that it is a test case method. A test fixture class may contain methods that are annotated with SetUp or TearDown, which are executed before and after each test case method respectively. Test case methods, set up methods, and tear down methods should take no arguments and test fixture classes should have a no argument constructor, or a constructor that takes a single java.lang.String argument. Example:

    // The presence of this annotation is optional.
    @Fixture("Demonstration")
    class MyTestFixture
    {
        @SetUp
        public void setUpFixture()
        {
            // ommitted
        }

        @Test
        public void doSomeTesting()
        {
            // ommitted
        }

        @TearDown
        public void tearDownFixture()
        {
            // ommitted
        }
    }

The framework package defines two points of entry for execution of test fixtures;
  • FixturesRunner provides the ability to run test fixtures through an API.
  • FixturesRunnerMain provides the ability to run test fixtures from a command line (since it contains a main method.

  • Other packages could typically provide other means of executing test fixtures. For example, an Apache Ant task, or a swing application interface.

    See Also:
    Fixture, Test, SetUp, TearDown, FixturesRunner, FixturesRunnerFactory, FixturesRunnerMain