org.xwiki.test

Class AllLogRule

java.lang.Object

org.xwiki.test.AllLogRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class AllLogRule
extends Object
implements org.junit.rules.TestRule

Allow capturing Logs output during the execution of the unit test. This is useful for two reasons:

• it allows not outputting log messages in the console which is a bad practice. When a test run it should not output anything and if it needs to assert something, it has to be done in the test itself.
• it allows to assert the output log messages

This code was inspired by code written by Christian Baranowski in a blog post.

Example usage:

  @Rule public AllLogRule logRule = new AllLogRule();
 

Since:

7.0M1

Version:

$Id: 386571fe94af23fcc78d458a6d0fc9376b732656 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AllLogRule.LogStatement The actual code that executes our capturing logic before the test runs and removes it after it has run.

Constructor Summary

Constructors

Constructor and Description
AllLogRule() Capture INFO log.
AllLogRule(LogRule.LogLevel level) Caputure passed log level.

Method Summary

Methods

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement statement, org.junit.runner.Description description)
org.slf4j.Marker	getMarker(int position)
String	getMessage(int position)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

AllLogRule

public AllLogRule()

Capture INFO log.

AllLogRule

public AllLogRule(LogRule.LogLevel level)

Caputure passed log level.

Parameters:

level - the level of log to capture

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement statement,
                                      org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

getMessage

public String getMessage(int position)

Parameters:

position - the message number in the list of captured logs

Returns:

the message at the specified position

getMarker

public org.slf4j.Marker getMarker(int position)

Parameters:

position - the message number in the list of captured logs

Returns:

the marker at the specified position

Since:

7.0M2

size

public int size()

Returns:

the number of log messages that have been captured