Package com.atlassian.confluence.test.util

Class Log4J2Logger

java.lang.Object

com.atlassian.confluence.test.util.AnnotatedMethodTemplate<Log4J2Logger.Record>

com.atlassian.confluence.test.util.Log4J2Logger

All Implemented Interfaces:

org.junit.rules.TestRule

public class Log4J2Logger
extends AnnotatedMethodTemplate<Log4J2Logger.Record>

Record the logging output for a given log4j2 logger.

Usage:

 public class MyTest
   {
      @literal @Rule public Log4JLogger logger = new Log4JLogger(MyTest.class);

      @literal @Test
      @literal @Log4JLogger.Record(loggerClass = MyUnitUnderTest.class, logLevel = Log4JLogger.LogLevel.DEBUG)
       public void myTestMethod() throws Exception
       {
           // call unit under test
           Assert.assertEquals("expected log message", logger.snapshot());
       }
  }
  
 

Since:

7.20

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Log4J2Logger.LogLevel
static @interface	Log4J2Logger.Record

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.logging.log4j.core.StringLayout	layout

Fields inherited from class com.atlassian.confluence.test.util.AnnotatedMethodTemplate

annotationClass, testClass

Constructor Summary

Constructors

Constructor	Description
Log4J2Logger(Class testClass)
Log4J2Logger(Class testClass, org.apache.logging.log4j.core.StringLayout layout)

Method Summary

Modifier and Type	Method	Description
protected org.junit.runners.model.Statement	applyForAnnotation(org.junit.runners.model.Statement statement, org.junit.runner.Description description, Log4J2Logger.Record record)
String	snapshot()

Methods inherited from class com.atlassian.confluence.test.util.AnnotatedMethodTemplate

apply

Methods inherited from class java.lang.Object

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

Field Details

layout

protected final org.apache.logging.log4j.core.StringLayout layout

Constructor Details

Log4J2Logger

public Log4J2Logger(Class testClass)

Log4J2Logger

public Log4J2Logger(Class testClass,
 org.apache.logging.log4j.core.StringLayout layout)

Method Details

applyForAnnotation

protected org.junit.runners.model.Statement applyForAnnotation(org.junit.runners.model.Statement statement,
 org.junit.runner.Description description,
 Log4J2Logger.Record record)

Specified by:

applyForAnnotation in class AnnotatedMethodTemplate<Log4J2Logger.Record>

snapshot

public String snapshot()