Заставить смоделированный метод вернуть аргумент, который был ему передан


675

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

public String myFunction(String abc);

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


Хорошо, как насчет любого фреймворка для java? В общем, это возможно с любым другим фреймворком, или я должен просто создать тупую заглушку, чтобы имитировать поведение, которое я хочу?
Абхиджит Кашня

Ответы:


1001

Вы можете создать ответ в 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]);

1
Это то, что я тоже искал. Спасибо! Моя проблема была другой, хотя. Я хочу смоделировать службу персистентности (EJB), которая хранит объекты и возвращает их по имени.
Migu

7
Я создал дополнительный класс, который оборачивает создание ответа. Таким образом, код читается какwhen(...).then(Return.firstParameter())
SpaceTrucker

69
С Java 8 лямбды это ужин легко вернуть первый аргумент, даже для конкретного класса, то есть when(foo(any()).then(i -> i.getArgumentAt(0, Bar.class)). И вы также можете использовать ссылку на метод и вызывать реальный метод.
Павел Дида

Это решает мою проблему с методом return, Iterator<? extends ClassName>который вызывает всевозможные проблемы приведения в thenReturn()выражении.
Михаил Шопсин

16
С Java 8 и Mockito <1.9.5 , то ответ Pawel становитсяwhen(foo(any()).thenAnswer(i -> i.getArguments()[0])
Graeme Мосс

567

Если у вас 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; так что вам нужен правильный статический импорт.


17
Примечание: это when(...).then(returnsFirstArg()), я по ошибке имел, when(...).thenReturn(returnsFirstArg())который далjava.lang.ClassCastException: org.mockito.internal.stubbing.answers.ReturnsArgumentAt cannot be cast to
Бенедикт Кеппел

1
Примечание: returnFirstArg () возвращает Answer <>, а не значение аргумента. Полученный 'Foo (java.lang.String) не может быть применен к' (org.mockito.stubbing.Answer <java.lang.Object>) 'при попытке вызвать .thenReturn (новый Foo (returnFirstArg ()))
Lu55

Мне всегда нужно гуглить этот ответ снова и снова и снова в течение последних лет, так как я просто не могу вспомнить «Дополнительные ответы», и он мне нужен очень редко. Тогда мне интересно, как, черт возьми, я могу построить этот сценарий, так как я не могу найти необходимые зависимости. Разве это не может быть добавлено непосредственно в mockito? : /
BAERUS

2
Ответ Стива более общий. Это только позволяет вам вернуть необработанный аргумент. Если вы хотите обработать этот аргумент и вернуть результат, тогда ответьте Стиву. Я проголосовал за обоих, поскольку они оба полезны.
Акостадинов

К вашему сведению, мы должны импортировать static org.mockito.AdditionalAnswers.returnsFirstArg. это использовать returnFirstArg. Кроме того, я могу сделать when(myMock.myFunction(any())).then(returnsFirstArg())в Mockito 2.20. *
gtiwari333

78

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

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

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


1
Brilliant. Спасибо. Если аргумент есть long, это все еще может работать с боксом и Long.class?
Викингстев

1
.getArgumentAt (..) не был найден для меня, но .getArgument (1) сработал (mockito 2.6.2)
Кертис Яллоп

41

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

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

34

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

6

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

4

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

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

4

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

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

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


3

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

2

Вы можете достичь этого с помощью ArgumentCaptor

Представьте, что у вас есть функция боба, вот так.

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

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


Это не работает (больше?). Относительно документов: Этот метод должен использоваться внутри проверки. Это означает, что вы можете захватить значение только при использовании метода проверки
Мухаммед Мисир

1. Не уверен, что вы имеете в виду, у This doesn´t work (anymore?).меня есть это работает на моем экземпляре. 2. Извините, мне непонятно, что вы пытаетесь сделать. Ответ специфичен для вопроса ОП.
Кирилл Шериан
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.