使用 Mockito 模拟类的成员变量

Question

我是开发新手，尤其是单元测试新手。 我想我的要求很简单，但我很想知道其他人对此的想法。

假设我有两个这样的课程 -

public class First {

    Second second ;

    public First(){
        second = new Second();
    }

    public String doSecond(){
        return second.doSecond();
    }
}

class Second {

    public String doSecond(){
        return "Do Something";
    }
}

假设我正在编写单元测试来测试First.doSecond() 方法。但是，假设我想像这样模拟Second.doSecond() 类。我正在使用 Mockito 来做到这一点。

public void testFirst(){
    Second sec = mock(Second.class);
    when(sec.doSecond()).thenReturn("Stubbed Second");

    First first = new First();
    assertEquals("Stubbed Second", first.doSecond());
}

我看到模拟没有生效并且断言失败。 有没有办法模拟我要测试的类的成员变量。 ?

Answer 1

您可以使用 ReflectionTestUtils 模拟 Mockito Mock 的成员变量

ReflectionTestUtils.setField(yourMock, "memberFieldName", value);

Answer 2

如果您仔细查看您的代码，您会发现测试中的 second 属性仍然是 Second 的一个实例，而不是模拟（您没有在代码中将模拟传递给 first )。

最简单的方法是在First 类中为second 创建一个setter，并显式传递给它的mock。

像这样：

public class First {

    Second second ;

    public First(){
        second = new Second();
    }

    public String doSecond(){
        return second.doSecond();
    }

    public void setSecond(Second second) {
        this.second = second;
    }


}

class Second {

    public String doSecond(){
        return "Do Something";
    }
}

....

public void testFirst(){
Second sec = mock(Second.class);
when(sec.doSecond()).thenReturn("Stubbed Second");


First first = new First();
first.setSecond(sec)
assertEquals("Stubbed Second", first.doSecond());
}

另一种方法是将Second 实例作为First 的构造函数参数传递。

如果你不能修改代码，我认为唯一的选择就是使用反射：

public void testFirst(){
    Second sec = mock(Second.class);
    when(sec.doSecond()).thenReturn("Stubbed Second");


    First first = new First();
    Field privateField = PrivateObject.class.
        getDeclaredField("second");

    privateField.setAccessible(true);

    privateField.set(first, sec);

    assertEquals("Stubbed Second", first.doSecond());
}

但您可能可以，因为很少对您无法控制的代码进行测试（尽管可以想象一个场景，您必须测试一个外部库，因为它的作者没有:)）

Answer 3

如果您想在 mockito 中替代 Spring 中的 ReflectionTestUtils，请使用

Whitebox.setInternalState(first, "second", sec);

Answer 4

如果您无法更改代码，这是不可能的。但我喜欢依赖注入，Mockito 支持它：

public class First {    
    @Resource
    Second second;

    public First() {
        second = new Second();
    }

    public String doSecond() {
        return second.doSecond();
    }
}

你的测试：

@RunWith(MockitoJUnitRunner.class)
public class YourTest {
   @Mock
   Second second;

   @InjectMocks
   First first = new First();

   public void testFirst(){
      when(second.doSecond()).thenReturn("Stubbed Second");
      assertEquals("Stubbed Second", first.doSecond());
   }
}

这是非常好的和简单的。

Answer 5

您需要提供一种访问成员变量的方法，以便您可以传入模拟（最常见的方法是设置方法或带参数的构造函数）。

如果您的代码未提供执行此操作的方法，则它被错误地考虑为 TDD（测试驱动开发）。

Answer 6

我遇到了同样的问题，因为 Mockito 不调用超级构造函数，所以没有设置私有值。以下是我如何通过反射增强模拟。

首先，我创建了一个 TestUtils 类，其中包含许多有用的实用程序，包括这些反射方法。每次实现反射访问都有些困难。我创建了这些方法来测试项目中的代码，这些项目出于某种原因没有模拟包并且我没有被邀请包含它。

public class TestUtils {
    // get a static class value
    public static Object reflectValue(Class<?> classToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField  = reflectField(classToReflect, fieldNameValueToFetch);
            reflectField.setAccessible(true);
            Object reflectValue = reflectField.get(classToReflect);
            return reflectValue;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch);
        }
        return null;
    }
    // get an instance value
    public static Object reflectValue(Object objToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField  = reflectField(objToReflect.getClass(), fieldNameValueToFetch);
            Object reflectValue = reflectField.get(objToReflect);
            return reflectValue;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch);
        }
        return null;
    }
    // find a field in the class tree
    public static Field reflectField(Class<?> classToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField = null;
            Class<?> classForReflect = classToReflect;
            do {
                try {
                    reflectField = classForReflect.getDeclaredField(fieldNameValueToFetch);
                } catch (NoSuchFieldException e) {
                    classForReflect = classForReflect.getSuperclass();
                }
            } while (reflectField==null || classForReflect==null);
            reflectField.setAccessible(true);
            return reflectField;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch +" from "+ classToReflect);
        }
        return null;
    }
    // set a value with no setter
    public static void refectSetValue(Object objToReflect, String fieldNameToSet, Object valueToSet) {
        try {
            Field reflectField  = reflectField(objToReflect.getClass(), fieldNameToSet);
            reflectField.set(objToReflect, valueToSet);
        } catch (Exception e) {
            fail("Failed to reflectively set "+ fieldNameToSet +"="+ valueToSet);
        }
    }

}

然后我可以用这样的私有变量来测试这个类。这对于在您无法控制的类树中进行深度模拟很有用。

@Test
public void testWithRectiveMock() throws Exception {
    // mock the base class using Mockito
    ClassToMock mock = Mockito.mock(ClassToMock.class);
    TestUtils.refectSetValue(mock, "privateVariable", "newValue");
    // and this does not prevent normal mocking
    Mockito.when(mock.somthingElse()).thenReturn("anotherThing");
    // ... then do your asserts
}

我在页面中修改了我的实际项目中的代码。可能有一两个编译问题。我想你明白了。如果您觉得有用，请随意获取代码并使用它。

Answer 7

是的，这可以做到，如下面的测试所示（使用我开发的 JMockit 模拟 API 编写）：

@Test
public void testFirst(@Mocked final Second sec) {
    new NonStrictExpectations() {{ sec.doSecond(); result = "Stubbed Second"; }};

    First first = new First();
    assertEquals("Stubbed Second", first.doSecond());
}

但是，对于 Mockito，无法编写这样的测试。这是由于在 Mockito 中实现模拟的方式，其中创建了要模拟的类的子类；只有这个“模拟”子类的实例可以具有模拟行为，所以你需要让被测试的代码使用它们而不是任何其他实例。

Answer 8

许多其他人已经建议您重新考虑您的代码以使其更具可测试性 - 很好的建议，通常比我将要建议的更简单。

如果您无法更改代码以使其更具可测试性，PowerMock：https://code.google.com/p/powermock/

PowerMock 扩展了 Mockito（因此您不必学习新的模拟框架），提供额外的功能。这包括让构造函数返回模拟的能力。功能强大，但有点复杂 - 所以请谨慎使用。

您使用不同的模拟跑步者。并且您需要准备要调用构造函数的类。 （注意这是一个常见的陷阱——准备调用构造函数的类，而不是构造的类）

@RunWith(PowerMockRunner.class)
@PrepareForTest({First.class})

然后在您的测试设置中，您可以使用 whenNew 方法让构造函数返回一个模拟

whenNew(Second.class).withAnyArguments().thenReturn(mock(Second.class));

Answer 9

如果你不能改变成员变量，那么另一种方法是使用powerMockit并调用

Second second = mock(Second.class)
when(second.doSecond()).thenReturn("Stubbed Second");
whenNew(Second.class).withAnyArguments.thenReturn(second);

现在的问题是对 new Second 的任何调用都将返回相同的模拟实例。但在您的简单情况下，这将起作用。