java - 如何对日志上的消息进行单元测试？

Question

我有一些正在测试的代码，它们调用 Java 记录器来报告其状态。在 JUnit 测试代码中，我想确认在此记录器中创建了正确的日志条目。例如;我有两个针对两个不同条件的错误日志。

methodGoingToBeTested(bool a, bool b){
    if(a)
        logger.info("a happened")
    else()
        logger.info("b happened")

}

@Test tester(){

    methodGoingToBeTested(true);
    assertXXXXXX(loggedLevel(),Level.INFO);
}

我想测试一下我在实际方法中所遇到的记录器错误是否在其应生成的条件下准确生成。我在网上查过，但建议确实很旧。有没有人有什么建议？感谢您的帮助。

我知道这里有一篇类似的帖子，但该帖子确实已经过时了，现在无法使用相同的过程来解决这个问题，这就是我首先问这个问题的原因。

Answer 1

您无法测试这一点的原因可能是因为您在正在测试的类中实例化了记录器。

class MyClass
{
    private final Logger logger = /* whatever */;
}

如果您使用 dependency injection您将允许自己测试此行为。

class MyClass
{
    private final Logger logger;

    MyClass(final Logger logger)
    {
        this.logger = logger;
    }
}

现在，在您的测试中，您注入(inject)一个模拟或假记录器。这是一个使用 Mockito 的简单示例:

@Mock
Logger logger;

@Test
void tester()
{
    MyClass inst = new MyClass(logger);

    methodUnderTest(true);

    BDDMockito.verify(logger).info(Mockito.anyString());
}

如果您愿意，您可以执行更严格的验证。

同样，您可以出于测试目的创建一个假 Logger 实现，该实现执行所需的断言，而不是模拟。这是一个非常基本的示例:

class FakeLogger implements Logger
{
    private boolean hasInfoBeenCalled = false;

    @Override
    public void info(String message)
    {
        hasInfoBeenCalled = true;
    }

    // Other Logger methods...

    public boolean hasInfoBeenCalled()
    {
        return hasInfoBeenCalled;
    }
}

@Test
void tester()
{
    FakeLogger logger = new FakeLogger();
    MyClass inst = new MyClass(logger);

    methodUnderTest(true);

    Assert.assertTrue(logger.hasInfoBeenCalled());
}

<小时/> 话虽这么说，如果唯一可观察和可测试的行为是写入日志文件，我会仔细重新考虑您的类的设计。如果您决定将来更改日志记录，您很可能会发现您的测试非常脆弱。