Как я могу заставить метод возвращать аргумент, который был ему передан?

Рассмотрим сигнатуру метода, например:

public String myFunction(String abc);

Может ли Mockito помочь вернуть ту же строку, что и метод?

8 ответов

Решение

Вы можете создать ответ в 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, есть еще более простой способ использования лямбда-функций:

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

Если у вас Mockito 1.9.5 или выше, есть новый статический метод, который может сделать Answer объект для вас. Вам нужно написать что-то вроде

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

или в качестве альтернативы

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

Обратите внимание, что returnsFirstArg() метод является статическим в AdditionalAnswers класс, который является новым для Mockito 1.9.5; так что вам нужен правильный статический импорт.

С помощью Java 8 можно создать однострочный ответ даже в более старой версии Mockito:

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

Конечно, это не так полезно, как использование AdditionalAnswers предложенный Дэвидом Уоллесом, но может быть полезным, если вы хотите преобразовать аргумент "на лету".

С Java 8 ответ Стива может стать

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

У меня была очень похожая проблема. Цель состояла в том, чтобы издеваться над сервисом, который сохраняет объекты и может вернуть их по имени. Сервис выглядит так:

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

Это довольно старый вопрос, но я думаю, что все еще актуален. Также принятый ответ работает только для 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;
    }  
}

Это немного устарело, но я пришел сюда, потому что у меня была такая же проблема. Я использую JUnit, но на этот раз в приложении Kotlin с mockk. Я размещаю здесь образец для справки и сравнения с аналогом 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"))
}

Вы можете добиться этого, используя 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.
    }
  });

ИЛИ, если вы поклонник лямбды, просто выполните:

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


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

Сводка: используйте аргумент captor, чтобы зафиксировать переданный параметр. Позже в ответе верните значение, полученное с помощью getValue.

Возможно, вы захотите использовать verify() в сочетании с ArgumentCaptor для обеспечения выполнения в тесте и ArgumentCaptor для оценки аргументов:

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

Значение аргумента, очевидно, доступно через arguments.getValue() для дальнейшей манипуляции / проверки / чего угодно.

Я использую нечто подобное (в основном это тот же подход). Иногда полезно, чтобы фиктивный объект возвращал заранее определенные выходные данные для определенных входных данных. Это идет так:

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
               }
           }
       }
       );
Другие вопросы по тегам