【Java】given-when-then構文でのテストコードの書き方

Given（前提条件）

テストを実行するための事前準備を行うフェーズです。

テスト対象のメソッドに渡す引数の準備や、モックでの振る舞いの定義を行います。

When（実行・操作）

テスト対象のメソッドを実際に呼び出すフェーズです。

基本的にテスト対象のメソッドを呼び出すだけなので1行になります。
※実行回数の検証や呼び出し順序など、複数行実行が必要なパターンもあります

Then（検証）

実行結果が期待通りであるかを確認するフェーズです。

戻り値の検証や例外の有無、モックのメソッドが正しい回数呼び出されていたかの検証等を行います。

モックを使用しないシンプルなテスト

依存関係のない純粋なドメインロジックのテスト例です。

class UserNameTest {
  @Test
  void 文字列を渡すと生成できること() {
    // given
    String name = "test_name";

    // when
    var result = new UserName(name);

    // then
    assertEquals(name, result.value());
  }
}

Mockitoを使ってモックを使用するテスト

外部のデータベースなどをモック化して行うサービス層のテスト例です。

@ExtendWith(MockitoExtension.class)
class UserServiceTest {
  @InjectMocks
  private UserService userService;
  @Mock
  private UserRepository userRepository;

  @Test
  void addUserが実行されること() {
    // given
    UserId userId = new UserId("test");
    when(userRepository.existsByUserId(any())).thenReturn(Exists.NOT_EXISTS);

    // when
    userService.addUser(userId);

    // then
    verify(userRepository).addUser(any(), any());
  }

  @Test
  void 試行回数3回目で追加できること() {
    // given
    UserId userId = new UserId(UUID.randomUUID().toString());
    when(userRepository.existsByPlayerId(any()))
        .thenReturn(Exists.EXISTS)
        .thenReturn(Exists.EXISTS)
        .thenReturn(Exists.NOT_EXISTS);

    // when
    userService.addUser(userId);

    // then
    verify(userRepository).addUser(any(), any());
  }

  @Test
  void 試行回数3回で作成できない場合エラーになること() {
    // given
    UserId userId = new UserId(UUID.randomUUID().toString());
    when(userRepository.existsByPlayerId(any()))
        .thenReturn(Exists.EXISTS)
        .thenReturn(Exists.EXISTS)
        .thenReturn(Exists.EXISTS);

    // when
    Exception result = assertThrows(DomainException.class, () -> userService.addUser(userId));

    // then
    assertEquals("プレイヤーIDの生成に失敗", result.getMessage());
  }
}