@API(status=STABLE,
since="5.0")
public final class Assertions
extends java.lang.Object
Assertions is a collection of utility methods that support asserting
conditions in tests.
Unless otherwise noted, a failed assertion will throw an
AssertionFailedError or a subclass thereof.
AssertionFailedError,
Assumptions| Modifier and Type | Method and Description |
|---|---|
static void |
assertAll(Executable... executables)
Asserts that all supplied
executables do not throw
exceptions. |
static void |
assertAll(java.util.stream.Stream<Executable> executables)
Asserts that all supplied
executables do not throw
exceptions. |
static void |
assertAll(java.lang.String heading,
Executable... executables)
Asserts that all supplied
executables do not throw
exceptions. |
static void |
assertAll(java.lang.String heading,
java.util.stream.Stream<Executable> executables)
Asserts that all supplied
executables do not throw
exceptions. |
static void |
assertArrayEquals(boolean[] expected,
boolean[] actual)
Asserts that
expected and actual boolean arrays are equal. |
static void |
assertArrayEquals(boolean[] expected,
boolean[] actual,
java.lang.String message)
Asserts that
expected and actual boolean arrays are equal. |
static void |
assertArrayEquals(boolean[] expected,
boolean[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual boolean arrays are equal. |
static void |
assertArrayEquals(byte[] expected,
byte[] actual)
Asserts that
expected and actual byte arrays are equal. |
static void |
assertArrayEquals(byte[] expected,
byte[] actual,
java.lang.String message)
Asserts that
expected and actual byte arrays are equal. |
static void |
assertArrayEquals(byte[] expected,
byte[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual byte arrays are equal. |
static void |
assertArrayEquals(char[] expected,
char[] actual)
Asserts that
expected and actual char arrays are equal. |
static void |
assertArrayEquals(char[] expected,
char[] actual,
java.lang.String message)
Asserts that
expected and actual char arrays are equal. |
static void |
assertArrayEquals(char[] expected,
char[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual char arrays are equal. |
static void |
assertArrayEquals(double[] expected,
double[] actual)
Asserts that
expected and actual double arrays are equal. |
static void |
assertArrayEquals(double[] expected,
double[] actual,
double delta)
Asserts that
expected and actual double arrays are equal within the given delta. |
static void |
assertArrayEquals(double[] expected,
double[] actual,
double delta,
java.lang.String message)
Asserts that
expected and actual double arrays are equal within the given delta. |
static void |
assertArrayEquals(double[] expected,
double[] actual,
double delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual double arrays are equal within the given delta. |
static void |
assertArrayEquals(double[] expected,
double[] actual,
java.lang.String message)
Asserts that
expected and actual double arrays are equal. |
static void |
assertArrayEquals(double[] expected,
double[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual double arrays are equal. |
static void |
assertArrayEquals(float[] expected,
float[] actual)
Asserts that
expected and actual float arrays are equal. |
static void |
assertArrayEquals(float[] expected,
float[] actual,
float delta)
Asserts that
expected and actual float arrays are equal within the given delta. |
static void |
assertArrayEquals(float[] expected,
float[] actual,
float delta,
java.lang.String message)
Asserts that
expected and actual float arrays are equal within the given delta. |
static void |
assertArrayEquals(float[] expected,
float[] actual,
float delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual float arrays are equal within the given delta. |
static void |
assertArrayEquals(float[] expected,
float[] actual,
java.lang.String message)
Asserts that
expected and actual float arrays are equal. |
static void |
assertArrayEquals(float[] expected,
float[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual float arrays are equal. |
static void |
assertArrayEquals(int[] expected,
int[] actual)
Asserts that
expected and actual int arrays are equal. |
static void |
assertArrayEquals(int[] expected,
int[] actual,
java.lang.String message)
Asserts that
expected and actual int arrays are equal. |
static void |
assertArrayEquals(int[] expected,
int[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual int arrays are equal. |
static void |
assertArrayEquals(long[] expected,
long[] actual)
Asserts that
expected and actual long arrays are equal. |
static void |
assertArrayEquals(long[] expected,
long[] actual,
java.lang.String message)
Asserts that
expected and actual long arrays are equal. |
static void |
assertArrayEquals(long[] expected,
long[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual long arrays are equal. |
static void |
assertArrayEquals(java.lang.Object[] expected,
java.lang.Object[] actual)
Asserts that
expected and actual object arrays are deeply equal. |
static void |
assertArrayEquals(java.lang.Object[] expected,
java.lang.Object[] actual,
java.lang.String message)
Asserts that
expected and actual object arrays are deeply equal. |
static void |
assertArrayEquals(java.lang.Object[] expected,
java.lang.Object[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual object arrays are deeply equal. |
static void |
assertArrayEquals(short[] expected,
short[] actual)
Asserts that
expected and actual short arrays are equal. |
static void |
assertArrayEquals(short[] expected,
short[] actual,
java.lang.String message)
Asserts that
expected and actual short arrays are equal. |
static void |
assertArrayEquals(short[] expected,
short[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual short arrays are equal. |
static void |
assertEquals(byte expected,
byte actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(byte expected,
byte actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(byte expected,
byte actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertEquals(char expected,
char actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(char expected,
char actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(char expected,
char actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertEquals(double expected,
double actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(double expected,
double actual,
double delta)
Asserts that
expected and actual are equal within the given delta. |
static void |
assertEquals(double expected,
double actual,
double delta,
java.lang.String message)
Asserts that
expected and actual are equal within the given delta. |
static void |
assertEquals(double expected,
double actual,
double delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal within the given delta. |
static void |
assertEquals(double expected,
double actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(double expected,
double actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertEquals(float expected,
float actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(float expected,
float actual,
float delta)
Asserts that
expected and actual are equal within the given delta. |
static void |
assertEquals(float expected,
float actual,
float delta,
java.lang.String message)
Asserts that
expected and actual are equal within the given delta. |
static void |
assertEquals(float expected,
float actual,
float delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal within the given delta. |
static void |
assertEquals(float expected,
float actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(float expected,
float actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertEquals(int expected,
int actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(int expected,
int actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(int expected,
int actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertEquals(long expected,
long actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(long expected,
long actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(long expected,
long actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertEquals(java.lang.Object expected,
java.lang.Object actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(java.lang.Object expected,
java.lang.Object actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(java.lang.Object expected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertEquals(short expected,
short actual)
Asserts that
expected and actual are equal. |
static void |
assertEquals(short expected,
short actual,
java.lang.String message)
Asserts that
expected and actual are equal. |
static void |
assertEquals(short expected,
short actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are equal. |
static void |
assertFalse(boolean condition)
Asserts that the supplied
condition is not true. |
static void |
assertFalse(boolean condition,
java.lang.String message)
Asserts that the supplied
condition is not true. |
static void |
assertFalse(java.util.function.BooleanSupplier booleanSupplier)
Asserts that the boolean condition supplied by
booleanSupplier is not true. |
static void |
assertFalse(boolean condition,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that the supplied
condition is not true. |
static void |
assertFalse(java.util.function.BooleanSupplier booleanSupplier,
java.lang.String message)
Asserts that the boolean condition supplied by
booleanSupplier is not true. |
static void |
assertFalse(java.util.function.BooleanSupplier booleanSupplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that the boolean condition supplied by
booleanSupplier is not true. |
static void |
assertIterableEquals(java.lang.Iterable<?> expected,
java.lang.Iterable<?> actual)
Asserts that
expected and actual iterables are deeply equal. |
static void |
assertIterableEquals(java.lang.Iterable<?> expected,
java.lang.Iterable<?> actual,
java.lang.String message)
Asserts that
expected and actual iterables are deeply equal. |
static void |
assertIterableEquals(java.lang.Iterable<?> expected,
java.lang.Iterable<?> actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual iterables are deeply equal. |
static void |
assertLinesMatch(java.util.List<java.lang.String> expectedLines,
java.util.List<java.lang.String> actualLines)
Asserts that
expected list of Strings matches actual
list. |
static void |
assertNotEquals(java.lang.Object unexpected,
java.lang.Object actual)
Asserts that
expected and actual are not equal. |
static void |
assertNotEquals(java.lang.Object unexpected,
java.lang.Object actual,
java.lang.String message)
Asserts that
expected and actual are not equal. |
static void |
assertNotEquals(java.lang.Object unexpected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual are not equal. |
static void |
assertNotNull(java.lang.Object actual)
Asserts that
actual is not null. |
static void |
assertNotNull(java.lang.Object actual,
java.lang.String message)
Asserts that
actual is not null. |
static void |
assertNotNull(java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
actual is not null. |
static void |
assertNotSame(java.lang.Object unexpected,
java.lang.Object actual)
Asserts that
expected and actual do not refer to the same object. |
static void |
assertNotSame(java.lang.Object unexpected,
java.lang.Object actual,
java.lang.String message)
Asserts that
expected and actual do not refer to the same object. |
static void |
assertNotSame(java.lang.Object unexpected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual do not refer to the same object. |
static void |
assertNull(java.lang.Object actual)
Asserts that
actual is null. |
static void |
assertNull(java.lang.Object actual,
java.lang.String message)
Asserts that
actual is null. |
static void |
assertNull(java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
actual is null. |
static void |
assertSame(java.lang.Object expected,
java.lang.Object actual)
Asserts that
expected and actual refer to the same object. |
static void |
assertSame(java.lang.Object expected,
java.lang.Object actual,
java.lang.String message)
Asserts that
expected and actual refer to the same object. |
static void |
assertSame(java.lang.Object expected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that
expected and actual refer to the same object. |
static <T extends java.lang.Throwable> |
assertThrows(java.lang.Class<T> expectedType,
Executable executable)
Asserts that execution of the supplied
executable throws
an exception of the expectedType and returns the exception. |
static <T extends java.lang.Throwable> |
assertThrows(java.lang.Class<T> expectedType,
Executable executable,
java.lang.String message)
Asserts that execution of the supplied
executable throws
an exception of the expectedType and returns the exception. |
static <T extends java.lang.Throwable> |
assertThrows(java.lang.Class<T> expectedType,
Executable executable,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that execution of the supplied
executable throws
an exception of the expectedType and returns the exception. |
static void |
assertTimeout(java.time.Duration timeout,
Executable executable)
Asserts that execution of the supplied
executable
completes before the given timeout is exceeded. |
static void |
assertTimeout(java.time.Duration timeout,
Executable executable,
java.lang.String message)
Asserts that execution of the supplied
executable
completes before the given timeout is exceeded. |
static void |
assertTimeout(java.time.Duration timeout,
Executable executable,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that execution of the supplied
executable
completes before the given timeout is exceeded. |
static <T> T |
assertTimeout(java.time.Duration timeout,
ThrowingSupplier<T> supplier)
Asserts that execution of the supplied
supplier
completes before the given timeout is exceeded. |
static <T> T |
assertTimeout(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.lang.String message)
Asserts that execution of the supplied
supplier
completes before the given timeout is exceeded. |
static <T> T |
assertTimeout(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that execution of the supplied
supplier
completes before the given timeout is exceeded. |
static void |
assertTimeoutPreemptively(java.time.Duration timeout,
Executable executable)
Asserts that execution of the supplied
executable
completes before the given timeout is exceeded. |
static void |
assertTimeoutPreemptively(java.time.Duration timeout,
Executable executable,
java.lang.String message)
Asserts that execution of the supplied
executable
completes before the given timeout is exceeded. |
static void |
assertTimeoutPreemptively(java.time.Duration timeout,
Executable executable,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that execution of the supplied
executable
completes before the given timeout is exceeded. |
static <T> T |
assertTimeoutPreemptively(java.time.Duration timeout,
ThrowingSupplier<T> supplier)
Asserts that execution of the supplied
supplier
completes before the given timeout is exceeded. |
static <T> T |
assertTimeoutPreemptively(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.lang.String message)
Asserts that execution of the supplied
supplier
completes before the given timeout is exceeded. |
static <T> T |
assertTimeoutPreemptively(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that execution of the supplied
supplier
completes before the given timeout is exceeded. |
static void |
assertTrue(boolean condition)
Asserts that the supplied
condition is true. |
static void |
assertTrue(boolean condition,
java.lang.String message)
Asserts that the supplied
condition is true. |
static void |
assertTrue(java.util.function.BooleanSupplier booleanSupplier)
Asserts that the boolean condition supplied by
booleanSupplier is true. |
static void |
assertTrue(boolean condition,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that the supplied
condition is true. |
static void |
assertTrue(java.util.function.BooleanSupplier booleanSupplier,
java.lang.String message)
Asserts that the boolean condition supplied by
booleanSupplier is true. |
static void |
assertTrue(java.util.function.BooleanSupplier booleanSupplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
Asserts that the boolean condition supplied by
booleanSupplier is true. |
static <V> V |
fail(java.lang.String message)
Fails a test with the given failure
message. |
static <V> V |
fail(java.lang.String message,
java.lang.Throwable cause)
Fails a test with the given failure
message as well
as the underlying cause. |
static <V> V |
fail(java.util.function.Supplier<java.lang.String> messageSupplier)
Fails a test with the failure message retrieved from the
given
messageSupplier. |
static <V> V |
fail(java.lang.Throwable cause)
Fails a test with the given underlying
cause. |
public static <V> V fail(java.lang.String message)
message.
See Javadoc for fail(String, Throwable) for an explanation of
this method's generic return type V.
public static <V> V fail(java.lang.String message,
java.lang.Throwable cause)
message as well
as the underlying cause.
The generic return type V allows this method to be used
directly as a single-statement lambda expression, thereby avoiding the
need to implement a code block with an explicit return value. Since this
method throws an AssertionFailedError before its
return statement, this method never actually returns a value to its caller.
The following example demonstrates how this may be used in practice.
Stream.of().map(entry -> fail("should not be called"));
public static <V> V fail(java.lang.Throwable cause)
cause.
See Javadoc for fail(String, Throwable) for an explanation of
this method's generic return type V.
public static <V> V fail(java.util.function.Supplier<java.lang.String> messageSupplier)
messageSupplier.
See Javadoc for fail(String, Throwable) for an explanation of
this method's generic return type V.
public static void assertTrue(boolean condition)
condition is true.public static void assertTrue(boolean condition,
java.util.function.Supplier<java.lang.String> messageSupplier)
condition is true.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertTrue(java.util.function.BooleanSupplier booleanSupplier)
booleanSupplier is true.public static void assertTrue(java.util.function.BooleanSupplier booleanSupplier,
java.lang.String message)
booleanSupplier is true.
Fails with the supplied failure message.
public static void assertTrue(boolean condition,
java.lang.String message)
condition is true.
Fails with the supplied failure message.
public static void assertTrue(java.util.function.BooleanSupplier booleanSupplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
booleanSupplier is true.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertFalse(boolean condition)
condition is not true.public static void assertFalse(boolean condition,
java.lang.String message)
condition is not true.
Fails with the supplied failure message.
public static void assertFalse(boolean condition,
java.util.function.Supplier<java.lang.String> messageSupplier)
condition is not true.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertFalse(java.util.function.BooleanSupplier booleanSupplier)
booleanSupplier is not true.public static void assertFalse(java.util.function.BooleanSupplier booleanSupplier,
java.lang.String message)
booleanSupplier is not true.
Fails with the supplied failure message.
public static void assertFalse(java.util.function.BooleanSupplier booleanSupplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
booleanSupplier is not true.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertNull(java.lang.Object actual)
actual is null.public static void assertNull(java.lang.Object actual,
java.lang.String message)
actual is null.
Fails with the supplied failure message.
public static void assertNull(java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
actual is null.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertNotNull(java.lang.Object actual)
actual is not null.public static void assertNotNull(java.lang.Object actual,
java.lang.String message)
actual is not null.
Fails with the supplied failure message.
public static void assertNotNull(java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
actual is not null.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(short expected,
short actual)
expected and actual are equal.public static void assertEquals(short expected,
short actual,
java.lang.String message)
expected and actual are equal.public static void assertEquals(short expected,
short actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(byte expected,
byte actual)
expected and actual are equal.public static void assertEquals(byte expected,
byte actual,
java.lang.String message)
expected and actual are equal.public static void assertEquals(byte expected,
byte actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(int expected,
int actual)
expected and actual are equal.public static void assertEquals(int expected,
int actual,
java.lang.String message)
expected and actual are equal.public static void assertEquals(int expected,
int actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(long expected,
long actual)
expected and actual are equal.public static void assertEquals(long expected,
long actual,
java.lang.String message)
expected and actual are equal.public static void assertEquals(long expected,
long actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(char expected,
char actual)
expected and actual are equal.public static void assertEquals(char expected,
char actual,
java.lang.String message)
expected and actual are equal.public static void assertEquals(char expected,
char actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(float expected,
float actual)
expected and actual are equal.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
public static void assertEquals(float expected,
float actual,
java.lang.String message)
expected and actual are equal.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
public static void assertEquals(float expected,
float actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(float expected,
float actual,
float delta)
expected and actual are equal within the given delta.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
public static void assertEquals(float expected,
float actual,
float delta,
java.lang.String message)
expected and actual are equal within the given delta.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
public static void assertEquals(float expected,
float actual,
float delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal within the given delta.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(double expected,
double actual)
expected and actual are equal.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
public static void assertEquals(double expected,
double actual,
java.lang.String message)
expected and actual are equal.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
public static void assertEquals(double expected,
double actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(double expected,
double actual,
double delta)
expected and actual are equal within the given delta.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
public static void assertEquals(double expected,
double actual,
double delta,
java.lang.String message)
expected and actual are equal within the given delta.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
public static void assertEquals(double expected,
double actual,
double delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal within the given delta.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertEquals(java.lang.Object expected,
java.lang.Object actual)
expected and actual are equal.
If both are null, they are considered equal.
Object.equals(Object)public static void assertEquals(java.lang.Object expected,
java.lang.Object actual,
java.lang.String message)
expected and actual are equal.
If both are null, they are considered equal.
Fails with the supplied failure message.
Object.equals(Object)public static void assertEquals(java.lang.Object expected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are equal.
If both are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
Object.equals(Object)public static void assertArrayEquals(boolean[] expected,
boolean[] actual)
expected and actual boolean arrays are equal.
If both are null, they are considered equal.
public static void assertArrayEquals(boolean[] expected,
boolean[] actual,
java.lang.String message)
expected and actual boolean arrays are equal.
If both are null, they are considered equal.
Fails with the supplied failure message.
public static void assertArrayEquals(boolean[] expected,
boolean[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual boolean arrays are equal.
If both are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(char[] expected,
char[] actual)
expected and actual char arrays are equal.
If both are null, they are considered equal.
public static void assertArrayEquals(char[] expected,
char[] actual,
java.lang.String message)
expected and actual char arrays are equal.
If both are null, they are considered equal.
Fails with the supplied failure message.
public static void assertArrayEquals(char[] expected,
char[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual char arrays are equal.
If both are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(byte[] expected,
byte[] actual)
expected and actual byte arrays are equal.
If both are null, they are considered equal.
public static void assertArrayEquals(byte[] expected,
byte[] actual,
java.lang.String message)
expected and actual byte arrays are equal.
If both are null, they are considered equal.
Fails with the supplied failure message.
public static void assertArrayEquals(byte[] expected,
byte[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual byte arrays are equal.
If both are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(short[] expected,
short[] actual)
expected and actual short arrays are equal.
If both are null, they are considered equal.
public static void assertArrayEquals(short[] expected,
short[] actual,
java.lang.String message)
expected and actual short arrays are equal.
If both are null, they are considered equal.
Fails with the supplied failure message.
public static void assertArrayEquals(short[] expected,
short[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual short arrays are equal.
If both are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(int[] expected,
int[] actual)
expected and actual int arrays are equal.
If both are null, they are considered equal.
public static void assertArrayEquals(int[] expected,
int[] actual,
java.lang.String message)
expected and actual int arrays are equal.
If both are null, they are considered equal.
Fails with the supplied failure message.
public static void assertArrayEquals(int[] expected,
int[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual int arrays are equal.
If both are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(long[] expected,
long[] actual)
expected and actual long arrays are equal.
If both are null, they are considered equal.
public static void assertArrayEquals(long[] expected,
long[] actual,
java.lang.String message)
expected and actual long arrays are equal.
If both are null, they are considered equal.
Fails with the supplied failure message.
public static void assertArrayEquals(long[] expected,
long[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual long arrays are equal.
If both are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(float[] expected,
float[] actual)
expected and actual float arrays are equal.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
public static void assertArrayEquals(float[] expected,
float[] actual,
java.lang.String message)
expected and actual float arrays are equal.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
Fails with the supplied failure message.
public static void assertArrayEquals(float[] expected,
float[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual float arrays are equal.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(float[] expected,
float[] actual,
float delta)
expected and actual float arrays are equal within the given delta.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
public static void assertArrayEquals(float[] expected,
float[] actual,
float delta,
java.lang.String message)
expected and actual float arrays are equal within the given delta.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
Fails with the supplied failure message.
public static void assertArrayEquals(float[] expected,
float[] actual,
float delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual float arrays are equal within the given delta.
Equality imposed by this method is consistent with Float.equals(Object) and
Float.compare(float, float).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(double[] expected,
double[] actual)
expected and actual double arrays are equal.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
public static void assertArrayEquals(double[] expected,
double[] actual,
java.lang.String message)
expected and actual double arrays are equal.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
Fails with the supplied failure message.
public static void assertArrayEquals(double[] expected,
double[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual double arrays are equal.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(double[] expected,
double[] actual,
double delta)
expected and actual double arrays are equal within the given delta.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
public static void assertArrayEquals(double[] expected,
double[] actual,
double delta,
java.lang.String message)
expected and actual double arrays are equal within the given delta.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
Fails with the supplied failure message.
public static void assertArrayEquals(double[] expected,
double[] actual,
double delta,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual double arrays are equal within the given delta.
Equality imposed by this method is consistent with Double.equals(Object) and
Double.compare(double, double).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertArrayEquals(java.lang.Object[] expected,
java.lang.Object[] actual)
expected and actual object arrays are deeply equal.
If both are null, they are considered equal.
Nested float arrays are checked as in assertEquals(float, float).
Nested double arrays are checked as in assertEquals(double, double).
Objects.equals(Object, Object),
Arrays.deepEquals(Object[], Object[])public static void assertArrayEquals(java.lang.Object[] expected,
java.lang.Object[] actual,
java.lang.String message)
expected and actual object arrays are deeply equal.
If both are null, they are considered equal.
Nested float arrays are checked as in assertEquals(float, float).
Nested double arrays are checked as in assertEquals(double, double).
Fails with the supplied failure message.
Objects.equals(Object, Object),
Arrays.deepEquals(Object[], Object[])public static void assertArrayEquals(java.lang.Object[] expected,
java.lang.Object[] actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual object arrays are deeply equal.
If both are null, they are considered equal.
Nested float arrays are checked as in assertEquals(float, float).
Nested double arrays are checked as in assertEquals(double, double).
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
Objects.equals(Object, Object),
Arrays.deepEquals(Object[], Object[])public static void assertIterableEquals(java.lang.Iterable<?> expected,
java.lang.Iterable<?> actual)
expected and actual iterables are deeply equal.
Similarly to the check for deep equality in assertArrayEquals(Object[], Object[]),
if two iterables are encountered (including expected and actual) then their
iterators must return equal elements in the same order as each other. Note:
this means that the iterables do not need to be of the same type. Example:
import static java.util.Arrays.asList;
. . .
Iterable<Integer> i0 = new ArrayList<>(asList(1, 2, 3));
Iterable<Integer> i1 = new LinkedList<>(asList(1, 2, 3));
assertIterableEquals(i0, i1); // Passes
If both expected and actual are null, they are considered equal.
Objects.equals(Object, Object),
Arrays.deepEquals(Object[], Object[]),
assertArrayEquals(Object[], Object[])public static void assertIterableEquals(java.lang.Iterable<?> expected,
java.lang.Iterable<?> actual,
java.lang.String message)
expected and actual iterables are deeply equal.
Similarly to the check for deep equality in
assertArrayEquals(Object[], Object[], String), if two iterables are encountered
(including expected and actual) then their iterators must return equal
elements in the same order as each other. Note: this means that the iterables
do not need to be of the same type. Example:
import static java.util.Arrays.asList;
. . .
Iterable<Integer> i0 = new ArrayList<>(asList(1, 2, 3));
Iterable<Integer> i1 = new LinkedList<>(asList(1, 2, 3));
assertIterableEquals(i0, i1); // Passes
If both expected and actual are null, they are considered equal.
Fails with the supplied failure message.
Objects.equals(Object, Object),
Arrays.deepEquals(Object[], Object[]),
assertArrayEquals(Object[], Object[], String)public static void assertIterableEquals(java.lang.Iterable<?> expected,
java.lang.Iterable<?> actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual iterables are deeply equal.
Similarly to the check for deep equality in
assertArrayEquals(Object[], Object[], Supplier), if two iterables are encountered
(including expected and actual) then their iterators must return equal
elements in the same order as each other. Note: this means that the iterables
do not need to be of the same type. Example:
import static java.util.Arrays.asList;
. . .
Iterable<Integer> i0 = new ArrayList<>(asList(1, 2, 3));
Iterable<Integer> i1 = new LinkedList<>(asList(1, 2, 3));
assertIterableEquals(i0, i1); // Passes
If both expected and actual are null, they are considered equal.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
Objects.equals(Object, Object),
Arrays.deepEquals(Object[], Object[]),
assertArrayEquals(Object[], Object[], Supplier)public static void assertLinesMatch(java.util.List<java.lang.String> expectedLines,
java.util.List<java.lang.String> actualLines)
expected list of Strings matches actual
list.
This method differs from other assertions that effectively only check String.equals(Object),
in that it uses the following staged matching algorithm:
For each pair of expected and actual lines do
expected.equals(actual) - if yes, continue with next pairexpected as a regular expression and check via
String.matches(String) - if yes, continue with next pairexpected line is a fast-forward marker, if yes apply
fast-forward actual lines accordingly (see below) and goto 1.A valid fast-forward marker is an expected line that starts and ends with the literal
>> and contains at least 4 characters. Examples:
>>>>>> stacktrace >>>> single line, non Integer.parse()-able comment >>
">> 21 >>"
Example showing all three kinds of expected line formats:
│ │ │ caught: AssertionFailedError: single line fail message
>> S T A C K T R A C E >>
│ │ │ duration: [\d]+ ms
│ │ │ status: ✘ FAILED
│ └─ test() finished after [\d]+ ms\.
└─ JUnit Jupiter finished after [\d]+ ms\.
Test plan execution finished. Number of all tests: 1
Test run finished after [\d]+ ms
public static void assertNotEquals(java.lang.Object unexpected,
java.lang.Object actual)
expected and actual are not equal.
Fails if both are null.
Object.equals(Object)public static void assertNotEquals(java.lang.Object unexpected,
java.lang.Object actual,
java.lang.String message)
expected and actual are not equal.
Fails if both are null.
Fails with the supplied failure message.
Object.equals(Object)public static void assertNotEquals(java.lang.Object unexpected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual are not equal.
Fails if both are null.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
Object.equals(Object)public static void assertSame(java.lang.Object expected,
java.lang.Object actual)
expected and actual refer to the same object.public static void assertSame(java.lang.Object expected,
java.lang.Object actual,
java.lang.String message)
expected and actual refer to the same object.
Fails with the supplied failure message.
public static void assertSame(java.lang.Object expected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual refer to the same object.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertNotSame(java.lang.Object unexpected,
java.lang.Object actual)
expected and actual do not refer to the same object.public static void assertNotSame(java.lang.Object unexpected,
java.lang.Object actual,
java.lang.String message)
expected and actual do not refer to the same object.
Fails with the supplied failure message.
public static void assertNotSame(java.lang.Object unexpected,
java.lang.Object actual,
java.util.function.Supplier<java.lang.String> messageSupplier)
expected and actual do not refer to the same object.
If necessary, the failure message will be retrieved lazily from the supplied messageSupplier.
public static void assertAll(Executable... executables) throws org.opentest4j.MultipleFailuresError
executables do not throw
exceptions.
See Javadoc for assertAll(String, Stream) for an explanation of this
method's exception handling semantics.
org.opentest4j.MultipleFailuresErrorassertAll(String, Executable...),
assertAll(Stream),
assertAll(String, Stream)public static void assertAll(java.util.stream.Stream<Executable> executables) throws org.opentest4j.MultipleFailuresError
executables do not throw
exceptions.
See Javadoc for assertAll(String, Stream) for an explanation of this
method's exception handling semantics.
org.opentest4j.MultipleFailuresErrorassertAll(Executable...),
assertAll(String, Executable...),
assertAll(String, Stream)public static void assertAll(java.lang.String heading,
Executable... executables)
throws org.opentest4j.MultipleFailuresError
executables do not throw
exceptions.
See Javadoc for assertAll(String, Stream) for an explanation of this
method's exception handling semantics.
org.opentest4j.MultipleFailuresErrorassertAll(Executable...),
assertAll(Stream),
assertAll(String, Stream)public static void assertAll(java.lang.String heading,
java.util.stream.Stream<Executable> executables)
throws org.opentest4j.MultipleFailuresError
executables do not throw
exceptions.
If any supplied Executable throws an exception (i.e., a Throwable
or any subclass thereof), all remaining executables will still be executed,
and all exceptions will be aggregated and reported in a MultipleFailuresError.
However, if an executable throws a blacklisted exception — for
example, an OutOfMemoryError — execution will halt immediately, and the
blacklisted exception will be rethrown as is but masked as an
unchecked exception.
The supplied heading will be included in the message string for the
MultipleFailuresError.
org.opentest4j.MultipleFailuresErrorassertAll(Executable...),
assertAll(String, Executable...),
assertAll(Stream)public static <T extends java.lang.Throwable> T assertThrows(java.lang.Class<T> expectedType,
Executable executable)
executable throws
an exception of the expectedType and returns the exception.
If no exception is thrown, or if an exception of a different type is thrown, this method will fail.
If you do not want to perform additional checks on the exception instance, simply ignore the return value.
public static <T extends java.lang.Throwable> T assertThrows(java.lang.Class<T> expectedType,
Executable executable,
java.lang.String message)
executable throws
an exception of the expectedType and returns the exception.
If no exception is thrown, or if an exception of a different type is thrown, this method will fail.
If you do not want to perform additional checks on the exception instance, simply ignore the return value.
public static <T extends java.lang.Throwable> T assertThrows(java.lang.Class<T> expectedType,
Executable executable,
java.util.function.Supplier<java.lang.String> messageSupplier)
executable throws
an exception of the expectedType and returns the exception.
If no exception is thrown, or if an exception of a different type is thrown, this method will fail.
If necessary, the failure message will be retrieved lazily from the
supplied messageSupplier.
If you do not want to perform additional checks on the exception instance, simply ignore the return value.
public static void assertTimeout(java.time.Duration timeout,
Executable executable)
executable
completes before the given timeout is exceeded.
Note: the executable will be executed in the same thread as that
of the calling code. Consequently, execution of the executable will
not be preemptively aborted if the timeout is exceeded.
public static void assertTimeout(java.time.Duration timeout,
Executable executable,
java.lang.String message)
executable
completes before the given timeout is exceeded.
Note: the executable will be executed in the same thread as that
of the calling code. Consequently, execution of the executable will
not be preemptively aborted if the timeout is exceeded.
Fails with the supplied failure message.
public static void assertTimeout(java.time.Duration timeout,
Executable executable,
java.util.function.Supplier<java.lang.String> messageSupplier)
executable
completes before the given timeout is exceeded.
Note: the executable will be executed in the same thread as that
of the calling code. Consequently, execution of the executable will
not be preemptively aborted if the timeout is exceeded.
If necessary, the failure message will be retrieved lazily from the
supplied messageSupplier.
public static <T> T assertTimeout(java.time.Duration timeout,
ThrowingSupplier<T> supplier)
supplier
completes before the given timeout is exceeded.
If the assertion passes then the supplier's result is returned.
Note: the supplier will be executed in the same thread as that
of the calling code. Consequently, execution of the supplier will
not be preemptively aborted if the timeout is exceeded.
public static <T> T assertTimeout(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.lang.String message)
supplier
completes before the given timeout is exceeded.
If the assertion passes then the supplier's result is returned.
Note: the supplier will be executed in the same thread as that
of the calling code. Consequently, execution of the supplier will
not be preemptively aborted if the timeout is exceeded.
Fails with the supplied failure message.
public static <T> T assertTimeout(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
supplier
completes before the given timeout is exceeded.
If the assertion passes then the supplier's result is returned.
Note: the supplier will be executed in the same thread as that
of the calling code. Consequently, execution of the supplier will
not be preemptively aborted if the timeout is exceeded.
If necessary, the failure message will be retrieved lazily from the
supplied messageSupplier.
public static void assertTimeoutPreemptively(java.time.Duration timeout,
Executable executable)
executable
completes before the given timeout is exceeded.
Note: the executable will be executed in a different thread than
that of the calling code. Furthermore, execution of the executable will
be preemptively aborted if the timeout is exceeded.
assertTimeoutPreemptively(Duration, Executable, String),
assertTimeoutPreemptively(Duration, Executable, Supplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier, String),
assertTimeoutPreemptively(Duration, ThrowingSupplier, Supplier),
assertTimeout(Duration, Executable)public static void assertTimeoutPreemptively(java.time.Duration timeout,
Executable executable,
java.lang.String message)
executable
completes before the given timeout is exceeded.
Note: the executable will be executed in a different thread than
that of the calling code. Furthermore, execution of the executable will
be preemptively aborted if the timeout is exceeded.
Fails with the supplied failure message.
assertTimeoutPreemptively(Duration, Executable),
assertTimeoutPreemptively(Duration, Executable, Supplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier, String),
assertTimeoutPreemptively(Duration, ThrowingSupplier, Supplier),
assertTimeout(Duration, Executable, String)public static void assertTimeoutPreemptively(java.time.Duration timeout,
Executable executable,
java.util.function.Supplier<java.lang.String> messageSupplier)
executable
completes before the given timeout is exceeded.
Note: the executable will be executed in a different thread than
that of the calling code. Furthermore, execution of the executable will
be preemptively aborted if the timeout is exceeded.
If necessary, the failure message will be retrieved lazily from the
supplied messageSupplier.
assertTimeoutPreemptively(Duration, Executable),
assertTimeoutPreemptively(Duration, Executable, String),
assertTimeoutPreemptively(Duration, ThrowingSupplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier, String),
assertTimeoutPreemptively(Duration, ThrowingSupplier, Supplier),
assertTimeout(Duration, Executable, Supplier)public static <T> T assertTimeoutPreemptively(java.time.Duration timeout,
ThrowingSupplier<T> supplier)
supplier
completes before the given timeout is exceeded.
If the assertion passes then the supplier's result is returned.
Note: the supplier will be executed in a different thread than
that of the calling code. Furthermore, execution of the supplier will
be preemptively aborted if the timeout is exceeded.
assertTimeoutPreemptively(Duration, Executable),
assertTimeoutPreemptively(Duration, Executable, String),
assertTimeoutPreemptively(Duration, Executable, Supplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier, String),
assertTimeoutPreemptively(Duration, ThrowingSupplier, Supplier),
assertTimeout(Duration, Executable)public static <T> T assertTimeoutPreemptively(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.lang.String message)
supplier
completes before the given timeout is exceeded.
If the assertion passes then the supplier's result is returned.
Note: the supplier will be executed in a different thread than
that of the calling code. Furthermore, execution of the supplier will
be preemptively aborted if the timeout is exceeded.
Fails with the supplied failure message.
assertTimeoutPreemptively(Duration, Executable),
assertTimeoutPreemptively(Duration, Executable, String),
assertTimeoutPreemptively(Duration, Executable, Supplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier, Supplier),
assertTimeout(Duration, Executable, String)public static <T> T assertTimeoutPreemptively(java.time.Duration timeout,
ThrowingSupplier<T> supplier,
java.util.function.Supplier<java.lang.String> messageSupplier)
supplier
completes before the given timeout is exceeded.
If the assertion passes then the supplier's result is returned.
Note: the supplier will be executed in a different thread than
that of the calling code. Furthermore, execution of the supplier will
be preemptively aborted if the timeout is exceeded.
If necessary, the failure message will be retrieved lazily from the
supplied messageSupplier.
assertTimeoutPreemptively(Duration, Executable),
assertTimeoutPreemptively(Duration, Executable, String),
assertTimeoutPreemptively(Duration, Executable, Supplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier),
assertTimeoutPreemptively(Duration, ThrowingSupplier, String),
assertTimeout(Duration, Executable, Supplier)