Module org.opengis.geoapi.conformance

Package org.opengis.test

Class TestCase

Object

TestCase

Direct Known Subclasses:

ImageIOTestCase, NameTest, ReferencingTestCase, TransformTestCase

@TestInstance(PER_METHOD)
public abstract class TestCase
extends Object

Base class of all GeoAPI tests. All concrete subclasses need at least one Factory for instantiating the objects to test. The factories must be specified at subclasses construction time either directly by the implementer, or indirectly through dependency injection.

Test case life cycle

GeoAPI test cases contain states as non-final protected fields. Therefor, a new TestCase instance should be created for each test method to run (Lifecycle.PER_METHOD). If PER_CLASS is desired, then subclasses are responsible for resetting these fields after each test.

Since:

2.2

Field Summary

Fields

Modifier and Type	Field	Description
protected Configuration.Key<Boolean>	configurationTip	A tip set by subclasses during the execution of some optional tests.
protected final Units	units	Provider of units of measurement (degree, metre, second, etc), never null.
protected final ValidatorContainer	validators	The set of Validator instances to use for verifying objects conformance (never null).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TestCase()	Creates a new test case.

Method Summary

Modifier and Type	Method	Description
Configuration	configuration()	Returns information about the configuration of the test which has been run.
protected final boolean[]	getEnabledFlags(Configuration.Key<Boolean>... properties)	Returns booleans indicating whether the given operations are enabled.

Methods inherited from class java.lang.Object

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

Field Details

units

protected final Units units

Provider of units of measurement (degree, metre, second, etc), never null. The Units.degree(), metre() and other methods shall return Unit instances compatible with the units created by the Factory instances to be tested. Those Unit<?> instances depend on the Unit of Measurement (JSR-373) implementation used by the factories. If no units were explicitly specified, then the default units are used.

Since:

3.1

validators

protected final ValidatorContainer validators

The set of Validator instances to use for verifying objects conformance (never null). If no validators were explicitly specified, then the default validators are used.

Since:

3.1

configurationTip

protected transient Configuration.Key<Boolean> configurationTip

A tip set by subclasses during the execution of some optional tests. In case of optional test failure, if this field is non-null, then a message will be logged at the Level.INFO for giving some tips to the developer about how he can disable the test.

Example

@Test
public void myTest() {
    if (isDerivativeSupported) {
        configurationTip = Configuration.Key.isDerivativeSupported;
        // Do some tests the require support of math transform derivatives.
    }
    configurationTip = null;
}

Since:

3.1

Constructor Details

TestCase

protected TestCase()

Creates a new test case.

Method Details

getEnabledFlags

@SafeVarargs
protected final boolean[] getEnabledFlags(Configuration.Key<Boolean>... properties)

Returns booleans indicating whether the given operations are enabled. By default, every operations are enabled.

Parameters:

properties - the key for which the flags are wanted.

Returns:

an array of the same length as properties in which each element at index i indicates whether the properties[i] test should be enabled.

Since:

3.1

configuration

public Configuration configuration()

Returns information about the configuration of the test which has been run. The content of this map depends on the TestCase subclass. For a description of the map content, see any of the following subclasses:

• AffineTransformTest.configuration()
• ParameterizedTransformTest.configuration()
• AuthorityFactoryTest.configuration()

Returns:

the configuration of the test being run, or an empty map if none. This method returns a modifiable map in order to allow subclasses to modify it.

Since:

3.1