Mockito 在本地模拟最终课程，但在 Jenkins 中失败

Question

我已经为静态方法编写了一些单元测试。静态方法只接受一个参数。参数的类型是最终类。代码方面：

public class Utility {

   public static Optional<String> getName(Customer customer) {
       // method's body.
   }
}

public final class Customer {
   // class definition
}

所以对于Utility 类，我创建了一个测试类UtilityTests，我在其中为此方法编写了测试，getName。单元测试框架是TestNG，使用的模拟库是Mockito。所以一个典型的测试有以下结构：

public class UtilityTests {

   @Test
   public void getNameTest() {
     // Arrange
     Customer customerMock = Mockito.mock(Customer.class);
     Mockito.when(...).thenReturn(...);

     // Act
     Optional<String> name = Utility.getName(customerMock);

     // Assert
     Assert.assertTrue(...);
   }
}

有什么问题？

虽然测试在 IntelliJ 中在本地成功运行，但在 Jenkins 上却失败了（当我将代码推送到远程分支时，会触发构建并在最后运行单元测试）。错误信息如下：

org.mockito.exceptions.base.MockitoException：无法模拟/监视类 com.packagename.Customer Mockito 不能模拟/间谍，因为： - 最后一课

我尝试了什么？

我搜索了一下，以找到解决方案，但我没有成功。我在这里指出，我不允许更改 Customer 是 final 类的事实。除此之外，如果可能的话，我希望不完全改变它的设计（例如，创建一个接口，它将包含我想要模拟的方法并声明 Customer 类实现了该接口，正如何塞在他的评论中正确指出的那样）。我尝试的是mockito-final 中提到的第二个选项。尽管这解决了问题，但它阻止了其他一些单元测试:(，无法以明显的方式修复。

问题

所以这是我的两个问题：

1. 首先这怎么可能？测试不应该在本地和詹金斯都失败吗？
2. 如何根据我上面提到的约束来解决这个问题？

提前感谢您的帮助。

Answer 1

另一种方法是使用“方法到类”模式。

1. 将方法从客户类移到另一个类/类中，例如 CustomerSomething eg/CustomerFinances（或任何它的职责）。
2. 向 Customer 添加一个构造函数。
3. 现在您不需要模拟 Customer，只需模拟 CustomerSomething 类！如果它没有外部依赖项，您可能也不需要模拟它。

这是一个关于这个主题的好博客：https://simpleprogrammer.com/back-to-basics-mock-eliminating-patterns/

Answer 2

首先这怎么可能？测试不应该在本地和 Jenkins 中都失败吗？

这显然是一种环境特性。唯一的问题是——如何确定差异的原因。

我建议您检查org.mockito.internal.util.MockUtil#typeMockabilityOf 方法并比较一下mockMaker 在两种环境中实际使用的内容以及原因。

如果 mockMaker 相同 - 比较加载的类 IDE-Client 与 Jenkins-Client - 它们在测试执行时间上是否有任何差异。

如何根据我上面提到的限制来解决这个问题？

以下代码是假设 OpenJDK 12 和 Mockito 2.28.2 编写的，但我相信您可以将其调整为任何实际使用的版本。

public class UtilityTest {    
    @Rule
    public InlineMocksRule inlineMocksRule = new InlineMocksRule();

    @Rule
    public MockitoRule mockitoRule = MockitoJUnit.rule();

    @Test
    public void testFinalClass() {
        // Given
        String testName = "Ainz Ooal Gown";
        Client client = Mockito.mock(Client.class);
        Mockito.when(client.getName()).thenReturn(testName);

        // When
        String name = Utility.getName(client).orElseThrow();

        // Then
        assertEquals(testName, name);
    }

    static final class Client {
        final String getName() {
            return "text";
        }
    }

    static final class Utility {
        static Optional<String> getName(Client client) {
            return Optional.ofNullable(client).map(Client::getName);
        }
    }    
}

使用单独的内联模拟规则：

import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;
import org.mockito.internal.configuration.plugins.Plugins;
import org.mockito.internal.util.MockUtil;

import java.lang.invoke.MethodHandles;
import java.lang.invoke.VarHandle;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;

public class InlineMocksRule implements TestRule {
    private static Field MOCK_MAKER_FIELD;

    static {
        try {
            MethodHandles.Lookup lookup = MethodHandles.privateLookupIn(Field.class, MethodHandles.lookup());
            VarHandle modifiers = lookup.findVarHandle(Field.class, "modifiers", int.class);

            MOCK_MAKER_FIELD = MockUtil.class.getDeclaredField("mockMaker");
            MOCK_MAKER_FIELD.setAccessible(true);

            int mods = MOCK_MAKER_FIELD.getModifiers();
            if (Modifier.isFinal(mods)) {
                modifiers.set(MOCK_MAKER_FIELD, mods & ~Modifier.FINAL);
            }
        } catch (IllegalAccessException | NoSuchFieldException ex) {
            throw new RuntimeException(ex);
        }
    }

    @Override
    public Statement apply(Statement base, Description description) {
        return new Statement() {
            @Override
            public void evaluate() throws Throwable {
                Object oldMaker = MOCK_MAKER_FIELD.get(null);
                MOCK_MAKER_FIELD.set(null, Plugins.getPlugins().getInlineMockMaker());
                try {
                    base.evaluate();
                } finally {
                    MOCK_MAKER_FIELD.set(null, oldMaker);
                }
            }
        };
    }
}

Answer 3

确保使用相同的参数运行测试。检查您的 intellij 运行配置是否与 jenkins 匹配。 https://www.jetbrains.com/help/idea/creating-and-editing-run-debug-configurations.html。您可以尝试使用与 jenkins 上相同的参数（来自终端）在本地机器上运行测试，如果它会失败，则意味着问题出在参数中