Mockito：方法的返回值取决于调用的其他方法

Question

在我的单元测试中，我需要模拟一个在不同方法中具有nextItem() 和isEmpty() 方法的接口：

public interface MyQueue {
    Item nextItem();
    boolean isEmpty();
    //other methods
    ...
}

我对模拟的要求是 isEmpty() 最初应该返回 false，但在 nextItem() 被调用之后 isEmpty() 应该返回 true。因此，我正在用一个项目模拟一个队列。

1. 用 mockito 实现这种模拟的最简单方法是什么？
2. 能否实现附加要求：第二次、第三次调用nextItem() 等等会导致特定类型的异常？

附：我不想为测试提供我的接口的完整实现，因为其中有其他方法，导致代码难以理解和冗长。

Answer 1

您可以使用 thenAnswer() 来实现，Mockito 文档认为这是一个有争议的功能：

Mockito 最初并未包含的另一个有争议的功能。我们建议仅使用带有 toReturn() 或 toThrow() 的简单存根。这两个应该足以测试/试驾任何干净简单的代码。

下面是答案：

private boolean called = false;

when(mock.nextItem()).thenAnswer(new Answer() {
 Object answer(InvocationOnMock invocation) {   
     called = true;       
     return item;
 }
when(mock.isEmpty()).thenAnswer(new Answer() {
 Object answer(InvocationOnMock invocation) {          
     return called;
 }
});

Answer 2

这是一个简单的例子：

//given
MyQueue mock = mock(MyQueue.class);

given(mock.isEmpty()).willReturn(false, true);
given(mock.nextItem()).willReturn(someItem);

//when
mock.isEmpty();   //yields false
mock.nextItem();  //yields someItem
mock.isEmpty();   //yields true

//then
InOrder inOrder = inOrder(mock);
inOrder.verify(mock).isEmpty();
inOrder.verify(mock).nextItem();
inOrder.verify(mock).isEmpty();

willReturn(false, true) 表示：在第一次调用时返回 false，在第二次调用时返回 true。 InOrder 对象用于验证调用顺序。更改顺序或删除nextItem() 调用，测试将失败。

您也可以使用以下语法：

given(mock.isEmpty()).
        willReturn(false).
        willReturn(true).
        willThrow(SpecialException.class);

如果需要更强大的 mocking 语义，可以引入重炮——自定义应答回调：

given(mock.isEmpty()).willAnswer(new Answer<Boolean>() {
    private int counter = 0;
    @Override
    public Boolean answer(InvocationOnMock invocation) throws Throwable {
        switch(++counter) {
            case 1: return false;
            case 2: return true;
            default: throw new SpecialException();
        }
    }
});

但这很容易导致无法维护的测试代码，谨慎使用。

最后你可以spy your real object 只模拟选定的方法。

Answer 3

您可以提供一些自定义 Answer 实现，其中一个依赖于另一个：

public class NextItemAnswer implements Answer<Item> {
   private int invocationCount = 0;
   private Item item;
   public NextItemAnswer(Item item) {
       this.item = item;
   }

   public Item answer(InvocationOnMock invocation) throws Throwable {
       invocationCount++;
       return item;
   }

   public int getInvocationCount() {
       return invocationCount;
   }
}

public class IsEmptyAnswer implements Answer<Boolean> {
   private NextItemAnswer nextItemAnswer;
   public IsEmptyAnswer(NextItemAnswer nextItemAnswer) {
       this.nextItemAnswer = nextItemAnswer;
   }
   public Boolean answer(InvocationOnMock invocation) throws Throwable {
       return nextItemAnswer.getInvocationCount() >= 0;
   }
}

然后使用它：

NextItemAnswer nextItemAnswer = new NextItemAnswer(item);
IsEmptyAnswer isEmptyAnswer = new IsEmptyAnswer(nextItemAnswer);

when(mock.isEmpty()).thenAnswer(isEmptyAnswer);
when(mock.nextItem()).thenAnswer(nextItemAnswer);

你可能会调整，因为我没有测试过这段代码，但方法应该是你需要的。

Answer 4

我确实意识到您明确写过您不想提供 MyQueue 的完整实现，但老实说，这将是我要做的第一件事。

事实上，为了使测试更容易测试，我经常提供相当复杂的接口/对象的“模拟”实现。我不是唯一一个这样认为的人：例如，Spring Framework 提供了许多复杂对象的模拟版本（MockHttpServletRequest、MockHttpServletResponse 等）。

在这种情况下，我会避免弄乱我的测试，并在单独的包中甚至在生产代码中提供此类。

MockQueue 将使您的测试比此处给出的其他（但正确的）响应更具可读性。

Answer 5

您可以使用the mockito docs 中描述的技术告诉 mockito 在对同一模拟方法的连续调用时做出不同的回答。

when(mock.isEmpty())
  .thenReturn(false)
  .thenReturn(true);

将使isEmpty() 调用仅在第一次调用时返回 true，并且

when(mock.nextItem())
  .thenReturn(item)
  .thenThrow(new NextOnEmptyQueueException())

将使nextItem() 在第一次调用时返回某些内容，并在以后的调用中抛出异常。

我不知道是否有可能使其中一种方法的结果取决于对另一种方法的调用顺序。如果确实有可能，我敢肯定它要复杂得多。

Answer 6

你可以制作一个实用方法，然后在任何你想要的地方使用它。

public static boolean mockHasInvocation(Object mock, String methodName, Object... args) {
    return mockingDetails(mock).getInvocations().stream()
            .anyMatch(o -> o.getMethod().getName().equals(methodName) && Arrays.equals(o.getArguments(), args));
}

简单用法：

if(mockHasInvocation(mockObject, "methodName", "argument1", "argument2")){doSomething();}

在这种情况下，您不需要任何额外的变量，它更像是“Mockito 风格”。