java - Mockito 无法验证来自 org.slf4j.Logger 的方法的多次调用

Question

我有一个包含 2 个条件的方法。在每种情况下，都会调用 Logger.error 方法。验证该方法调用的第一个测试成功，但任何其他测试都失败并显示

Wanted but not invoked...Actually, there were zero interactions with this mock.

有谁知道为什么会这样？

下面，我提供了一个示例类和一个将产生问题的单元测试:

package packageName;

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

public class X {

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

    public void execute(boolean handle1stCase) {
        if (handle1stCase) {
            LOGGER.error("rumpampam");
        } else {
            LOGGER.error("latida");
        }
    }
}

测试:

package packageName;

import org.apache.commons.logging.LogFactory;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.mockito.Matchers.any;
import static org.mockito.Mockito.*;
import static org.powermock.api.mockito.PowerMockito.mockStatic;

@RunWith(PowerMockRunner.class)
@PrepareForTest({LoggerFactory.class})
public class XTest {

    @Mock
    private Logger loggerMock;

    private X x;

    @Before
    public void construct() {
        MockitoAnnotations.initMocks(this);

        mockStatic(LoggerFactory.class);
        when(LoggerFactory.getLogger(any(Class.class))).thenReturn(loggerMock);

        x = new X();
    }

    @Test
    public void whenFirstCaseErrorLogged() throws Exception {
        x.execute(true);
        verify(loggerMock, times(1)).error("rumpampam");
    }

    @Test
    public void whenSecondCaseErrorLogged() throws Exception {
        x.execute(false);
        verify(loggerMock, times(1)).error("latida");
    }
}

结果:

Wanted but not invoked: loggerMock.error("latida"); -> at packageName.XTest.whenSecondCaseErrorLogged(XTest.java:51)
Actually, there were zero interactions with this mock.

编辑:
我简短地回答了为什么除了第一个之外的每个测试都在 comment of this answer 中失败了。 .

我对问题的解决方案:
在测试中提供:

public static Logger loggerMockStatic;  

比只为所有测试创建一个实例并将其提供在静态变量中，并从比起使用静态 loggerMockStatic。所以你会:

    ...  
    MockitoAnnotations.initMocks(this);

    if (loggerMockStatic == null) {
        loggerMockStatic = loggerMock;
    }

    mockStatic(LoggerFactory.class);
    //when(LoggerFactory.getLogger(any(Class.class))).thenReturn(loggerMock);
    when(LoggerFactory.getLogger(any(Class.class))).thenReturn(loggerMockStatic);
    ...

并在验证方法中使用 loggerMockStatic 而不是 loggerMock。

一些关于方法的想法:
对我来说这很好，因为
1. 它不会破坏设计(如果您认为所需的变量应该是一个常量，那么它将保持这种状态)。
2. 它在测试中仅添加了 4 行，可让您测试常量(在本例中为记录器)行为。没有太多污染，测试用例仍然清晰。

我在 this answer 中解释的“删除 final 并提供 setter”方法打开系统漏洞。不需要有人为类设置记录器，我总是希望系统按需要打开。只为测试需要提供 setter 是不希望的。测试应该为实现工作，而不是相反。

特别是关于测试日志记录，我不认为应该在一般(大多数)情况下测试日志记录。日志记录应该是应用程序的一个方面。当您有其他输出来测试特定路径时，应该测试这些输出。但是在这种情况下(可能还有其他情况)某个路径没有其他输出，比如在某个条件下记录和返回，需要测试日志(根据我的说法)。我想始终知道即使有人更改了条件，日志消息仍将被记录。如果没有日志，并且如果有人以错误的方式更改了条件，则将无法知道错误是否存在于这段代码中(调试除外)。

我和一些同事讨论过，有一个单独的类来进行日志记录就可以了。这样常量在另一个类中被隔离，您将能够仅使用 Mockito 检查行为。他们进一步表示，如果您想将日志发送到电子邮件，则更改起来会更容易。
首先，如果您不打算在不久的将来在日志记录方式之间切换，我认为这是一个过早的模块化。
其次，仅使用 Mockito + 具有另一个类和 + 3 行代码 VS 我的一行代码 (logger.error(...)) + 使用 PowerMockito，我将再次使用后者。在测试期间添加额外的依赖项不会使您的生产代码变慢和变大。也许在考虑继续集成并且测试与其他阶段一样重要时，您可能会说这会使测试过程变得更慢、更庞大，但我会牺牲这一点——这对我来说似乎没什么大不了的。

Answer 1

您的记录器是静态的，因此它是在您的类加载时加载的，而不是在对象初始化时加载的。您无法保证您的模拟会按时准备好，有时它可能会工作有时不会。