net.openhft.chronicle.testframework.exception

Interface ExceptionTracker<T>

Type Parameters:

T - The class used to represent thrown exceptions

public interface ExceptionTracker<T>

The ExceptionTracker interface provides a set of methods to record, track, and assert exceptions in a testing context. By defining rules to expect or ignore certain exceptions, it helps in systematically verifying the correct exception handling behavior of code under test.

Method Summary

Modifier and Type	Method and Description
void	checkExceptions() Call this method in a teardown (@After) phase of the test to: Verify no non-ignored exceptions were thrown Assert there is an exception matching each of the expected predicates Implementations should throw an exception and print a summary if the assertion(s) are violated.
static <T> ExceptionTracker<T>	create(@NotNull Function<T,String> messageExtractor, @NotNull Function<T,Throwable> throwableExtractor, @NotNull Runnable resetRunnable, @NotNull Map<T,Integer> exceptions, @NotNull Predicate<T> ignorePredicate, @NotNull Function<T,String> exceptionRenderer) Factory method to create an instance of the exception tracker.
void	expectException(Predicate<T> predicate, String description) Specifies that an exception matching the specified predicate must be thrown.
void	expectException(String message) Specifies that an exception containing the specified string must be thrown during the test.
boolean	hasException(Predicate<T> predicate) Determines if the tracker contains an exception matching the predicate.
void	ignoreException(Predicate<T> predicate, String description) Ignores exceptions matching the specified predicate.
void	ignoreException(String message) Ignores exceptions containing the specified string.

Method Detail

create

static <T> ExceptionTracker<T> create(@NotNull
                                      @NotNull Function<T,String> messageExtractor,
                                      @NotNull
                                      @NotNull Function<T,Throwable> throwableExtractor,
                                      @NotNull
                                      @NotNull Runnable resetRunnable,
                                      @NotNull
                                      @NotNull Map<T,Integer> exceptions,
                                      @NotNull
                                      @NotNull Predicate<T> ignorePredicate,
                                      @NotNull
                                      @NotNull Function<T,String> exceptionRenderer)

Factory method to create an instance of the exception tracker. This method encapsulates the construction of a concrete implementation of the ExceptionTracker interface.

Parameters:

messageExtractor - Function to extract the String message or description from T

throwableExtractor - Function to extract the Throwable from T

resetRunnable - Runnable that will be called at the end of checkExceptions()

exceptions - Map to populate with T as the key and count of occurrences as value

ignorePredicate - Predicate to exclude T's from consideration

exceptionRenderer - Function to render T as a String (used when dumping exceptions)

Returns:

An instance of ExceptionTracker

expectException

void expectException(String message)

Specifies that an exception containing the specified string must be thrown during the test. Failing to do so will cause the test to fail.

Parameters:

message - The string to require

expectException

void expectException(Predicate<T> predicate,
                     String description)

Specifies that an exception matching the specified predicate must be thrown. Failing to match the exception will cause the test to fail.

Parameters:

predicate - Predicate to match exceptions

description - Description of the exceptions being required

ignoreException

void ignoreException(String message)

Ignores exceptions containing the specified string. Matching exceptions will not cause the test to fail.

Parameters:

message - The string to ignore

ignoreException

void ignoreException(Predicate<T> predicate,
                     String description)

Ignores exceptions matching the specified predicate. Matching exceptions will not cause the test to fail.

Parameters:

predicate - Predicate to match the exception

description - Description of the exceptions being ignored

hasException

boolean hasException(Predicate<T> predicate)

Determines if the tracker contains an exception matching the predicate.

Parameters:

predicate - Predicate to match the exception

Returns:

true if an exception matching the predicate is found; false otherwise

checkExceptions

void checkExceptions()

Call this method in a teardown (@After) phase of the test to:

• Verify no non-ignored exceptions were thrown
• Assert there is an exception matching each of the expected predicates

Implementations should throw an exception and print a summary if the assertion(s) are violated.