org.sonar.api.utils.log.LogTester Maven / Gradle / Ivy
/*
* SonarQube
* Copyright (C) 2009-2018 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.utils.log;
import java.util.List;
import 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
*/
public class LogTester extends ExternalResource {
@Override
protected void before() throws Throwable {
// this shared instance breaks compatibility with parallel execution of tests
LogInterceptors.set(new ListInterceptor());
setLevel(LoggerLevel.INFO);
}
@Override
protected void after() {
LogInterceptors.set(NullInterceptor.NULL_INSTANCE);
setLevel(LoggerLevel.INFO);
}
LoggerLevel getLevel() {
return Loggers.getFactory().getLevel();
}
/**
* Enable/disable debug logs. Info, warn and error logs are always enabled.
* By default INFO logs are enabled when LogTester is started.
*/
public LogTester setLevel(LoggerLevel level) {
Loggers.getFactory().setLevel(level);
return this;
}
/**
* Logs in chronological order (item at index 0 is the oldest one)
*/
public List logs() {
return ((ListInterceptor) LogInterceptors.get()).logs();
}
/**
* Logs in chronological order (item at index 0 is the oldest one) for
* a given level
*/
public List logs(LoggerLevel level) {
return ((ListInterceptor) LogInterceptors.get()).logs(level);
}
public LogTester clear() {
((ListInterceptor) LogInterceptors.get()).clear();
return this;
}
}