- Вызовы mock-методов с параметрами
- 4.2 Шаблоны параметров
- 4.3 Метод doAnswer()
- Mockito Argument Matchers — any(), eq()
- Mockito Argument Matchers — any()
- Mockito Argument Matcher — eq()
- Mockito AdditionalMatchers
- Mockito Verify Argument Matchers
- Summary
- Вызовы mock-методов с параметрами
- 4.2 Шаблоны параметров
- 4.3 Метод doAnswer()
Вызовы mock-методов с параметрами
Предыдущие правила добавленные мок-объекту касались методов без параметров. А как создавать правила для методов с параметрами? Более того, хотелось бы создавать правила, чтобы при одних значениях параметров был один результат, а при других – другой.
Так тоже можно делать. Если вы хотите, чтобы при определенном параметре метод возвращал что-то определенное, то правило можно записать так:
Mockito.doReturn(результат).when(объект).имяМетода(параметр);И сразу рассмотрим пример, чтобы лучше все понять. Пусть наш List возвращает имя Иван при запросе 10-го элемента, и имя Марья при запросе 500-го. Сказано – сделано.
@ExtendWith(MockitoExtension.class) class ParamsTest < @Mock List mockList; @Test public void whenMockAnnotation() < //добавление первого правила Mockito.doReturn("Иван").when(mockList).get(10); //добавление второго правила Mockito.doReturn("Марья").when(mockList).get(500); assertEquals("Иван", mockList.get(10)); assertEquals("Марья", mockList.get(500)); > > 4.2 Шаблоны параметров
И сразу хитрые коллеги зададут мне вопрос: “А как быть, если метод требует аргументы, но при любых значениях должен возвращать один и тот же результат?”. Не будем же мы писать:
Mockito.doReturn("Иван").when(mockList).get(1); Mockito.doReturn("Иван").when(mockList).get(2); Mockito.doReturn("Иван").when(mockList).get(99); Нет, никто тебя так писать не заставляет. Если ты хочешь добавить правило mock-объекту, которое действует для метода с любыми аргументами, то для этого есть специальный объект:
Наш пример с его помощью будет записан так:
Mockito.doReturn("Иван").when(mockList).get(any(int.class));Есть тут пара нюансов. Объект Mockito.any() имеет тип Object , поэтому для параметров разных типов есть его аналоги:
| Метод | Тип параметра | |
|---|---|---|
| 1 | any() | Object, включая null |
| 2 | any(ClassName.class) | ClassName |
| 3 | anyInt() | int |
| 4 | anyBoolean() | boolean |
| 5 | anyDouble() | double |
| 6 | anyList() | List |
Более корректно наш пример будет выглядеть так:
Mockito.doReturn("Иван").when(mockList).get(anyInt());4.3 Метод doAnswer()
Мы добрались до сложного поведения виртуальных методов. Рано или поздно наступит ситуация, когда ты захочешь, чтобы этот виртуальный метод имел сложное поведение. Например, он должен возвращать значения в зависимости от параметров, преобразовывать строку в верхний регистр.
Для этого есть специальный метод – doAnswer() , в который передается функция, которая делает то, что тебе нужно:
Mockito.doAnswer(функция).when(объект).имяМетода(параметр);Давай заставим метод get() класса List возвращать квадрат переданного ему аргумента. И напишем такую программу:
@ExtendWith(MockitoExtension.class) class DoAnswerTest < @Mock List mockList; @Test public void whenMockAnnotation() < Mockito.doAnswer(invocation ->< int parameter = invocation.getArgument(0); return parameter * parameter; >).when(mockList).get(anyInt()); assertEquals(100, mockList.get(10)); assertEquals(25, mockList.get(5)); > > Функцию мы задали с помощью объект класса Answer.
Mockito Argument Matchers — any(), eq()
While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.
Mockito allows us to create mock objects and stub the behavior for our test cases. We usually mock the behavior using when() and thenReturn() on the mock object.
Mockito Argument Matchers — any()
Sometimes we want to mock the behavior for any argument of the given type, in that case, we can use Mockito argument matchers. Mockito argument methods are defined in org.mockito.ArgumentMatchers class as static methods. Let’s say we have a class defined as:
class Foo < boolean bool(String str, int i, Object obj) < return false; >int in(boolean b, List strs) < return 0; >int bar(byte[] bytes, String[] s, int i) < return 0; >> Foo mockFoo = mock(Foo.class); when(mockFoo.bool(anyString(), anyInt(), any(Object.class))).thenReturn(true); We are stubbing bool() method to return “true” for any string, integer and object arguments. All the below assertions will pass in this case:
assertTrue(mockFoo.bool("A", 1, "A")); assertTrue(mockFoo.bool("B", 10, new Object())); Mockito Argument Matcher — eq()
When we use argument matchers, then all the arguments should use matchers. If we want to use a specific value for an argument, then we can use eq() method.
when(mockFoo.bool(eq("false"), anyInt(), any(Object.class))).thenReturn(false); assertFalse(mockFoo.bool("false", 10, new Object())); when(mockFoo.in(anyBoolean(), anyList())).thenReturn(10); any(byte[].class) any(Object[].class) Mockito AdditionalMatchers
Mockito org.mockito.AdditionalMatchers class provides some rarely used matchers. We can specify arguments to be greater than, less than, perform OR, AND, NOT operations. We can also check for equality of arrays.
when(mockFoo.bar(any(byte[].class), aryEq(new String[] < "A", "B" >), gt(10))).thenReturn(11); So if we call bar() method with any byte array as argument, second argument as < “A”, “B” >and third argument greater than 10, then the stubbed method will return 11. Below assertions will pass for our stubbed method.
assertEquals(11, mockFoo.bar("abc".getBytes(), new String[] < "A", "B" >, 20)); assertEquals(11, mockFoo.bar("xyz".getBytes(), new String[] < "A", "B" >, 99)); Mockito Verify Argument Matchers
Mockito argument matchers can be used only with when() and verify() methods. Let’s look at a few examples of using argument matchers in Mockito verify method.
verify(mockFoo, atLeast(0)).bool(anyString(), anyInt(), any(Object.class)); verify(mockFoo, atLeast(0)).bool(eq("false"), anyInt(), any(Object.class)); Summary
Mockito argument matcher methods are very useful in stubbing behaviors in a generic way. There are many methods to cover almost all the requirements. You can look at more Mockito examples from our GitHub Repository.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases. Learn more about us
Вызовы mock-методов с параметрами
Предыдущие правила добавленные мок-объекту касались методов без параметров. А как создавать правила для методов с параметрами? Более того, хотелось бы создавать правила, чтобы при одних значениях параметров был один результат, а при других – другой.
Так тоже можно делать. Если вы хотите, чтобы при определенном параметре метод возвращал что-то определенное, то правило можно записать так:
Mockito.doReturn(результат).when(объект).имяМетода(параметр);И сразу рассмотрим пример, чтобы лучше все понять. Пусть наш List возвращает имя Иван при запросе 10-го элемента, и имя Марья при запросе 500-го. Сказано – сделано.
@ExtendWith(MockitoExtension.class) class ParamsTest < @Mock List mockList; @Test public void whenMockAnnotation() < //добавление первого правила Mockito.doReturn("Иван").when(mockList).get(10); //добавление второго правила Mockito.doReturn("Марья").when(mockList).get(500); assertEquals("Иван", mockList.get(10)); assertEquals("Марья", mockList.get(500)); > > 4.2 Шаблоны параметров
И сразу хитрые коллеги зададут мне вопрос: “А как быть, если метод требует аргументы, но при любых значениях должен возвращать один и тот же результат?”. Не будем же мы писать:
Mockito.doReturn("Иван").when(mockList).get(1); Mockito.doReturn("Иван").when(mockList).get(2); Mockito.doReturn("Иван").when(mockList).get(99); Нет, никто тебя так писать не заставляет. Если ты хочешь добавить правило mock-объекту, которое действует для метода с любыми аргументами, то для этого есть специальный объект:
Наш пример с его помощью будет записан так:
Mockito.doReturn("Иван").when(mockList).get(any(int.class));Есть тут пара нюансов. Объект Mockito.any() имеет тип Object , поэтому для параметров разных типов есть его аналоги:
| Метод | Тип параметра | |
|---|---|---|
| 1 | any() | Object, включая null |
| 2 | any(ClassName.class) | ClassName |
| 3 | anyInt() | int |
| 4 | anyBoolean() | boolean |
| 5 | anyDouble() | double |
| 6 | anyList() | List |
Более корректно наш пример будет выглядеть так:
Mockito.doReturn("Иван").when(mockList).get(anyInt());4.3 Метод doAnswer()
Мы добрались до сложного поведения виртуальных методов. Рано или поздно наступит ситуация, когда ты захочешь, чтобы этот виртуальный метод имел сложное поведение. Например, он должен возвращать значения в зависимости от параметров, преобразовывать строку в верхний регистр.
Для этого есть специальный метод – doAnswer() , в который передается функция, которая делает то, что тебе нужно:
Mockito.doAnswer(функция).when(объект).имяМетода(параметр);Давай заставим метод get() класса List возвращать квадрат переданного ему аргумента. И напишем такую программу:
@ExtendWith(MockitoExtension.class) class DoAnswerTest < @Mock List mockList; @Test public void whenMockAnnotation() < Mockito.doAnswer(invocation ->< int parameter = invocation.getArgument(0); return parameter * parameter; >).when(mockList).get(anyInt()); assertEquals(100, mockList.get(10)); assertEquals(25, mockList.get(5)); > > Функцию мы задали с помощью объект класса Answer.