net.obvj.junit.utils

Class TestUtils

java.lang.Object

net.obvj.junit.utils.TestUtils

public class TestUtils
extends Object

Common utilities for working with unit tests.

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static void	assertException(Class<? extends Throwable> expectedThrowable, Runnable runnable) A utility method to assert the expected exception thrown by a given procedure, that is, a function that accepts no arguments and returns void (e.g., a Runnable's run() method).
static void	assertException(Class<? extends Throwable> expectedThrowable, String expectedMessage, Class<? extends Throwable> expectedCause, Runnable runnable) A utility method to assert the expected exception, message and cause thrown by a given procedure, that is, a function that accepts no arguments and returns void (e.g., a Runnable's run() method).
static void	assertException(Class<? extends Throwable> expectedThrowable, String expectedMessage, Class<? extends Throwable> expectedCause, Supplier<?> supplier) A utility method to assert the expected exception, message and cause thrown by a supplying function.
static void	assertException(Class<? extends Throwable> expectedThrowable, String expectedMessage, Class<? extends Throwable> expectedCause, Throwable throwable) A utility method to assert that a given throwable matches the expected class, cause and message.
static void	assertException(Class<? extends Throwable> expectedThrowable, String expectedMessage, Runnable runnable) A utility method to assert the expected exception and message thrown by a given procedure, that is, a function that accepts no arguments and returns void (e.g., a Runnable's run() method).
static void	assertException(Class<? extends Throwable> expectedThrowable, String expectedMessage, Supplier<?> supplier) A utility method to assert the expected exception and message thrown by a supplying function.
static void	assertException(Class<? extends Throwable> expectedThrowable, String expectedMessage, Throwable throwable) A utility method to assert that a given throwable matches the expected class and message.
static void	assertException(Class<? extends Throwable> expectedThrowable, Supplier<?> supplier) A utility method to assert the expected exception thrown by a supplying function.
static void	assertException(Class<? extends Throwable> expectedThrowable, Throwable throwable) A utility method to assert that a given throwable matches the expected class.
static void	assertInstantiationNotAllowed(Class<?> targetClass) Tests that no instances of an utility class are created.
static void	assertInstantiationNotAllowed(Class<?> targetClass, Class<? extends Throwable> expectedThrowableClass) Tests that no instances of an utility class are created.
static void	assertInstantiationNotAllowed(Class<?> targetClass, Class<? extends Throwable> expectedThrowableClass, String expectedErrorMessage) Tests that no instances of an utility class are created.
static void	assertNegativeNumber(Number number) Assert that a number is negative.
static void	assertPositiveNumber(Number number) Assert that a number is positive.
static void	assertStringContains(String testString, String... expectedStrings) Tests that the given test string contains all of the expected strings.
static void	assertStringDoesNotContain(String testString, String... expectedStrings) Tests that the given test string does not contain any of the expected strings.

Methods inherited from class java.lang.Object

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

Method Detail

assertInstantiationNotAllowed

public static void assertInstantiationNotAllowed(Class<?> targetClass)
                                          throws ReflectiveOperationException

Tests that no instances of an utility class are created.

Parameters:

targetClass - the class to be tested

Throws:

AssertionError - if the target class is instantiated

ReflectiveOperationException - in case of errors getting constructor metadata or instantiating the private constructor

assertInstantiationNotAllowed

public static void assertInstantiationNotAllowed(Class<?> targetClass,
                                                 Class<? extends Throwable> expectedThrowableClass)
                                          throws ReflectiveOperationException

Tests that no instances of an utility class are created.

Parameters:

targetClass - the class to be tested

expectedThrowableClass - the expected throwable to be checked in case the constructor is called

Throws:

AssertionError - if the target class is instantiated or a different throwable class is received

ReflectiveOperationException - in case of errors getting constructor metadata or instantiating the private constructor

assertInstantiationNotAllowed

public static void assertInstantiationNotAllowed(Class<?> targetClass,
                                                 Class<? extends Throwable> expectedThrowableClass,
                                                 String expectedErrorMessage)
                                          throws ReflectiveOperationException

Tests that no instances of an utility class are created.

Parameters:

targetClass - the class to be tested

expectedThrowableClass - the expected throwable to be checked in case the constructor is called

expectedErrorMessage - the expected error message to be checked in case the constructor is called

Throws:

AssertionError - if the target class is instantiated or a different throwable class is received

ReflectiveOperationException - in case of errors getting constructor metadata or instantiating the private constructor

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   Throwable throwable)

A utility method to assert that a given throwable matches the expected class.

Parameters:

expectedThrowable - the expected throwable class

throwable - the throwable to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   String expectedMessage,
                                   Throwable throwable)

A utility method to assert that a given throwable matches the expected class and message.

Parameters:

expectedThrowable - the expected throwable class

expectedMessage - the expected message (if applicable)

throwable - the throwable to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   String expectedMessage,
                                   Class<? extends Throwable> expectedCause,
                                   Throwable throwable)

A utility method to assert that a given throwable matches the expected class, cause and message.

Parameters:

expectedThrowable - the expected throwable class

expectedMessage - the expected message (if applicable)

expectedCause - the expected throwable cause class (if applicable)

throwable - the throwable to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   Supplier<?> supplier)

A utility method to assert the expected exception thrown by a supplying function.

Example of usage:

 
 assertException(IllegalArgumentException.class,
         () -> TestSubject.testMethod("param1"))
 
 

Parameters:

expectedThrowable - the expected throwable class

supplier - the supplying function that throws an exception to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   String expectedMessage,
                                   Supplier<?> supplier)

A utility method to assert the expected exception and message thrown by a supplying function.

Example of usage:

 
 assertException(IllegalArgumentException.class, "Invalid argument: param1",
         () -> TestSubject.testMethod("param1"))
 
 

Parameters:

expectedThrowable - the expected throwable class

expectedMessage - the expected message (if applicable)

supplier - the supplying function that throws an exception to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   String expectedMessage,
                                   Class<? extends Throwable> expectedCause,
                                   Supplier<?> supplier)

A utility method to assert the expected exception, message and cause thrown by a supplying function.

Example of usage:

 
 assertException(MyException.class, "Unable to process the request",
         IllegalStateException.class() -> TestSubject.process("request1"))
 
 

Parameters:

expectedThrowable - the expected throwable class

expectedMessage - the expected message (if applicable)

expectedCause - the expected throwable cause class (if applicable)

supplier - the supplying function that throws an exception to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   Runnable runnable)

A utility method to assert the expected exception thrown by a given procedure, that is, a function that accepts no arguments and returns void (e.g., a Runnable's run() method).

Example of usage:

  assertException(IllegalStateException.class, () -> thread.start())
 

Parameters:

expectedThrowable - the expected throwable class

runnable - the runnable that produces an exception to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   String expectedMessage,
                                   Runnable runnable)

A utility method to assert the expected exception and message thrown by a given procedure, that is, a function that accepts no arguments and returns void (e.g., a Runnable's run() method).

Example of usage:

 
 assertException(IllegalStateException.class, "Already started",
         () -> thread.start())
 
 

Parameters:

expectedThrowable - the expected throwable class

expectedMessage - the expected message (if applicable)

runnable - the runnable that produces an exception to be validated

assertException

public static void assertException(Class<? extends Throwable> expectedThrowable,
                                   String expectedMessage,
                                   Class<? extends Throwable> expectedCause,
                                   Runnable runnable)

A utility method to assert the expected exception, message and cause thrown by a given procedure, that is, a function that accepts no arguments and returns void (e.g., a Runnable's run() method).

Example of usage:

 
 assertException(MyException.class, "Already started",
         IllegalStateException.class() -> thread.start())
 
 

Parameters:

expectedThrowable - the expected throwable class

expectedMessage - the expected message (if applicable)

expectedCause - the expected throwable cause class (if applicable)

runnable - the runnable that produces an exception to be validated

assertStringContains

public static void assertStringContains(String testString,
                                        String... expectedStrings)

Tests that the given test string contains all of the expected strings.

Parameters:

testString - the string to be tested

expectedStrings - the strings to be expected inside the testString

assertStringDoesNotContain

public static void assertStringDoesNotContain(String testString,
                                              String... expectedStrings)

Tests that the given test string does not contain any of the expected strings.

Parameters:

testString - the string to be tested

expectedStrings - the strings not to be expected inside the testString

assertPositiveNumber

public static void assertPositiveNumber(Number number)

Assert that a number is positive.

Parameters:

number - the number to be checked

Since:

1.4.0

assertNegativeNumber

public static void assertNegativeNumber(Number number)

Assert that a number is negative.

Parameters:

number - the number to be checked

Since:

1.4.0