com.github.valfirst.slf4jtest

Class TestLoggerAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<C,TestLogger>

com.github.valfirst.slf4jtest.TestLoggerAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<TestLoggerAssert,TestLogger>, org.assertj.core.api.Descriptable<TestLoggerAssert>, org.assertj.core.api.ExtensionPoints<TestLoggerAssert,TestLogger>

public class TestLoggerAssert
extends org.assertj.core.api.AbstractAssert<C,TestLogger>

A set of assertions to validate that logs have been logged to a TestLogger.

Should be thread safe, as this uses testLogger.getLoggingEvents() by default. The assertion mode can be switched to use testLogger.getAllLoggingEvents() by calling anyThread().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestLoggerAssert.MdcComparator
static class	TestLoggerAssert.PredicateBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected Supplier<List<LoggingEvent>>	loggingEventsSupplier

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself, objects, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TestLoggerAssert(TestLogger testLogger)

Method Summary

Modifier and Type	Method and Description
TestLoggerAssert	anyThread() Changes the assertion mode to verify that log messages have been logged regardless of which thread actually logged the message.
protected static LoggingEvent	event(org.slf4j.event.Level level, String message, Object... arguments)
protected static LoggingEvent	event(Throwable throwable, org.slf4j.event.Level level, String message, Object... arguments)
protected long	getLogCount(org.slf4j.event.Level level, Predicate<LoggingEvent> predicate)
LevelAssert	hasLevel(org.slf4j.event.Level level) Convenience method for a LevelAssert from a provided test logger.
TestLoggerAssert	hasLogged(org.slf4j.event.Level level, String message, Object... arguments) Verify that a log message, at a specific level, has been logged by the test logger.
TestLoggerAssert	hasLogged(LoggingEvent event) Verify that a LoggingEvent has been logged by the test logger.
TestLoggerAssert	hasLogged(Predicate<LoggingEvent> predicate) Verify that a LoggingEvent satisfying the provided predicate has been logged by the test logger.
TestLoggerAssert	hasLogged(TestLoggerAssert.PredicateBuilder predicate) Uses the supplied TestLoggerAssert.PredicateBuilder to construct the predicate with which to Verify that a matching LoggingEvent has been logged by the test logger.
TestLoggerAssert	hasLogged(Throwable throwable, org.slf4j.event.Level level, String message, Object... arguments) Verify that a log message, at a specific level, has been logged by the test logger in the presence of a Throwable.
TestLoggerAssert	hasNotLogged(org.slf4j.event.Level level, String message, Object... arguments) Verify that a log message, at a specific level, has not been logged by the test logger.
TestLoggerAssert	hasNotLogged(LoggingEvent event) Verify that a LoggingEvent has not been logged by the test logger.
TestLoggerAssert	hasNotLogged(Predicate<LoggingEvent> predicate) Verify that a LoggingEvent satisfying the provided predicate has _not_ been logged by the test logger.
TestLoggerAssert	hasNotLogged(TestLoggerAssert.PredicateBuilder predicate) Uses the supplied TestLoggerAssert.PredicateBuilder to construct the predicate with which to Verify that a matching LoggingEvent has _not_ been logged by the test logger.
TestLoggerAssert	hasNotLogged(Throwable throwable, org.slf4j.event.Level level, String message, Object... arguments) Verify that a log message, at a specific level, has not been logged by the test logger in the presence of a Throwable.
protected static Predicate<LoggingEvent>	logWithMessage(String message, Object... arguments)
protected static Predicate<LoggingEvent>	logWithMessage(String message, Optional<Throwable> maybeThrowable, Object... arguments)
TestLoggerAssert	usingMdcComparator(TestLoggerAssert.MdcComparator mdcComparator) Allows the comparison strategy for verifying the MDC contents to be configured.

Methods inherited from class org.assertj.core.api.AbstractAssert

actual, areEqual, asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, doesNotHaveToString, doesNotMatch, doesNotMatch, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingEquals, usingEquals, usingRecursiveAssertion, usingRecursiveAssertion, usingRecursiveComparison, usingRecursiveComparison, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assertj.core.api.Descriptable

as, as, as, describedAs, describedAs

Field Detail

loggingEventsSupplier

protected Supplier<List<LoggingEvent>> loggingEventsSupplier

Constructor Detail

TestLoggerAssert

protected TestLoggerAssert(TestLogger testLogger)

Method Detail

anyThread

public TestLoggerAssert anyThread()

Changes the assertion mode to verify that log messages have been logged regardless of which thread actually logged the message.

Returns:

a TestLoggerAssert for chaining

usingMdcComparator

public TestLoggerAssert usingMdcComparator(TestLoggerAssert.MdcComparator mdcComparator)

Allows the comparison strategy for verifying the MDC contents to be configured.

The default behaviour is to verify the contents of the MDC are exactly equal to those on the logging event.

Parameters:

mdcComparator - the comparator to use when verifying the contents of the MDC captured by the logging event

Returns:

a TestLoggerAssert for chaining

See Also:

TestLoggerAssert.MdcComparator

hasLogged

public TestLoggerAssert hasLogged(org.slf4j.event.Level level,
                                  String message,
                                  Object... arguments)

Verify that a log message, at a specific level, has been logged by the test logger.

Parameters:

level - the level of the log message to look for

message - the expected message

arguments - any optional arguments that may be provided to the log message

Returns:

a TestLoggerAssert for chaining

hasLogged

public TestLoggerAssert hasLogged(Throwable throwable,
                                  org.slf4j.event.Level level,
                                  String message,
                                  Object... arguments)

Verify that a log message, at a specific level, has been logged by the test logger in the presence of a Throwable.

Parameters:

throwable - the throwable that is attached to the log message

level - the level of the log message to look for

message - the expected message

arguments - any optional arguments that may be provided to the log message

Returns:

a TestLoggerAssert for chaining

hasLogged

public TestLoggerAssert hasLogged(LoggingEvent event)

Verify that a LoggingEvent has been logged by the test logger.

Parameters:

event - the event to verify presence of

Returns:

a TestLoggerAssert for chaining

hasLogged

public TestLoggerAssert hasLogged(Predicate<LoggingEvent> predicate)

Verify that a LoggingEvent satisfying the provided predicate has been logged by the test logger.

Parameters:

predicate - the predicate to test against

Returns:

a TestLoggerAssert for chaining

hasLogged

public TestLoggerAssert hasLogged(TestLoggerAssert.PredicateBuilder predicate)

Uses the supplied TestLoggerAssert.PredicateBuilder to construct the predicate with which to Verify that a matching LoggingEvent has been logged by the test logger.

Parameters:

predicate - the TestLoggerAssert.PredicateBuilder to use to construct the test predicate

Returns:

a TestLoggerAssert for chaining

hasNotLogged

public TestLoggerAssert hasNotLogged(org.slf4j.event.Level level,
                                     String message,
                                     Object... arguments)

Verify that a log message, at a specific level, has not been logged by the test logger.

Parameters:

level - the level of the log message to look for

message - the expected message

arguments - any optional arguments that may be provided to the log message

Returns:

a TestLoggerAssert for chaining

hasNotLogged

public TestLoggerAssert hasNotLogged(Throwable throwable,
                                     org.slf4j.event.Level level,
                                     String message,
                                     Object... arguments)

Verify that a log message, at a specific level, has not been logged by the test logger in the presence of a Throwable.

Parameters:

throwable - the throwable that is attached to the log message

level - the level of the log message to look for

message - the expected message

arguments - any optional arguments that may be provided to the log message

Returns:

a TestLoggerAssert for chaining

hasNotLogged

public TestLoggerAssert hasNotLogged(LoggingEvent event)

Verify that a LoggingEvent has not been logged by the test logger.

Parameters:

event - the event to verify absence of

Returns:

a TestLoggerAssert for chaining

hasNotLogged

public TestLoggerAssert hasNotLogged(Predicate<LoggingEvent> predicate)

Verify that a LoggingEvent satisfying the provided predicate has _not_ been logged by the test logger.

Parameters:

predicate - the predicate to test against

Returns:

a TestLoggerAssert for chaining

hasNotLogged

public TestLoggerAssert hasNotLogged(TestLoggerAssert.PredicateBuilder predicate)

Uses the supplied TestLoggerAssert.PredicateBuilder to construct the predicate with which to Verify that a matching LoggingEvent has _not_ been logged by the test logger.

Parameters:

predicate - the TestLoggerAssert.PredicateBuilder to use to construct the test predicate

Returns:

a TestLoggerAssert for chaining

hasLevel

public LevelAssert hasLevel(org.slf4j.event.Level level)

Convenience method for a LevelAssert from a provided test logger.

Parameters:

level - the Level to assert against

Returns:

the LevelAssert bound to the given Level

getLogCount

protected long getLogCount(org.slf4j.event.Level level,
                           Predicate<LoggingEvent> predicate)

logWithMessage

protected static Predicate<LoggingEvent> logWithMessage(String message,
                                                        Object... arguments)

logWithMessage

protected static Predicate<LoggingEvent> logWithMessage(String message,
                                                        Optional<Throwable> maybeThrowable,
                                                        Object... arguments)

event

protected static LoggingEvent event(org.slf4j.event.Level level,
                                    String message,
                                    Object... arguments)

event

protected static LoggingEvent event(Throwable throwable,
                                    org.slf4j.event.Level level,
                                    String message,
                                    Object... arguments)