org.echocat.jomon.testing.environments

Class LogbackTemporaryLogAppender

java.lang.Object

org.junit.rules.ExternalResource

org.echocat.jomon.testing.environments.LogbackTemporaryLogAppender

All Implemented Interfaces:

org.junit.rules.TestRule

public class LogbackTemporaryLogAppender
extends org.junit.rules.ExternalResource

A JUnit TestRule to create a temporary log appender and it to Logger for the given class. The appender will record all log messages.

In order to run it requires an initialized LoggingEnvironment instance as part of the constructor. The LoggingEnvironment must be initialized before creating the LogbackTemporaryLogAppender. This can be achieved by using an RuleChain (see sample below).

Note: Only logback is supported at the moment as logging framework.

Example

 public class FooTest {
    public LoggingEnvironment _loggingEnvironment = new LoggingEnvironment(LoggingEnvironment.Type.logback);
    public LogbackTemporaryLogAppender _temporaryLogAppender = new LogbackTemporaryLogAppender(_loggingEnvironment, FooTest.class);
    @Rule
    public TestRule _chain = RuleChain.outerRule(_loggingEnvironment).around(_temporaryLogAppender);

    @Test
    public void test() {
        LoggerFactory.getLogger(getClass()).info("Expected log message");
        assertThat(_temporaryLogAppender.toString(), contains("Expected log message"));
    }
 }
 

Constructor Summary

Constructors

Constructor and Description
LogbackTemporaryLogAppender(LoggingEnvironment loggingEnvironment, java.lang.Class<?> forLogger)
LogbackTemporaryLogAppender(LoggingEnvironment loggingEnvironment, java.lang.String forLogger)

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
java.lang.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

LogbackTemporaryLogAppender

public LogbackTemporaryLogAppender(@Nonnull
                                   LoggingEnvironment loggingEnvironment,
                                   @Nonnull
                                   java.lang.Class<?> forLogger)

LogbackTemporaryLogAppender

public LogbackTemporaryLogAppender(@Nonnull
                                   LoggingEnvironment loggingEnvironment,
                                   @Nonnull
                                   java.lang.String forLogger)

Method Detail

before

protected void before()
               throws java.lang.Throwable

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

java.lang.Throwable

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object