Статьи

Начало работы с Mocking в Java с использованием Mockito

Январь 2, 2019

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

Чтобы показать, как можно использовать макеты, у меня есть уровень доступа к данным (DAL), в основном класс, который предоставляет API-интерфейс для доступа и изменения данных в хранилище данных. Затем я тестирую DAL без необходимости подключаться к хранилищу данных. Хранилище данных может быть локальной базой данных или удаленной базой данных или файловой системой или любым местом, где мы можем хранить и извлекать данные. Использование класса DAL помогает нам отделить средства отображения данных от кода приложения.

Давайте создадим проект Java, используя maven.

1
mvn archetype:generate -DgroupId=info.sanaulla -DartifactId=MockitoDemo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

Выше создается папка MockitoDemo, а затем создается вся структура каталогов для исходного и тестового файлов.

Рассмотрим класс модели ниже для этого примера:

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package info.sanaulla.models;
 
import java.util.List;
 
/**
* Model class for the book details.
*/
public class Book {
 
  private String isbn;
  private String title;
  private List<String> authors;
  private String publication;
  private Integer yearOfPublication;
  private Integer numberOfPages;
  private String image;
 
  public Book(String isbn,
              String title,
              List<String> authors,
              String publication,
              Integer yearOfPublication,
              Integer numberOfPages,
              String image){
 
    this.isbn = isbn;
    this.title = title;
    this.authors = authors;
    this.publication = publication;
    this.yearOfPublication = yearOfPublication;
    this.numberOfPages = numberOfPages;
    this.image = image;
 
  }
 
  public String getIsbn() {
    return isbn;
  }
 
  public String getTitle() {
    return title;
  }
 
  public List<String> getAuthors() {
    return authors;
  }
 
  public String getPublication() {
    return publication;
  }
 
  public Integer getYearOfPublication() {
    return yearOfPublication;
  }
 
  public Integer getNumberOfPages() {
    return numberOfPages;
  }
 
  public String getImage() {
    return image;
  }
}

Класс DAL для работы с классом модели Book:

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package info.sanaulla.dal;
 
import info.sanaulla.models.Book;
 
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
 
/**
* API layer for persisting and retrieving the Book objects.
*/
public class BookDAL {
 
  private static BookDAL bookDAL = new BookDAL();
 
  public List<Book> getAllBooks(){
      return Collections.EMPTY_LIST;
  }
 
  public Book getBook(String isbn){
      return null;
  }
 
  public String addBook(Book book){
      return book.getIsbn();
  }
 
  public String updateBook(Book book){
      return book.getIsbn();
  }
 
  public static BookDAL getInstance(){
      return bookDAL;
  }
}

Уровень DAL выше в настоящее время не имеет никакой функциональности, и мы собираемся протестировать этот фрагмент кода ( TDD ). Уровень DAL может взаимодействовать с ORM Mapper или Database API, который нас не касается при разработке API.

Тест-драйв слоя DAL

В Java существует множество платформ для модульного тестирования и моделирования, но для этого примера я бы выбрал JUnit для модульного тестирования и Mockito для моделирования . Мы должны обновить зависимость в pom.xml Maven

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>info.sanaulla</groupId>
  <artifactId>MockitoDemo</artifactId>
  <packaging>jar</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>MockitoDemo</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <!-- Dependency for JUnit -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.10</version>
      <scope>test</scope>
    </dependency>
    <!-- Dependency for Mockito -->
    <dependency>
      <groupId>org.mockito</groupId>
      <artifactId>mockito-all</artifactId>
      <version>1.9.5</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

Теперь давайте протестируем модуль BookDAL . Во время модульного тестирования мы будем вводить фиктивные данные в BookDAL, чтобы мы могли завершить тестирование API без зависимости от источника данных.

Изначально у нас будет пустой тестовый класс:

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
public class BookDALTest {
  public void setUp() throws Exception {
 
  }
 
  public void testGetAllBooks() throws Exception {
 
  }
 
  public void testGetBook() throws Exception {
 
  }
 
  public void testAddBook() throws Exception {
 
  }
 
  public void testUpdateBook() throws Exception {
 
  }
}

Мы BookDAL макет BookDAL и макет данных в setUp() как показано ниже:

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
public class BookDALTest {
 
  private static BookDAL mockedBookDAL;
  private static Book book1;
  private static Book book2;
 
  @BeforeClass
  public static void setUp(){
    //Create mock object of BookDAL
    mockedBookDAL = mock(BookDAL.class);
 
    //Create few instances of Book class.
    book1 = new Book("8131721019","Compilers Principles",
            Arrays.asList("D. Jeffrey Ulman","Ravi Sethi", "Alfred V. Aho", "Monica S. Lam"),
            "Pearson Education Singapore Pte Ltd", 2008,1009,"BOOK_IMAGE");
 
    book2 = new Book("9788183331630","Let Us C 13th Edition",
            Arrays.asList("Yashavant Kanetkar"),"BPB PUBLICATIONS", 2012,675,"BOOK_IMAGE");
 
    //Stubbing the methods of mocked BookDAL with mocked data.
    when(mockedBookDAL.getAllBooks()).thenReturn(Arrays.asList(book1, book2));
    when(mockedBookDAL.getBook("8131721019")).thenReturn(book1);
    when(mockedBookDAL.addBook(book1)).thenReturn(book1.getIsbn());
    when(mockedBookDAL.updateBook(book1)).thenReturn(book1.getIsbn());
  }
 
  public void testGetAllBooks() throws Exception {}
 
  public void testGetBook() throws Exception {}
 
  public void testAddBook() throws Exception {}
 
  public void testUpdateBook() throws Exception {}
}

В приведенном выше setUp() меня есть:

  1. Создан макет объекта BookDAL
    1
    BookDAL mockedBookDAL = mock(BookDAL.class);
  2. API-интерфейс BookDAL заглушен фиктивными данными, так что, когда бы ни вызывался API-интерфейс, возвращаемые данные будут возвращены.
    1
    2
    3
    4
    5
    //When getAllBooks() is invoked then return the given data and so on for the other methods.
    when(mockedBookDAL.getAllBooks()).thenReturn(Arrays.asList(book1, book2));
    when(mockedBookDAL.getBook("8131721019")).thenReturn(book1);
    when(mockedBookDAL.addBook(book1)).thenReturn(book1.getIsbn());
    when(mockedBookDAL.updateBook(book1)).thenReturn(book1.getIsbn());

Заполнив остальные тесты, мы получим:

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
package info.sanaulla.dal;
 
import info.sanaulla.models.Book;
import org.junit.BeforeClass;
import org.junit.Test;
 
import static org.junit.Assert.*;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
 
import java.util.Arrays;
import java.util.List;
 
public class BookDALTest {
 
  private static BookDAL mockedBookDAL;
  private static Book book1;
  private static Book book2;
 
  @BeforeClass
  public static void setUp(){
    mockedBookDAL = mock(BookDAL.class);
    book1 = new Book("8131721019","Compilers Principles",
            Arrays.asList("D. Jeffrey Ulman","Ravi Sethi", "Alfred V. Aho", "Monica S. Lam"),
            "Pearson Education Singapore Pte Ltd", 2008,1009,"BOOK_IMAGE");
 
    book2 = new Book("9788183331630","Let Us C 13th Edition",
            Arrays.asList("Yashavant Kanetkar"),"BPB PUBLICATIONS", 2012,675,"BOOK_IMAGE");
 
    when(mockedBookDAL.getAllBooks()).thenReturn(Arrays.asList(book1, book2));
    when(mockedBookDAL.getBook("8131721019")).thenReturn(book1);
    when(mockedBookDAL.addBook(book1)).thenReturn(book1.getIsbn());
 
    when(mockedBookDAL.updateBook(book1)).thenReturn(book1.getIsbn());
 
  }
 
  @Test
  public void testGetAllBooks() throws Exception {
 
    List<Book> allBooks = mockedBookDAL.getAllBooks();
    assertEquals(2, allBooks.size());
    Book myBook = allBooks.get(0);
    assertEquals("8131721019", myBook.getIsbn());
    assertEquals("Compilers Principles", myBook.getTitle());
    assertEquals(4, myBook.getAuthors().size());
    assertEquals((Integer)2008, myBook.getYearOfPublication());
    assertEquals((Integer) 1009, myBook.getNumberOfPages());
    assertEquals("Pearson Education Singapore Pte Ltd", myBook.getPublication());
    assertEquals("BOOK_IMAGE", myBook.getImage());
  }
 
  @Test
  public void testGetBook(){
 
    String isbn = "8131721019";
 
    Book myBook = mockedBookDAL.getBook(isbn);
 
    assertNotNull(myBook);
    assertEquals(isbn, myBook.getIsbn());
    assertEquals("Compilers Principles", myBook.getTitle());
    assertEquals(4, myBook.getAuthors().size());
    assertEquals("Pearson Education Singapore Pte Ltd", myBook.getPublication());
    assertEquals((Integer)2008, myBook.getYearOfPublication());
    assertEquals((Integer)1009, myBook.getNumberOfPages());
 
  }
 
  @Test
  public void testAddBook(){
    String isbn = mockedBookDAL.addBook(book1);
    assertNotNull(isbn);
    assertEquals(book1.getIsbn(), isbn);
  }
 
  @Test
  public void testUpdateBook(){
 
    String isbn = mockedBookDAL.updateBook(book1);
    assertNotNull(isbn);
    assertEquals(book1.getIsbn(), isbn);
  }
}

Тест можно запустить с помощью команды maven: mvn test . Выход:

01
02
03
04
05
06
07
08
09
10
11
-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running info.sanaulla.AppTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.029 sec
Running info.sanaulla.dal.BookDALTest
Tests run: 4, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.209 sec
 
Results :
 
Tests run: 5, Failures: 0, Errors: 0, Skipped: 0

Таким образом, мы смогли протестировать класс DAL без фактической настройки источника данных с помощью макетов.

Ссылка: Начало работы с Mocking в Java с использованием Mockito от нашего партнера по JCG Мохамеда Санауллы в блоге Experiences Unlimited .
62
Share: