【Java】Mockitoのverifyのテストの書き方

目的

過程を検証する目的としては、下記のような理由が挙げられます。

• 副作用（DB保存や通知）の担保
  • 適切な処理を順番通りに呼び出せているか検証したい
• 多重処理の監視
  • 決済APIなど、バグによって2回以上呼び出されていないこと検証したい
  • ループやリトライ処理など、想定の回数実行されているかを検証したい

それでは、具体的なコードで使い方を紹介します。

verify テスト対象コード

注文の支払いを行うサンプルロジックです。

戻り値は void で、内部で主に「支払い」と「注文状況の更新」の2つを行っています。

public class PaymentUseCase {
  private final OrderService orderService;
  private final PaymentService paymentService;

  public PaymentUseCase(OrderService orderService, PaymentService paymentService) {
    this.orderService = orderService;
    this.paymentService = paymentService;
  }

  /**
   * 支払いを行う
   * @param orderId 注文ID
   */
  public void payment(OrderId orderId) {
    // 支払い済みであれば支払いせず終了
    if (orderService.isPaid(orderId)) {
      return;
    }

    // 支払い
    paymentService.payment(orderId);

    // 注文状況を支払い済みに更新
    orderService.payment(orderId);
  }

}

このコードを verify を使って過程をテストします。

verify テストコード

@ExtendWith(MockitoExtension.class)
class PaymentUseCaseTest {

  @InjectMocks
  private PaymentUseCase paymentUseCase;
  @Mock
  private OrderService orderService;
  @Mock
  private PaymentService paymentService;

  @Test
  void 支払い済みだと支払処理が行われないこと() {
    // given
    OrderId orderId = mock(OrderId.class);

    when(orderService.isPaid(orderId)).thenReturn(true);

    // when
    paymentUseCase.payment(orderId);

    // then
    verify(orderService, times(1)).isPaid(orderId);
    verify(paymentService, never()).payment(orderId);
    verify(orderService, never()).payment(orderId);
  }

  @Test
  void 支払いに失敗すると注文状況処理は行われていないこと() {
    // given
    OrderId orderId = mock(OrderId.class);

    when(orderService.isPaid(orderId)).thenReturn(false);
    doThrow(RuntimeException.class).when(paymentService).payment(orderId);

    // when&then
    assertThrows(RuntimeException.class, () -> paymentUseCase.payment(orderId));
    verify(orderService, times(1)).isPaid(orderId);
    verify(paymentService, times(1)).payment(orderId);
    verify(orderService, never()).payment(orderId);
  }

  @Test
  void 支払いに成功すると注文状況処理まで行われること() {
    // given
    OrderId orderId = mock(OrderId.class);

    when(orderService.isPaid(orderId)).thenReturn(false);

    // when
    paymentUseCase.payment(orderId);

    // then
    verify(orderService, times(1)).isPaid(orderId);
    verify(paymentService, times(1)).payment(orderId);
    verify(orderService, times(1)).payment(orderId);

    InOrder inOrder = inOrder(orderService, paymentService);
    inOrder.verify(paymentService).payment(orderId);
    inOrder.verify(orderService).payment(orderId);
  }

}