Extension to JUnit assertion methods.
This class inherits all assertion methods from the
by
if they wish to use the assertion methods defined here in addition of JUnit methods.
org.junit.Assert
class.
Consequently, developers can replace the following statement:
import static org.junit.Assert.*;
import static org.opengis.test.Assert.*;
- Since:
- 2.2
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
assertAnyTitleEquals
(String message, String expected, Citation actual) Asserts that the title or an alternate title of the given citation is equal to the given string.static void
assertAxisDirectionsEqual
(String message, CoordinateSystem cs, AxisDirection... expected) Asserts that all axes in the given coordinate system are pointing toward the given directions, in the same order.static void
assertBetween
(String message, double minimum, double maximum, double value) Asserts that the given value is inside the given range.static void
assertBetween
(String message, int minimum, int maximum, int value) Asserts that the given value is inside the given range.static <T> void
assertBetween
(String message, Comparable<T> minimum, Comparable<T> maximum, T value) Asserts that the given value is inside the given range.static void
assertContains
(String message, Collection<?> collection, Object value) Asserts that the given value is contained in the given collection.static void
assertIdentifierEquals
(String message, CharSequence expected, CharSequence value) Deprecated.static void
assertIdentifierEquals
(String message, String authority, String codeSpace, String version, String code, Identifier actual) Asserts that the given identifier is equal to the given authority, code space, version and code.static void
assertInstanceOf
(String message, Class<?> expectedType, Object value) Asserts that the given value is an instance of the given class.static void
assertMatrixEquals
(String message, Matrix expected, Matrix actual, double tolerance) Asserts that the given matrix is equal to the expected one, up to the given tolerance value.static void
assertPathEquals
(String message, PathIterator expected, PathIterator actual, double toleranceX, double toleranceY) Asserts that all control points in two geometric paths are equal.static void
assertPositive
(String message, int value) Asserts that the given integer value is positive, including zero.static void
assertSampleValuesEqual
(String message, RenderedImage expected, RenderedImage actual, double tolerance) Asserts that all sample values in the given images are equal.static void
assertShapeEquals
(String message, Shape expected, Shape actual, double toleranceX, double toleranceY) Asserts that all control points of two shapes are equal.static void
assertStrictlyPositive
(String message, int value) Asserts that the given integer value is strictly positive, excluding zero.static void
assertUnicodeIdentifierEquals
(String message, CharSequence expected, CharSequence actual, boolean ignoreCase) Asserts that the character sequences are equal, ignoring any characters that are not valid for Unicode identifiers.static void
assertValidRange
(String message, double minimum, double maximum) Asserts that the given minimum is smaller or equals to the given maximum.static void
assertValidRange
(String message, int minimum, int maximum) Asserts that the given minimum is smaller or equals to the given maximum.static <T> void
assertValidRange
(String message, Comparable<T> minimum, Comparable<T> maximum) Asserts that the given minimum and maximum values make a valid range.Methods inherited from class Assert
assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertThrows, assertThrows, assertTrue, assertTrue, fail, fail
-
Constructor Details
-
Assert
protected Assert()For subclass constructors only.
-
-
Method Details
-
assertInstanceOf
Asserts that the given value is an instance of the given class. No tests are performed if the type isnull
. If the type is not-null but the value is null, this is considered as a failure.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expectedType
- the expected parent class of the value, ornull
if unrestricted.value
- the value to test, ornull
(which is a failure).
-
assertPositive
Asserts that the given integer value is positive, including zero.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.value
- The value to test.
-
assertStrictlyPositive
Asserts that the given integer value is strictly positive, excluding zero.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.value
- the value to test.
-
assertValidRange
public static <T> void assertValidRange(String message, Comparable<T> minimum, Comparable<T> maximum) Asserts that the given minimum and maximum values make a valid range. More specifically asserts that if both values are non-null, then the minimum value is not greater than the maximum value.- Type Parameters:
T
- the type of values being compared.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.minimum
- the lower bound of the range to test, ornull
if unbounded.maximum
- the upper bound of the range to test, ornull
if unbounded.
-
assertValidRange
Asserts that the given minimum is smaller or equals to the given maximum.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.minimum
- the lower bound of the range to test.maximum
- the upper bound of the range to test.
-
assertValidRange
Asserts that the given minimum is smaller or equals to the given maximum. If one bound is or both bounds are NaN, then the test fails.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.minimum
- the lower bound of the range to test.maximum
- the upper bound of the range to test.
-
assertBetween
public static <T> void assertBetween(String message, Comparable<T> minimum, Comparable<T> maximum, T value) Asserts that the given value is inside the given range. This method does not test the validity of the given [minimum
…maximum
] range.- Type Parameters:
T
- the type of values being compared.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.minimum
- the lower bound of the range (inclusive), ornull
if unbounded.maximum
- the upper bound of the range (inclusive), ornull
if unbounded.value
- the value to test, ornull
(which is a failure).
-
assertBetween
Asserts that the given value is inside the given range. This method does not test the validity of the given [minimum
…maximum
] range.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.minimum
- the lower bound of the range, inclusive.maximum
- the upper bound of the range, inclusive.value
- the value to test.
-
assertBetween
Asserts that the given value is inside the given range. If the givenvalue
is NaN, then this test passes silently. This method does not test the validity of the given [minimum
…maximum
] range.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.minimum
- the lower bound of the range, inclusive.maximum
- the upper bound of the range, inclusive.value
- the value to test.
-
assertContains
Asserts that the given value is contained in the given collection. If the given collection is null, then this test passes silently (a null collection is considered as "unknown", not empty). If the given value is null, then the test passes only if the given collection contains the null element.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.collection
- the collection where to look for inclusion, ornull
if unrestricted.value
- the value to test for inclusion.
-
assertAnyTitleEquals
Asserts that the title or an alternate title of the given citation is equal to the given string. This method is typically used for testing if a citation stands for the OGC, OGP or EPSG authority for instance. Such abbreviations are often declared as alternate titles rather than the main title, but this method tests both for safety.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expected
- the expected title or alternate title.actual
- the citation to test.- Since:
- 3.1
-
assertIdentifierEquals
public static void assertIdentifierEquals(String message, String authority, String codeSpace, String version, String code, Identifier actual) Asserts that the given identifier is equal to the given authority, code space, version and code. If any of the above-cited properties is""##unrestricted"
, then it will not be verified. This flexibility is useful in the common case where a test accepts anyversion
value.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.authority
- the expected authority title or alternate title (may benull
), or"##unrestricted"
.codeSpace
- the expected code space (may benull
), or"##unrestricted"
.version
- the expected version (may benull
), or"##unrestricted"
.code
- the expected code value (may benull
), or"##unrestricted"
.actual
- the identifier to test.- Since:
- 3.1
-
assertIdentifierEquals
@Deprecated public static void assertIdentifierEquals(String message, CharSequence expected, CharSequence value) Deprecated.RenamedassertUnicodeIdentifierEquals(String, CharSequence, CharSequence, boolean)
for avoiding confusion with theIdentifier
interface.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expected
- the expected character sequence.value
- the character sequence to compare.
-
assertUnicodeIdentifierEquals
public static void assertUnicodeIdentifierEquals(String message, CharSequence expected, CharSequence actual, boolean ignoreCase) Asserts that the character sequences are equal, ignoring any characters that are not valid for Unicode identifiers. First, this method locates the Unicode identifier start in each sequences, ignoring any other characters before them. Then, starting from the identifier starts, this method compares only the Unicode identifier parts until the end of character sequences.Examples:
"WGS 84"
and"WGS84"
as equal according this method.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expected
- the expected character sequence (may benull
), or"##unrestricted"
.actual
- the character sequence to compare, ornull
.ignoreCase
-true
for ignoring case.- Since:
- 3.1
-
assertAxisDirectionsEqual
public static void assertAxisDirectionsEqual(String message, CoordinateSystem cs, AxisDirection... expected) Asserts that all axes in the given coordinate system are pointing toward the given directions, in the same order.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.cs
- the coordinate system to test.expected
- the expected axis directions.- Since:
- 3.1
-
assertMatrixEquals
public static void assertMatrixEquals(String message, Matrix expected, Matrix actual, double tolerance) Asserts that the given matrix is equal to the expected one, up to the given tolerance value.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expected
- the expected matrix, which may benull
.actual
- the matrix to compare, ornull
.tolerance
- the tolerance threshold.- Since:
- 3.1
- See Also:
-
assertShapeEquals
public static void assertShapeEquals(String message, Shape expected, Shape actual, double toleranceX, double toleranceY) Asserts that all control points of two shapes are equal. This method performs the following checks:- Ensures that the shape bounds are equal, up to the given tolerance thresholds.
- Gets the path iterator of each shape.
- Ensures that the winding rules are equal.
- Iterates over all path segments until the iteration is done.
For each iteration step:
- Invokes
PathIterator.currentSegment(double[])
. - Ensures that the segment type (one of the
SEG_*
constants) is the same. - Ensures that the coordinate values are equal, up to the given tolerance thresholds.
- Invokes
- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expected
- the expected shape, which may benull
.actual
- the actual shape, ornull
.toleranceX
- the tolerance threshold for x coordinate values.toleranceY
- the tolerance threshold for y coordinate values.- Since:
- 3.1
-
assertPathEquals
public static void assertPathEquals(String message, PathIterator expected, PathIterator actual, double toleranceX, double toleranceY) Asserts that all control points in two geometric paths are equal. This method performs the following checks:- Ensures that the winding rules are equal.
- Iterates over all path segments until the iteration is done.
For each iteration step:
- Invokes
PathIterator.currentSegment(double[])
. - Ensures that the segment type (one of the
SEG_*
constants) is the same. - Ensures that the coordinate values are equal, up to the given tolerance thresholds.
- Invokes
assertShapeEquals(String, Shape, Shape, double, double)
when the tester needs to compare the shapes with a non-null affine transform or a flatness factor. in such case, the tester needs to invoke theShape.getPathIterator(AffineTransform, double)
method himself.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expected
- the expected path, which may benull
.actual
- the actual path, ornull
.toleranceX
- the tolerance threshold for x coordinate values.toleranceY
- the tolerance threshold for y coordinate values.- Since:
- 3.1
-
assertSampleValuesEqual
public static void assertSampleValuesEqual(String message, RenderedImage expected, RenderedImage actual, double tolerance) Asserts that all sample values in the given images are equal. This method requires the images width, height and the number of bands to be equal, but does not require the tiling, color model or datatype to be equal.- Parameters:
message
- header of the exception message in case of failure, ornull
if none.expected
- an image containing the expected values, which may benull
.actual
- the actual image containing the sample values to compare, ornull
.tolerance
- tolerance threshold for floating point comparisons. This threshold is ignored if both images use integer datatype.- Since:
- 3.1
- See Also:
-
assertUnicodeIdentifierEquals(String, CharSequence, CharSequence, boolean)
for avoiding confusion with theIdentifier
interface.