Mockito фиктивные примеры

Фреймворк Mockito предоставляет различные способы имитации класса. Давайте рассмотрим различные методы, с помощью которых мы можем имитировать класс и заглушать его поведение.

Мокирующий метод мокито

Мы можем использовать метод mock() класса Mockito для создания фиктивного объекта данного класса или интерфейса. Это самый простой способ имитировать объект.

package com.journaldev.mockito.mock;

import java.util.List;

import static org.mockito.Mockito.*;
import static org.junit.jupiter.api.Assertions.*;
import org.junit.jupiter.api.Test;

public class MockitoMockMethodExample {

	@SuppressWarnings("unchecked")
	@Test
	public void test() {
		// using Mockito.mock() method
		List<String> mockList = mock(List.class);
		when(mockList.size()).thenReturn(5);
		assertTrue(mockList.size()==5);
	}
	
}

Мы используем JUnit 5 для написания тестовых случаев в сочетании с Mockito для имитации объектов.

Мокито @Mock Аннотация

Мы можем смоделировать объект, используя аннотацию @Mock, мы должны убедиться, что вызываем MockitoAnnotations.initMocks(this) для инициализации смоделированного объекта. Мы можем сделать это при тестировании методов настройки фреймворка, которые выполняются перед тестами.

package com.journaldev.mockito.mock;

import java.util.List;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

public class MockitoMockAnnotationExample {

	@Mock
	List<String> mockList;
	
	@BeforeEach
	public void setup() {
		//if we don't call below, we will get NullPointerException
		MockitoAnnotations.initMocks(this);
	}
	
	@SuppressWarnings("unchecked")
	@Test
	public void test() {
		when(mockList.get(0)).thenReturn("JournalDev");
		assertEquals("JournalDev", mockList.get(0));
	}
	
}

Мокито @InjectMocks Аннотация

Когда мы хотим внедрить фиктивный объект в другой фиктивный объект, мы можем использовать в нем @Mock.

package com.journaldev.mockito.mock;

import java.util.List;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

public class MockitoInjectMockAnnotationExample {

	@Mock
	List<String> mockList;
	
	//@InjectMock creates an instance of the class and 
	//injects the mocks that are marked with the annotations @Mock into it.
	@InjectMocks
	Fruits mockFruits;
	
	@BeforeEach
	public void setup() {
		//if we don't call below, we will get NullPointerException
		MockitoAnnotations.initMocks(this);
	}
	
	@SuppressWarnings("unchecked")
	@Test
	public void test() {
		when(mockList.get(0)).thenReturn("Apple");
		when(mockList.size()).thenReturn(1);
		assertEquals("Apple", mockList.get(0));
		assertEquals(1, mockList.size());
		
		//mockFruits names is using mockList, below asserts confirm it
		assertEquals("Apple", mockFruits.getNames().get(0));
		assertEquals(1, mockFruits.getNames().size());	
		
		mockList.add(1, "Mango");
		//below will print null because mockList.get(1) is not stubbed
		System.out.println(mockList.get(1));
	}
	
}

class Fruits{
	private List<String> names;

	public List<String> getNames() {
		return names;
	}

	public void setNames(List<String> names) {
		this.names = names;
	}
	
}

Mockito spy() для частичного издевательства

Если мы хотим имитировать только определенное поведение и вызывать настоящие методы для незаглушенного поведения, мы можем создать объект-шпион, используя метод Mockito spy().

package com.journaldev.mockito.mock;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.when;

import java.util.ArrayList;
import java.util.List;

import org.junit.jupiter.api.Test;

public class MockitoSpyMethodExample {

	@Test
	public void test() {
		List<String> list = new ArrayList<>();
		List<String> spyOnList = spy(list);
		
		when(spyOnList.size()).thenReturn(10);
		assertEquals(10, spyOnList.size());
		
		//calling real methods since below methods are not stubbed
		spyOnList.add("Pankaj");
		spyOnList.add("Meghna");
		assertEquals("Pankaj", spyOnList.get(0));
		assertEquals("Meghna", spyOnList.get(1));
	}
	
}

Мокито @Spy Аннотация

Мы можем использовать аннотацию @Spy, чтобы шпионить за объектом. Давайте рассмотрим простой пример.

package com.journaldev.mockito.mock;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.MockitoAnnotations;
import org.mockito.Spy;

public class MockitoSpyAnnotationExample {

	@Spy
	Utils mockUtils;
	
	@BeforeEach
	public void setup() {
		MockitoAnnotations.initMocks(this);
	}
	
	@Test
	public void test() {
		when(mockUtils.process(1, 1)).thenReturn(5);
		//mocked method
		assertEquals(5, mockUtils.process(1, 1));
		//real method called since it's not stubbed
		assertEquals(20, mockUtils.process(19, 1));
		
	}
	
}

class Utils{
	public int process(int x, int y) {
		System.out.println("Input Params = "+x+","+y);
		return x+y;
	}
}

Обратите внимание, что конструктор инициализировал фиктивный объект. Если в вашем классе его нет, вы получите следующую ошибку.

org.mockito.exceptions.base.MockitoException: Unable to initialize @Spy annotated field 'mockUtils'.
Please ensure that the type 'Utils' has a no-arg constructor.
	at com.journaldev.mockito.mock.MockitoSpyAnnotationExample.setup(MockitoSpyAnnotationExample.java:18)

Также обратите внимание, что Mockito не может создавать экземпляры внутренних классов, локальных классов, абстрактных классов и интерфейсов. Поэтому всегда полезно предоставить экземпляр для слежки. В противном случае настоящие методы могут не вызываться и просто игнорироваться. Например, если вы укажете шпионский объект, как показано ниже:

@Spy
List<String> spyList;

Вы заметите, что при вызове методов add() или get() настоящие методы не вызываются. Если вы укажете шпионский объект, как показано ниже, все будет работать нормально.

@Spy
List<String> spyList = new ArrayList<>();

Резюме

Фреймворк Mockito позволяет нам легко создавать фиктивные объекты с помощью различных методов и аннотаций. Мы также можем внедрить фиктивный объект в другой фиктивный объект, это очень полезная функция.

Вы можете посмотреть другие примеры Mockito в нашем репозитории GitHub.