com.atlassian.utt.logging

Class CapturedLogging

java.lang.Object

org.junit.rules.ExternalResource

com.atlassian.utt.logging.CapturedLogging

All Implemented Interfaces:

org.junit.rules.TestRule

public class CapturedLogging
extends org.junit.rules.ExternalResource

A JUnit Rule for capturing and verifying log messages from a given class.

This implementation is Log4J specific, but the interface is framed in SLF4J terminology. The intent is that if we need to switch to a different logger we should be able to preserve the interface, since it mirrors the SLF4J interface used by non test code. The implementation uses a Log4j appender to capture log messages for verification.

Typical usage is to declare the rule

      @Rule
     public CapturedLogging capturedLogging = new CapturedLogging(ClassBeingTested.class);
 

and then use the provided matcher factories in tests

     assertThat(capturedLogging, didLogWarn("expected log message", "expected text detail"));
 

Since:

3.2.16

Constructor Summary

Constructors

Constructor and Description
CapturedLogging(Class logSource)

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
static org.hamcrest.Matcher<CapturedLogging>	didLogDebug(org.hamcrest.Matcher<String> messageMatcher) Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.DEBUG.
static org.hamcrest.Matcher<CapturedLogging>	didLogDebug(String... substrings) Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.DEBUG.
static org.hamcrest.Matcher<CapturedLogging>	didLogError(org.hamcrest.Matcher<String> messageMatcher) Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.ERROR.
static org.hamcrest.Matcher<CapturedLogging>	didLogError(String... substrings) Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.ERROR.
static org.hamcrest.Matcher<CapturedLogging>	didLogInfo(org.hamcrest.Matcher<String> messageMatcher) Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.INFO.
static org.hamcrest.Matcher<CapturedLogging>	didLogInfo(String... substrings) Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.INFO.
static org.hamcrest.Matcher<CapturedLogging>	didLogWarn(org.hamcrest.Matcher<String> messageMatcher) Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.WARN.
static org.hamcrest.Matcher<CapturedLogging>	didLogWarn(String... substrings) Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.WARN.
String	toString()

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CapturedLogging

public CapturedLogging(Class logSource)

Method Detail

before

protected void before()
               throws Throwable

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

Throwable

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

didLogError

public static org.hamcrest.Matcher<CapturedLogging> didLogError(org.hamcrest.Matcher<String> messageMatcher)

Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.ERROR.

Parameters:

messageMatcher - the matcher for the log message.

Returns:

the configured matcher.

didLogError

public static org.hamcrest.Matcher<CapturedLogging> didLogError(String... substrings)

Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.ERROR.

Parameters:

substrings - the substrings required in the log message.

Returns:

the configured matcher.

didLogWarn

public static org.hamcrest.Matcher<CapturedLogging> didLogWarn(org.hamcrest.Matcher<String> messageMatcher)

Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.WARN.

Parameters:

messageMatcher - the matcher for the log message.

Returns:

the configured matcher.

didLogWarn

public static org.hamcrest.Matcher<CapturedLogging> didLogWarn(String... substrings)

Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.WARN.

Parameters:

substrings - the substrings required in the log message.

Returns:

the configured matcher.

didLogInfo

public static org.hamcrest.Matcher<CapturedLogging> didLogInfo(org.hamcrest.Matcher<String> messageMatcher)

Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.INFO.

Parameters:

messageMatcher - the matcher for the log message.

Returns:

the configured matcher.

didLogInfo

public static org.hamcrest.Matcher<CapturedLogging> didLogInfo(String... substrings)

Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.INFO.

Parameters:

substrings - the substrings required in the log message.

Returns:

the configured matcher.

didLogDebug

public static org.hamcrest.Matcher<CapturedLogging> didLogDebug(org.hamcrest.Matcher<String> messageMatcher)

Obtain a Matcher which matches a CapturedLogging if a message matching the given messageMatcher was logged at Level.DEBUG.

Parameters:

messageMatcher - the matcher for the log message.

Returns:

the configured matcher.

didLogDebug

public static org.hamcrest.Matcher<CapturedLogging> didLogDebug(String... substrings)

Obtain a Matcher which matches a CapturedLogging if a single message containing all the given substrings was logged at Level.DEBUG.

Parameters:

substrings - the substrings required in the log message.

Returns:

the configured matcher.

toString

public String toString()

Overrides:

toString in class Object