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

时间:2010-04-21 16:11:42

标签: java mockito

考虑方法签名,如:

public String myFunction(String abc);

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

10 个答案:

答案 0 :(得分:868)

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

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

以下是Mockito答案的测试方法:

public void testMyFunction() throws Exception {
  Application mock = mock(Application.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"));
}

从Mockito 1.9.5和Java 8开始,使用lambda函数有一种更简单的方法:

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

答案 1 :(得分:491)

如果你有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的新增内容;所以你需要正确的静态导入。

答案 2 :(得分:57)

使用Java 8,即使使用较旧版本的Mockito,也可以创建一个单行答案:

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

当然,这不如使用David Wallace建议的AdditionalAnswers那么有用,但如果您想“动态”转换参数可能会有用。

答案 3 :(得分:37)

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

public class RoomService {
    public Room findByName(String roomName) {...}
    public void persist(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"));

答案 4 :(得分:29)

使用Java 8,Steve's answer可以成为

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"));
}

答案 5 :(得分:5)

我使用类似的东西(基本上它是相同的方法)。有时,让模拟对象返回某些输入的预定义输出是有用的。就是这样:

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
               }
           }
       }
       );

答案 6 :(得分:1)

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

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

显然可以通过argument.getValue()访问参数的值,以便进一步操作/检查/无论如何。

答案 7 :(得分:1)

这是一个相当老的问题,但我认为仍然很重要。同样,可接受的答案仅适用于String。同时,有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;
    }  
}

答案 8 :(得分:1)

您可以使用 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());

摘要:使用argumentscaptor捕获传递的参数。稍后,返回使用getValue捕获的值。

答案 9 :(得分:0)

这有点老了,但是我来这里是因为我有同样的问题。我正在使用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"))
}