ca.uhn.test.util.LogbackTestExtension Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HAPI FHIR Test Utilities
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.test.util;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.read.ListAppender;
import jakarta.annotation.Nonnull;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Predicate;

/**
 * Test helper to collect logback lines.
 * The empty constructor will capture all log events, or you can name a log root to limit the noise.
 */
public class LogbackTestExtension implements BeforeEachCallback, AfterEachCallback {
	private final Logger myLogger;
	private final Level myLevel;
	private ListAppender myListAppender = null;
	private Level mySavedLevel;

	public LogbackTestExtension(Logger theLogger) {
		myLogger = theLogger;
		myLevel = null;
	}

	public LogbackTestExtension(Logger theLogger, Level theTestLogLevel) {
		myLogger = theLogger;
		myLevel = theTestLogLevel;
	}

	public LogbackTestExtension(String theLoggerName) {
		this((Logger) LoggerFactory.getLogger(theLoggerName));
	}

	public LogbackTestExtension() {
		this(org.slf4j.Logger.ROOT_LOGGER_NAME);
	}

	public LogbackTestExtension(String theLoggerName, Level theLevel) {
		this((Logger) LoggerFactory.getLogger(theLoggerName), theLevel);
	}

	public LogbackTestExtension(Class theClass) {
		this(theClass.getName());
	}

	public LogbackTestExtension(Class theClass, Level theLevel) {
		this(theClass.getName(), theLevel);
	}

	public LogbackTestExtension(org.slf4j.Logger theLogger) {
		this((Logger) theLogger);
	}

	/**
	 * Returns a copy to avoid concurrent modification errors.
	 * @return A copy of the log events so far.
	 */
	public List getLogEvents() {
		return new ArrayList<>(myListAppender.list);
	}

	public void clearEvents() {
		myListAppender.list.clear();
	}

	public ListAppender getAppender() {
		return myListAppender;
	}

	@Override
	public void beforeEach(ExtensionContext context) throws Exception {
		setUp();
	}

	public void setUp() {
		setUp(myLevel);
	}

	public void setUp(Level theLevel) {
		myListAppender = new ListAppender<>();
		myListAppender.start();
		myLogger.addAppender(myListAppender);
		if (theLevel != null) {
			mySavedLevel = myLogger.getLevel();
			myLogger.setLevel(theLevel);
		}
	}

	@Override
	public void afterEach(ExtensionContext context) throws Exception {
		myLogger.detachAppender(myListAppender);
		myListAppender.stop();
		if (myLevel != null) {
			myLogger.setLevel(mySavedLevel);
		}
	}

	public List getLogEvents(Predicate thePredicate) {
		return getLogEvents().stream().filter(thePredicate).toList();
	}

	@Nonnull
	public List getLogMessages() {
		return getLogEvents().stream().map(ILoggingEvent::getMessage).toList();
	}

}