1. 概要

このクイックチュートリアルでは、AssertJの例外専用アサーションについて説明します。

2. AssertJなし

例外がスローされたかどうかをテストするには、例外をキャッチしてからアサーションを実行する必要があります。

try {
    // ...
} catch (Exception e) {
    // assertions
}

しかし、例外がスローされない場合はどうなりますか? その場合、テストは合格します。 これが、テストケースを手動で失敗させる必要がある理由です。

3. AssertJを使用

Java 8を使用すると、AssertJ式とラムダ式を利用して、例外に対してアサーションを簡単に実行できます。

3.1. assertThatThrownBy()を使用する

リスト内の範囲外のアイテムにインデックスを付けると、 IndexOutOfBoundsException:が発生するかどうかを確認しましょう。

assertThatThrownBy(() -> {
    List<String> list = Arrays.asList("String one", "String two");
    list.get(2);
}).isInstanceOf(IndexOutOfBoundsException.class)
  .hasMessageContaining("Index: 2, Size: 2");

例外をスローする可能性のあるコードフラグメントがラムダ式として渡されることに注意してください。

もちろん、ここでは次のようなさまざまな標準のAssertJアサーションを活用できます。

.hasMessage("Index: %s, Size: %s", 2, 2)
.hasMessageStartingWith("Index: 2")
.hasMessageContaining("2")
.hasMessageEndingWith("Size: 2")
.hasMessageMatching("Index: \\d+, Size: \\d+")
.hasCauseInstanceOf(IOException.class)
.hasStackTraceContaining("java.io.IOException");

3.2. assertThatExceptionOfTypeを使用する

考え方は上記の例に似ていますが、最初に例外タイプを指定できます。

assertThatExceptionOfType(IndexOutOfBoundsException.class)
  .isThrownBy(() -> {
      // ...
}).hasMessageMatching("Index: \\d+, Size: \\d+");

3.3. assertThatIOExceptionおよびその他の一般的なタイプの使用

AssertJは、次のような一般的な例外タイプのラッパーを提供します。

assertThatIOException().isThrownBy(() -> {
    // ...
});

そして同様に:

  • assertThatIllegalArgumentException()
  • assertThatIllegalStateException()
  • assertThatIOException()
  • assertThatNullPointerException()

3.4. 例外をアサーションから分離する

単体テストを作成する別の方法は、 whenとthenロジックを別々のセクションに作成することです:

// when
Throwable thrown = catchThrowable(() -> {
    // ...
});

// then
assertThat(thrown)
  .isInstanceOf(ArithmeticException.class)
  .hasMessageContaining("/ by zero");

4. 結論

そして、そこにあります。 この短い記事では、例外に対してアサーションを実行するためにAssertJを使用するさまざまな方法について説明しました。

いつものように、この記事に関連するコードは、Githubから入手できます。