org.sonar.api.utils.log

Class LogTester

java.lang.Object

org.junit.rules.ExternalResource

org.sonar.api.utils.log.LogTester

All Implemented Interfaces:

org.junit.rules.TestRule

public class LogTester
extends org.junit.rules.ExternalResource

For tests only
This JUnit rule allows to configure and access logs in tests. By default trace level is enabled.
Warning - not compatible with parallel execution of tests in the same JVM fork.
Example:

 public class MyClass {
   private final Logger logger = Loggers.get("logger_name");

   public void doSomething() {
     logger.info("foo");
   }
 }

 public class MyTest {
   @org.junit.Rule
   public LogTester logTester = new LogTester();

   @org.junit.Test
   public void test_log() {
     new MyClass().doSomething();

     assertThat(logTester.logs()).containsOnly("foo");
   }
 }
 

Since:

5.1

Constructor Summary

Constructors

Constructor and Description
LogTester()

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
LogTester	clear()
java.util.List<LogAndArguments>	getLogs() Logs with arguments in chronological order (item at index 0 is the oldest one)
java.util.List<LogAndArguments>	getLogs(LoggerLevel level) Logs with arguments in chronological order (item at index 0 is the oldest one) for a given level
java.util.List<java.lang.String>	logs() Logs in chronological order (item at index 0 is the oldest one)
java.util.List<java.lang.String>	logs(LoggerLevel level) Logs in chronological order (item at index 0 is the oldest one) for a given level
LogTester	setLevel(LoggerLevel level) Enable/disable debug logs.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Constructor Detail

LogTester

public LogTester()

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

setLevel

public LogTester setLevel(LoggerLevel level)

Enable/disable debug logs. Info, warn and error logs are always enabled. By default INFO logs are enabled when LogTester is started.

logs

public java.util.List<java.lang.String> logs()

Logs in chronological order (item at index 0 is the oldest one)

logs

public java.util.List<java.lang.String> logs(LoggerLevel level)

Logs in chronological order (item at index 0 is the oldest one) for a given level

getLogs

public java.util.List<LogAndArguments> getLogs()

Logs with arguments in chronological order (item at index 0 is the oldest one)

getLogs

public java.util.List<LogAndArguments> getLogs(LoggerLevel level)

Logs with arguments in chronological order (item at index 0 is the oldest one) for a given level

clear

public LogTester clear()