Как перехватить запись SLF4J (с logback) через тест JUnit?

Ответ 1

Вы можете создать пользовательский appender

public class TestAppender extends AppenderBase<LoggingEvent> {
    static List<LoggingEvent> events = new ArrayList<>();

    @Override
    protected void append(LoggingEvent e) {
        events.add(e);
    }
}

и настройте logback-test.xml, чтобы использовать его. Теперь мы можем проверить события регистрации из нашего теста:

@Test
public void test() {
    ...
    Assert.assertEquals(1, TestAppender.events.size());
    ...
}

Ответ 2

API Slf4j не предоставляет такой возможности, но Logback предоставляет простое решение.

Вы можете использовать ListAppender: приложение для входа в систему whitebox, где записи журнала добавляются в поле public List, которое мы могли бы использовать для своих утверждений.

Вот простой пример.

Класс Foo:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Foo {

    static final Logger LOGGER = LoggerFactory.getLogger(Foo .class);

    public void doThat() {
        logger.info("start");
        //...
        logger.info("finish");
    }
}

Класс FooTest:

import org.slf4j.LoggerFactory;
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;

public class FooTest {

    @Test
    void doThat() throws Exception {
        // get Logback Logger 
        Logger fooLogger = (Logger) LoggerFactory.getLogger(Foo.class);

        // create and start a ListAppender
        ListAppender<ILoggingEvent> listAppender = new ListAppender<>();
        listAppender.start();

        // add the appender to the logger
        fooLogger.addAppender(listAppender);

        // call method under test
        Foo foo = new Foo();
        foo.doThat();

        // JUnit assertions
        List<ILoggingEvent> logsList = listAppender.list;
        assertEquals("start", logsList.get(0)
                                      .getMessage());
        assertEquals(Level.INFO, logsList.get(0)
                                         .getLevel());

        assertEquals("finish", logsList.get(1)
                                       .getMessage());
        assertEquals(Level.INFO, logsList.get(1)
                                         .getLevel());
    }
}

Вы также можете использовать библиотеки Matcher/assertion как AssertJ или Hamcrest.

С AssertJ это будет:

import org.assertj.core.api.Assertions;

Assertions.assertThat(listAppender.list)
          .extracting(ILoggingEvent::getMessage, ILoggingEvent::getLevel)
          .containsExactly(Tuple.tuple("start", Level.INFO), Tuple.tuple("finish", Level.INFO));

Ответ 3

Вы можете использовать slf4j-test из http://projects.lidalia.org.uk/slf4j-test/. Он заменяет всю реализацию logback slf4j своей собственной реализацией slf4j api для тестов и предоставляет api для утверждения против событий регистрации.

Пример:

<build>
  <plugins>
    <plugin>
      <artifactId>maven-surefire-plugin</artifactId>
      <configuration>
        <classpathDependencyExcludes>
          <classpathDependencyExcludes>ch.qos.logback:logback-classic</classpathDependencyExcludes>
        </classpathDependencyExcludes>
      </configuration>
    </plugin>
  </plugins>
</build>

public class Slf4jUser {

    private static final Logger logger = LoggerFactory.getLogger(Slf4jUser.class);

    public void aMethodThatLogs() {
        logger.info("Hello World!");
    }
}

public class Slf4jUserTest {

    Slf4jUser slf4jUser = new Slf4jUser();
    TestLogger logger = TestLoggerFactory.getTestLogger(Slf4jUser.class);

    @Test
    public void aMethodThatLogsLogsAsExpected() {
        slf4jUser.aMethodThatLogs();

        assertThat(logger.getLoggingEvents(), is(asList(info("Hello World!"))));
    }

    @After
    public void clearLoggers() {
        TestLoggerFactory.clear();
    }
}

Ответ 4

Хотя создание специального приложения для входа в систему является хорошим решением, это только первый шаг, но в конечном итоге вы будете разрабатывать/изобретать slf4j-test, и если вы пойдете немного дальше: spf4j-slf4j -тест или другие фреймворки, о которых я пока не знаю.

В конечном итоге вам нужно будет беспокоиться о том, сколько событий вы храните в памяти, не проходить модульные тесты, когда ошибка регистрируется (и не подтверждается), делать журналы отладки доступными при сбое теста и т. Д...

Отказ от ответственности: я являюсь автором spf4j-slf4j-test, я написал этот бэкэнд, чтобы иметь возможность лучше тестировать spf4j, который является хорошим местом для поиска примеров того, как использовать spf4j-slf4j-test, Одним из основных преимуществ, которых я добился, было снижение производительности сборки (что ограничено в Travis), при этом все еще были все детали, которые мне нужны, когда происходит сбой.

Ответ 5

У меня были проблемы при тестировании строки журнала: LOGGER.error(сообщение, исключение).

Решение, описанное в http://projects.lidalia.org.uk/slf4j-test/, также пытается утверждать об исключении, и это непросто (и, на мой взгляд, бесполезно) воссоздайте stacktrace.

Я решил таким образом:

import org.junit.Test;
import org.slf4j.Logger;
import uk.org.lidalia.slf4jext.LoggerFactory;
import uk.org.lidalia.slf4jtest.TestLogger;
import uk.org.lidalia.slf4jtest.TestLoggerFactory;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.groups.Tuple.tuple;
import static uk.org.lidalia.slf4jext.Level.ERROR;
import static uk.org.lidalia.slf4jext.Level.INFO;


public class Slf4jLoggerTest {

    private static final Logger LOGGER = LoggerFactory.getLogger(Slf4jLoggerTest.class);


    private void methodUnderTestInSomeClassInProductionCode() {
        LOGGER.info("info message");
        LOGGER.error("error message");
        LOGGER.error("error message with exception", new RuntimeException("this part is not tested"));
    }





    private static final TestLogger TEST_LOGGER = TestLoggerFactory.getTestLogger(Slf4jLoggerTest.class);

    @Test
    public void testForMethod() throws Exception {
        // when
        methodUnderTestInSomeClassInProductionCode();

        // then
        assertThat(TEST_LOGGER.getLoggingEvents()).extracting("level", "message").contains(
                tuple(INFO, "info message"),
                tuple(ERROR, "error message"),
                tuple(ERROR, "error message with exception")
        );
    }

}

Это имеет также преимущество в том, что он не зависит от библиотеки Hamcrest matchers.

Ответ 6

Простым решением может быть издеваться над аппендером с помощью Mockito (например)

MyClass.java

@Slf4j
class MyClass {
    public void doSomething() {
        log.info("I'm on it!");
    }
}

MyClassTest.java

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.is;
import static org.mockito.Mockito.verify;         

@RunWith(MockitoJUnitRunner.class)
public class MyClassTest {    

    @Mock private Appender<ILoggingEvent> mockAppender;
    private MyClass sut = new MyClass();    

    @Before
    public void setUp() {
        Logger logger = (Logger) LoggerFactory.getLogger(MyClass.class.getName());
        logger.addAppender(mockAppender);
    }

    @Test
    public void shouldLogInCaseOfError() {
        sut.doSomething();

        verify(mockAppender).doAppend(ArgumentMatchers.argThat(argument -> {
            assertThat(argument.getMessage(), containsString("I'm on it!"));
            assertThat(argument.getLevel(), is(Level.INFO));
            return true;
        }));

    }

}

ПРИМЕЧАНИЕ. Я использую утверждение, а не возвращаю false, так как make code и (возможно) ошибка легче читаются, но это не сработает, если у вас есть несколько проверок. В этом случае вам нужно вернуть логическое значение, указывающее, соответствует ли значение ожидаемому.

Ответ 7

Я бы порекомендовал простую, многоразовую шпионскую реализацию, которую можно включить в тест как правило JUnit:

public final class LogSpy extends ExternalResource {

    private Logger logger;
    private ListAppender<ILoggingEvent> appender;

    @Override
    protected void before() {
        appender = new ListAppender<>();
        logger = (Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME); // cast from facade (SLF4J) to implementation class (logback)
        logger.addAppender(appender);
        appender.start();
    }

    @Override
    protected void after() {
        logger.detachAppender(appender);
    }

    public List<ILoggingEvent> getEvents() {
        if (appender == null) {
            throw new UnexpectedTestError("LogSpy needs to be annotated with @Rule");
        }
        return appender.list;
    }
}

В своем тесте вы бы активировали шпиона следующим образом:

@Rule
public LogSpy log = new LogSpy();

Вызвать log.getEvents() (или другие, пользовательские методы), чтобы проверить зарегистрированные события.