使模拟方法返回传递给它的参数

Question

考虑这样的方法签名：

public String myFunction(String abc);

Mockito 可以帮助返回该方法收到的相同字符串吗？

Answer 1

从 Mockito 1.9.5+ 和 Java 8+ 开始，

您可以使用 lambda 表达式，例如：

when(myMock.myFunction(anyString())).thenAnswer(i -> i.getArguments()[0]);

其中 i 是 InitationOnMock 的实例。

对于旧版本，

您可以在 Mockito 中创建答案。假设我们有一个名为 MyInterface 的接口，其方法为 myFunction。

public interface MyInterface {
    public String myFunction(String abc);
}

这是带有 Mockito 答案的测试方法：

public void testMyFunction() throws Exception {
    MyInterface mock = mock(MyInterface.class);
    when(mock.myFunction(anyString())).thenAnswer(new Answer<String>() {
    @Override
    public String answer(InvocationOnMock invocation) throws Throwable {
        Object[] args = invocation.getArguments();
        return (String) args[0];
    }
    });

    assertEquals("someString",mock.myFunction("someString"));
    assertEquals("anotherString",mock.myFunction("anotherString"));
}

Answer 2

如果您有 Mockito 1.9.5 或更高版本，有一个新的静态方法可以为您创建 Answer 对象。您需要编写类似

import static org.mockito.Mockito.when;
import static org.mockito.AdditionalAnswers.returnsFirstArg;

when(myMock.myFunction(anyString())).then(returnsFirstArg());

或替代的

doAnswer(returnsFirstArg()).when(myMock).myFunction(anyString());

内容请注意，returnsFirstArg() 方法在 AdditionalAnswers 类中是静态的，这是 Mockito 1.9.5 中新增的；所以你需要正确的静态导入。

Answer 3

使用 Java 8，即使使用旧版本的 Mockito，也可以创建一行答案：

when(myMock.myFunction(anyString()).then(i -> i.getArgumentAt(0, String.class));

当然，这不如使用 David Wallace 建议的 AdditionalAnswers 有用，但如果您想这样做，可能会很有用“即时”转换参数。

Answer 4

我有一个非常相似的问题。目标是模拟一个持久保存对象并可以按名称返回它们的服务。该服务如下所示：

public class RoomService {
    public Room findByName(String roomName) {...}
    public void persist(Room room) {...}
}

服务模拟使用映射来存储 Room 实例。

RoomService roomService = mock(RoomService.class);
final Map<String, Room> roomMap = new HashMap<String, Room>();

// mock for method persist
doAnswer(new Answer<Void>() {
    @Override
    public Void answer(InvocationOnMock invocation) throws Throwable {
        Object[] arguments = invocation.getArguments();
        if (arguments != null && arguments.length > 0 && arguments[0] != null) {
            Room room = (Room) arguments[0];
            roomMap.put(room.getName(), room);
        }
        return null;
    }
}).when(roomService).persist(any(Room.class));

// mock for method findByName
when(roomService.findByName(anyString())).thenAnswer(new Answer<Room>() {
    @Override
    public Room answer(InvocationOnMock invocation) throws Throwable {
        Object[] arguments = invocation.getArguments();
        if (arguments != null && arguments.length > 0 && arguments[0] != null) {
            String key = (String) arguments[0];
            if (roomMap.containsKey(key)) {
                return roomMap.get(key);
            }
        }
        return null;
    }
});

我们现在可以在这个模拟上运行我们的测试。例如：

String name = "room";
Room room = new Room(name);
roomService.persist(room);
assertThat(roomService.findByName(name), equalTo(room));
assertNull(roomService.findByName("none"));

Answer 5

使用 Java 8，Steve 的答案 可以变得

public void testMyFunction() throws Exception {
    Application mock = mock(Application.class);
    when(mock.myFunction(anyString())).thenAnswer(
    invocation -> {
        Object[] args = invocation.getArguments();
        return args[0];
    });

    assertEquals("someString", mock.myFunction("someString"));
    assertEquals("anotherString", mock.myFunction("anotherString"));
}

编辑：甚至更短：

public void testMyFunction() throws Exception {
    Application mock = mock(Application.class);
    when(mock.myFunction(anyString())).thenAnswer(
        invocation -> invocation.getArgument(0));

    assertEquals("someString", mock.myFunction("someString"));
    assertEquals("anotherString", mock.myFunction("anotherString"));
}

Answer 6

这是一个很老的问题，但我认为仍然相关。此外，接受的答案仅适用于字符串。与此同时，Mockito 2.1 和一些导入已经改变，所以我想分享我当前的答案：

import static org.mockito.AdditionalAnswers.returnsFirstArg;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;

@Mock
private MyClass myClass;

// this will return anything you pass, but it's pretty unrealistic
when(myClass.myFunction(any())).then(returnsFirstArg());
// it is more "life-like" to accept only the right type
when(myClass.myFunction(any(ClassOfArgument.class))).then(returnsFirstArg());

myClass.myFunction 看起来像：

public class MyClass {
    public ClassOfArgument myFunction(ClassOfArgument argument){
        return argument;
    }  
}

Answer 7

这有点旧了，但我来这里是因为我遇到了同样的问题。我正在使用 JUnit，但这次是在带有 mockk 的 Kotlin 应用程序中。我在这里发布一个示例以供参考并与 Java 对应部分进行比较：

@Test
fun demo() {
  // mock a sample function
  val aMock: (String) -> (String) = mockk()

  // make it return the same as the argument on every invocation
  every {
    aMock.invoke(any())
  } answers {
    firstArg()
  }

  // test it
  assertEquals("senko", aMock.invoke("senko"))
  assertEquals("senko1", aMock.invoke("senko1"))
  assertNotEquals("not a senko", aMock.invoke("senko"))
}

Answer 8

您可以通过使用ArgumentCaptor来实现这一点

想象一下您有像这样的bean函数。

public interface Application {
  public String myFunction(String abc);
}

然后在您的测试类中：

//Use ArgumentCaptor to capture the value
ArgumentCaptor<String> param = ArgumentCaptor.forClass(String.class);


when(mock.myFunction(param.capture())).thenAnswer(new Answer<String>() {
    @Override
    public String answer(InvocationOnMock invocation) throws Throwable {
      return param.getValue();//return the captured value.
    }
  });

或者如果您喜欢 lambda，只需执行以下操作：

//Use ArgumentCaptor to capture the value
ArgumentCaptor<String> param = ArgumentCaptor.forClass(String.class);


when(mock.myFunction(param.capture()))
    .thenAnswer((invocation) -> param.getValue());

摘要：使用 argumentcaptor 来捕获传递的参数。稍后在回答中返回使用 getValue 捕获的值。

Answer 9

您可能希望将 verify() 与 ArgumentCaptor 结合使用，以确保测试中的执行，并使用 ArgumentCaptor 来评估参数：

ArgumentCaptor<String> argument = ArgumentCaptor.forClass(String.class);
verify(mock).myFunction(argument.capture());
assertEquals("the expected value here", argument.getValue());

参数的值显然可以通过 argument.getValue() 访问，以进行进一步的操作/检查/其他操作。

Answer 10

我使用类似的东西（基本上是相同的方法）。有时，让模拟对象为某些输入返回预定义的输出很有用。事情是这样的：

private Hashtable<InputObject,  OutputObject> table = new Hashtable<InputObject, OutputObject>();
table.put(input1, ouput1);
table.put(input2, ouput2);

...

when(mockObject.method(any(InputObject.class))).thenAnswer(
       new Answer<OutputObject>()
       {
           @Override
           public OutputObject answer(final InvocationOnMock invocation) throws Throwable
           {
               InputObject input = (InputObject) invocation.getArguments()[0];
               if (table.containsKey(input))
               {
                   return table.get(input);
               }
               else
               {
                   return null; // alternatively, you could throw an exception
               }
           }
       }
       );