JUnit+Mockitoで深い場所で呼ばれるクラスのmock化

Question

Spring Bootで開発したソースコードをJUnit+Mockitoでテストを行いたいと考えています。
以下のテストコードでは、ControllerとServiceの処理を確認するために、RepositoryのみをMock化したいと考えています。
( 本当は、Controller、Serviceでそれぞれテストコードを分けるべきだとは思っているのですが... )
Serviceの処理をMock化するのであれば、テストコードの変数controllerに@InjectMocksを付与し、
@Mockを付与したServiceの宣言を追加し、when(xxxx).thenReturn(xxxx)でServiceのメソッドで返したい値を定義してやればよいと思うのですが、ServiceではなくRepositoryのみをMock化したい場合はどうすればよいのかわかりません。
(というよりもそんなことができるのかもわかりません。)

何か方法はありますか？
申し訳ありませんが、ご教示をお願いします。

■テストコード

@RestController
@RequiredArgsConstructor
public class ControllerTest {

    MockMvc mockMvc;

    @Autowired
    private Controller controller;

    @BeforeEach
    public void initmocks() {
        MockitoAnnotations.initMocks(this);
        mockMvc = MockMvcBuilders.standaloneSetup(controller).build();
    }

    @Test
    public void test01() throws Exception {

        ResultActions results = mockMvc.perform(post("/items"));
        //  以下、略
    }
}

■Controller

@RestController
@RequiredArgsConstructor
public class Controller {

    @Autowired
    Service service;

    @PostMapping("/items")
    public ResponseEntity<ItemsResponse> getItemsByPost(@RequestBody body){
        String s1 = service.serviceMethod();
        //  以下、略
    }
}

■Service

@Service
@RequiredArgsConstructor
public class Service {

    @Autowired
    Repository repository;

    @Transactional(readOnly = true)
    public String serviceMethod() {
        String s2 = repository.selectOneXXX();
        // 以下、略
        // repository.selectOneXXX()の結果を受け取っていろいろ処理をする。
        return 処理結果
    }
}

■Repository

@Repository
public class Repository {
    public String selectOneXXX()
}

Comments

[rubytomato]

2点確認させてください。
・やりたいことはコントローラの結合テストで、ただDBアクセスを発生させたくないのでリポジトリをmock化したいということですか？
・Spring Boot、JUnitのバージョンはいくつですか？

[kumaneko]

ご回答ありがとうございます。

> ・やりたいことはコントローラの結合テストで、ただDBアクセスを発生させたくないのでリポジトリをmock化したいということですか？
その通りです。

・Spring Boot、JUnitのバージョンはいくつですか？
Spring Boot 2.0.0.M3
Junit 4.12
となります。

[rubytomato]

バージョンの追記ありがとうございます。バージョンで確認したいのですが、Spring Bootは2.0.0.M3で間違いないでしょうか？
と言うのも、2.0.xはすでにサポート対象外であり、M3と付いているのは開発途中のバージョンであるためです。

[kumaneko]

ご回答ありがとうございます。

間違いありません。
というのも、商用システムではなく、外部につながることもないため、Springのバージョンアップもせずとも今のところ不都合がないため、作成した当時のまま来ています。

よろしくお願いいたします。

Answer 1

・やりたいことはコントローラの結合テストで、ただDBアクセスを発生させたくないのでリポジトリを> mock化したいということですか？

その通りです。

私の知っている範囲では『コントローラーの結合テストにおいて、リポジトリをモック化してデータベースアクセスは行わないようにしたい』ができるかどうかは分からないのですが、代替案が2つあります。
どちらか参考になれば幸いです。

サンプルコード

テスト対象のサンプルコードは以下の通りです。Memoエンティティのデータを1件または全件出力するコードです。

環境

• JDK 1.8
• Spring Boot 2.0.1.RELEASE
• JUnit 4.12
• MySQL 5.6.25

リポジトリ

import com.example.demo.model.Memo;
import org.springframework.data.jpa.repository.JpaRepository;

public interface MemoRepository extends JpaRepository<Memo, Long> {
}

サービス

import com.example.demo.model.Memo;

import java.util.List;
import java.util.Optional;

public interface MemoService {
  Optional<Memo> findById(Long id);
  List<Memo> findAll();
}

import com.example.demo.model.Memo;
import com.example.demo.repository.MemoRepository;
import com.example.demo.service.MemoService;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;

@Service
public class MemoServiceImpl implements MemoService {
  private final MemoRepository memoRepository;

  public MemoServiceImpl(MemoRepository memoRepository) {
    this.memoRepository = memoRepository;
  }

  @Override
  public Optional<Memo> findById(Long id) {
    return memoRepository.findById(id);
  }

  @Override
  public List<Memo> findAll() {
    return memoRepository.findAll();
  }

}

コントローラー

import com.example.demo.model.Memo;
import com.example.demo.service.MemoService;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;
import java.util.Optional;

@RestController
@RequestMapping("memo")
public class MemoController {
  private final MemoService memoService;

  public MemoController(MemoService memoService) {
    this.memoService = memoService;
  }

  @GetMapping(value = "{id}", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
  public ResponseEntity<Memo> findById(@PathVariable("id") Long id) {
    Optional<Memo> memo = memoService.findById(id);
    return memo.map(ResponseEntity::ok)
        .orElseGet(() -> ResponseEntity.notFound().build());
  }

  @GetMapping("all")
  public ResponseEntity<List<Memo>> findAll() {
    List<Memo> memos = memoService.findAll();
    return ResponseEntity.ok(memos);
  }

}

代替案

1. は結合テストとして実装できますが、モック化はしない代わりに事前準備が必要です。
2. は単体テストとしての実装になりますが、モック化するので1)に比べて事前準備は少ないです。

結合テストとしての実装が要求されているのであれば1)、そこまで要求されていないのであれば1) or 2)が選択できると思います。

1) リポジトリをモック化せず、H2などのインメモリデータベースを使用する

特徴

• 結合テストとして実装する。
• データベースにインメモリデータベースを利用する。
• モック化は行わない。
• リポジトリでデータベース固有の関数を使ったネイティブSQLを使っている場合は、テストできない可能性がある。

H2を依存関係に追加する

<dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
  <scope>test</scope>
</dependency>

テスト用のプロパティファイルを用意する

テスト時にH2データベースにアクセス

src/test/resources/application.test.properties

spring.datasource.url = jdbc:h2:mem:testdb;DB_CLOSE_ON_EXIT=FALSE;
spring.datasource.username = sa
spring.datasource.password =

テスト時に使用するテストデータを用意する

src/test/resources/import.sql

INSERT INTO memo (id, title, description, done, updated) VALUES (1001, 'H2 Test title 1001', 'H2 Test description 1001', false, '2020-01-01');
INSERT INTO memo (id, title, description, done, updated) VALUES (1002, 'H2 Test title 1002', 'H2 Test description 1002', false, '2020-02-02');
INSERT INTO memo (id, title, description, done, updated) VALUES (1003, 'H2 Test title 1003', 'H2 Test description 1003', false, '2020-03-03');
INSERT INTO memo (id, title, description, done, updated) VALUES (1004, 'H2 Test title 1004', 'H2 Test description 1004', false, '2020-04-04');
INSERT INTO memo (id, title, description, done, updated) VALUES (1005, 'H2 Test title 1005', 'H2 Test description 1005', false, '2020-05-05');

コントローラーのテストコード

テスト時にデータベースアクセスが行われますが、H2を利用するため実行環境を選びません。

import com.example.demo.model.Memo;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringRunner;

import static org.assertj.core.api.Assertions.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@TestPropertySource(locations = "/application.test.properties")
public class MemoControllerIntegrationTests {

  @Autowired
  private TestRestTemplate testRestTemplate;

  @Test
  public void getMemo() {
    ResponseEntity<Memo> result = testRestTemplate.getForEntity("/memo/1001", Memo.class);

    assertThat(result).isNotNull();
    assertThat(result.getStatusCode()).isEqualTo(HttpStatus.OK);
    assertThat(result.getHeaders().getContentType()).isEqualTo(MediaType.APPLICATION_JSON_UTF8);
    assertThat(result.getBody().getId()).isEqualTo(1001L);
  }

  @Test
  public void getMemos() {
    ResponseEntity<Memo[]> result = testRestTemplate.getForEntity("/memo/all", Memo[].class);

    assertThat(result).isNotNull();
    assertThat(result.getStatusCode()).isEqualTo(HttpStatus.OK);
    assertThat(result.getHeaders().getContentType()).isEqualTo(MediaType.APPLICATION_JSON_UTF8);
    assertThat(result.getBody()).hasSize(5);
  }

}

2) リポジトリをモック化するが、単体テストとして実装する

特徴

• 単体テストとして実装する。
• リポジトリをモック化する。
• データベースアクセスは行わない。

コントローラーのテストコード

テスト時にリポジトリをモック化するのでデータベースアクセスは行われません。

import com.example.demo.model.Memo;
import com.example.demo.repository.MemoRepository;
import com.example.demo.service.impl.MemoServiceImpl;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.boot.test.mock.mockito.SpyBean;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.RequestBuilder;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;

import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.anyLong;

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@RunWith(SpringRunner.class)
@WebMvcTest(MemoController.class)
public class MemoControllerTests {

  @Autowired
  private MockMvc mvc;
  @Autowired
  private ObjectMapper objectMapper;

  @MockBean
  private MemoRepository memoRepository;

  @SpyBean
  private MemoServiceImpl memoService;

  private MediaType contentType = new MediaType(MediaType.APPLICATION_JSON.getType(),
      MediaType.APPLICATION_JSON.getSubtype(), StandardCharsets.UTF_8);

  @Test
  public void getMemo() throws Exception {
    Memo expected = Memo.of(1L, "test title", "test description");
    Mockito.when(memoRepository.findById(anyLong())).thenReturn(Optional.ofNullable(expected));
    
    RequestBuilder builder = MockMvcRequestBuilders.get("/memo/{id}", 1L)
        .accept(MediaType.APPLICATION_JSON_UTF8);

    MvcResult result = mvc.perform(builder)
        .andExpect(status().isOk())
        .andExpect(content().contentType(contentType))
        .andReturn();

    String expectedJson = objectMapper.writeValueAsString(expected);
    assertThat(result.getResponse().getContentAsString()).isEqualTo(expectedJson);
  }

  @Test
  public void getMemos() throws Exception {
    List<Memo> expected = Arrays.asList(
        Memo.of(1L, "test title 1", "test description 1"),
        Memo.of(2L, "test title 2", "test description 2"),
        Memo.of(3L, "test title 3", "test description 3")
    );
    Mockito.when(memoRepository.findAll()).thenReturn(expected);

    RequestBuilder builder = MockMvcRequestBuilders.get("/memo/all")
        .accept(MediaType.APPLICATION_JSON_UTF8);

    MvcResult result = mvc.perform(builder)
        .andExpect(status().isOk())
        .andExpect(content().contentType(contentType))
        .andReturn();

    String expectedJson = objectMapper.writeValueAsString(expected);
    assertThat(result.getResponse().getContentAsString()).isEqualTo(expectedJson);
  }
}

Comments

[kumaneko]

案１で進められそうです。ご回答ありがとうございました。