JUnit 5のassertAllで独立した確認と前提がある確認を分けるイメージ

設計・テスト・レビュー

JUnit 5のassertAllでNullPointerExceptionが出る理由|前提に依存する検証をまとめる

この記事でわかること

JUnit 5の assertAll は、あるラムダの assertNotNull が失敗しても、別のラムダに進みます。配送情報の有無と配送方法は同じラムダに入れ、配送なしでも比較できる見積合計は別のラムダに残します。

新人SE
新人SE
配送情報がないことはassertNotNullで検出できました。でもテスト結果には、その下にNullPointerExceptionまで出ています。どちらから直せばいいですか?
ポンコツSE
ポンコツSE
例外が出た行を見ます。見積の計算中ではなく、テストで配送方法を読んだ行なら、配送なしを検出した後も別のラムダが走っています。金額の確認は残し、配送情報に依存する確認を一緒にします。

注文システムの確定画面で、暫定見積をそのまま返してしまった場面を考えます。標準便で確定する注文の商品代は4,200円、送料は500円。合計4,700円と配送方法 STANDARD が必要です。ところが返ってきた見積は4,200円で、配送情報は null でした。

そのときの結果は「合計が違う」「配送情報がない」の2件で十分です。「配送方法を読み出すと例外になった」も混ざると、業務側の不具合とテストの書き方の問題を切り分ける手間が増えます。同じ結果を使って、報告を3件から2件に整理します。

実行サンプル

見積を作るJavaクラス、修正前後を比較するJUnitのテスト4件、pom.xml、READMEを収録。JDK 17とMavenで、ZIPを展開したフォルダから mvn clean test を実行します。テストと対象コードの全文へ移動

別のラムダに書くと、配送なしの後も配送方法を読みに行く

再現に使う入力は calculator.calculate(4_200, null) です。サンプルの QuoteCalculator は入力された配送の料金を商品代に足します。配送なしなら送料0円の暫定見積になるため、ここでは Quote(4200, null) が返ります。確定見積に求める条件を、その戻り値に対して検証します。

以下は QuoteAssertionsTest.java から、修正前の検証メソッドを取り出したものです。() -> から始まるラムダを3個渡しています。

    private static void checkSeparately(Quote quote) {
        assertAll("確定見積",
                () -> assertEquals(4_700, quote.totalYen(), "見積合計"),
                () -> assertNotNull(quote.delivery(), "配送情報"),
                () -> assertEquals(STANDARD, quote.delivery().method(), "配送方法"));
    }

1個目は4,200円を読み、期待値4,700円と異なるので失敗します。2個目も、quote.delivery() が null なので失敗します。assertAll はこの二つの失敗を集めながら、3個目も実行します。

3個目では assertEquals に値を渡す前に、Javaが quote.delivery().method() を評価します。null に対して method() を呼ぶので、配送方法の比較に入る前に NullPointerException が出ます。配送方法が STANDARD かどうかは、この行では判定できていません。

スタックトレースを調べるときは、例外が発生した行を区別します。QuoteCalculator.calculate(...) で落ちていたら、見積を返す処理を確認します。見積が返った後で、QuoteAssertionsTest の quote.delivery().method() が発生元なら、先にテストのラムダを確認します。業務処理の例外を、この修正で覆い隠さないためです。

配送情報と配送方法を同じラムダにまとめる

配送方法は配送情報があるときだけ読めます。そこで、assertNotNull と assertEquals(STANDARD, ...) を1つのラムダに移します。金額は Quote から直接読めるので、もう1つのラムダへ置きます。以下は同じテストクラスの修正版メソッドです。

    private static void checkGrouped(Quote quote) {
        assertAll("確定見積",
                () -> {
                    Quote.Delivery delivery = quote.delivery();
                    assertNotNull(delivery, "配送情報");
                    assertEquals(STANDARD, delivery.method(), "配送方法");
                },
                () -> assertEquals(4_700, quote.totalYen(), "見積合計"));
    }

assertNotNull(delivery, "配送情報") が失敗すると、そのラムダはそこで終わります。次の行の delivery.method() は呼びません。外側の assertAll は、別ラムダにした合計の確認を引き続き実行します。例では配送のラムダを先に書き、配送情報の失敗後も合計の失敗を報告できることを確かめています。

配送情報が null、合計が4,200円のときに実行される確認
確認修正前
3ラムダ
修正後
2ラムダ
合計比較して失敗配送の後で比較して失敗
配送情報null で失敗null で失敗
配送方法method() の呼び出しで例外同じラムダの前の行で止まる

逆に、配送情報が存在すれば assertNotNull を通過します。方法が EXPRESS なら、合計が合っていても配送方法の比較だけが失敗します。「配送の確認をまとめたら配送方法を調べなくなった」という修正漏れは、このケースで検出できます。

配送方法の確認だけを if (delivery != null) で囲む案もあります。配送の存在確認を別に残していれば欠落は見つかりますが、あとから存在確認が消えると、配送がない結果を黙って通すテストになります。この例の仕様は標準便で確定した見積です。配送を必須とする条件を、方法の確認と同じ場所で読める形にしておくと、前提が残っているかをレビューできます。暫定見積のテストでは、配送未設定を許す別の仕様に沿って assertNull を使えます。

この構成は、JUnit公式ガイドの、前提を同じ実行ブロック内で検証する例と同じです。assertAll に渡した個々のラムダは、先行する別ラムダが通ることを前提にしません。前提確認をどのラムダへ入れるかは、テストを書く側が決めます。

参照 JUnit 5.12.2ユーザーガイドのアサーション・Assertions API

JUnitで配送なし、誤った配送方法、正常な見積を確かめる

ZIPを展開し、pom.xml がある場所でJDK 17とMavenを使って mvn clean test を実行します。JUnit Jupiterは5.12.2です。下の「テスト対象と設定の全文」を開けば、計算クラスとデータ型、設定も確認できます。

テスト対象と設定の全文
package example.quote;

public record Quote(int totalYen, Delivery delivery) {
    public record Delivery(Method method, int feeYen) {}

    public enum Method {
        STANDARD, EXPRESS
    }
}
package example.quote;

public final class QuoteCalculator {
    public Quote calculate(int merchandiseYen, Quote.Delivery delivery) {
        int feeYen = delivery == null ? 0 : delivery.feeYen();
        return new Quote(Math.addExact(merchandiseYen, feeYen), delivery);
    }
}
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>example</groupId>
  <artifactId>junit-assertall-dependent-assertions</artifactId>
  <version>1.0.0</version>
  <properties>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <version>5.12.2</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.14.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.5.3</version>
      </plugin>
    </plugins>
  </build>
</project>

以下は QuoteAssertionsTest.java の全文です。最初の3件は assertThrows(MultipleFailuresError.class, ...) で比較用の失敗を受け取り、getFailures() で失敗の内訳を検証します。テスト出力の名前は、この一覧から取り出しています。最後の1件は、修正版で見積の条件がすべて成立するときに例外がないことを確認します。

package example.quote;

import org.junit.jupiter.api.Test;
import org.opentest4j.AssertionFailedError;
import org.opentest4j.MultipleFailuresError;

import java.util.List;

import static example.quote.Quote.Method.EXPRESS;
import static example.quote.Quote.Method.STANDARD;
import static org.junit.jupiter.api.Assertions.assertAll;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

class QuoteAssertionsTest {
    private final QuoteCalculator calculator = new QuoteCalculator();

    @Test
    void separateLambdasAlsoDereferenceMissingDelivery() {
        Quote quote = calculator.calculate(4_200, null);

        var failures = reportedFailures(() -> checkSeparately(quote));
        showFailures("separateMissing", failures);
        assertEquals(3, failures.size());
        assertFailureLabel(failures.get(0), "見積合計");
        assertFailureLabel(failures.get(1), "配送情報");
        assertInstanceOf(NullPointerException.class, failures.get(2));
    }

    @Test
    void groupedDeliveryKeepsTheIndependentTotalCheck() {
        Quote quote = calculator.calculate(4_200, null);

        var failures = reportedFailures(() -> checkGrouped(quote));
        showFailures("groupedMissing", failures);
        assertEquals(2, failures.size());
        assertFailureLabel(failures.get(0), "配送情報");
        assertFailureLabel(failures.get(1), "見積合計");
    }

    @Test
    void groupedDeliveryStillChecksTheMethodWhenDeliveryExists() {
        Quote quote = calculator.calculate(4_000, new Quote.Delivery(EXPRESS, 700));

        var failures = reportedFailures(() -> checkGrouped(quote));
        showFailures("groupedWrongMethod", failures);
        assertEquals(1, failures.size());
        assertFailureLabel(failures.get(0), "配送方法");
    }

    @Test
    void completeStandardQuotePasses() {
        Quote quote = calculator.calculate(4_200, new Quote.Delivery(STANDARD, 500));

        assertDoesNotThrow(() -> checkGrouped(quote));
    }

    private static void checkSeparately(Quote quote) {
        assertAll("確定見積",
                () -> assertEquals(4_700, quote.totalYen(), "見積合計"),
                () -> assertNotNull(quote.delivery(), "配送情報"),
                () -> assertEquals(STANDARD, quote.delivery().method(), "配送方法"));
    }

    private static void checkGrouped(Quote quote) {
        assertAll("確定見積",
                () -> {
                    Quote.Delivery delivery = quote.delivery();
                    assertNotNull(delivery, "配送情報");
                    assertEquals(STANDARD, delivery.method(), "配送方法");
                },
                () -> assertEquals(4_700, quote.totalYen(), "見積合計"));
    }

    private static List<Throwable> reportedFailures(org.junit.jupiter.api.function.Executable check) {
        return assertThrows(MultipleFailuresError.class, check).getFailures();
    }

    private static void assertFailureLabel(Throwable failure, String label) {
        var assertion = assertInstanceOf(AssertionFailedError.class, failure);
        assertTrue(assertion.getMessage().startsWith(label + " ==>"), assertion::getMessage);
    }

    private static void showFailures(String label, List<Throwable> failures) {
        var names = failures.stream()
                .map(failure -> failure instanceof AssertionFailedError
                        ? failure.getMessage().split(" ==> ", 2)[0]
                        : failure.getClass().getSimpleName())
                .toList();
        System.out.println(label + " = " + String.join(" / ", names));
    }
}

4件が成功し、比較用の3行が出ます。ここでは修正前、修正後、配送方法だけが違う場合の順に掲載しています。JUnitのテスト実行順には依存しません。

separateMissing = 見積合計 / 配送情報 / NullPointerException
groupedMissing = 配送情報 / 見積合計
groupedWrongMethod = 配送方法

groupedMissing には「配送情報」と「見積合計」が残っています。配送方法の行へ進まなかっただけで、合計の失敗は消えていません。groupedWrongMethod は商品代4,000円と急送便の送料700円を使うので、合計だけは期待値4,700円に揃っています。配送方法の失敗を単独で見られるようにした入力です。正常ケースでは、商品代4,200円に標準便の送料500円を足し、合計も配送方法も通ります。

修正後も失敗が2件出るのは、アサーションが正しく動いているためです。テストで出す診断の数を変えた結果で、見積が4,700円に直ったわけではありません。暫定見積を確定処理へ渡した原因を調べる際は、配送条件が設定される操作と、確定APIが呼ばれたときの入力を見ます。テストのログが整理されると、合計と配送の両方がずれた原因を業務コードから探しやすくなります。

実際に確定見積を検証するテストへ移すのは checkGrouped(quote) の中身です。失敗の内訳を観察するための assertThrows(MultipleFailuresError.class, ...) まで移すと、確定見積が壊れたときにテストを成功させる書き方になるので、比較用のサンプルに留めます。

Mavenの設定やテストの起動に戻りたいときは、最初の1件を実行する記事で確かめられます。

関連記事JUnit 5入門|Mavenで最初のテストを実行し、失敗を直す JDKとMavenを準備し、最初のテストを実行します。期待値と実際の値を比べて、JUnitの失敗表示を読むところから始められます。 記事を読む

レビューで「前の条件が崩れても、この値を読めるか」を確認する

実際のコードレビューでは、アサーションの個数より、値を読み出せる条件を確認します。例えば配送情報からは方法に加えて配送枠も読めますが、どちらにも配送情報の存在が必要です。配送情報を確認したラムダの中で、方法と配送枠が互いに依存しなければ、内側の assertAll に分けて両方を報告できます。今回の題材は確認する配送項目が1つなので、内側のグループは不要です。

見積そのものが null になり得る場合は、金額と配送の両方が見積の存在に依存します。その確認は外側の assertAll を呼ぶ前に置きます。まず戻り値があることを確かめ、その中の独立した条件だけをまとめると、どの前提が崩れたかを追いやすくなります。

レビューで再現を頼まれたら、配送なしの同じ入力を変更前と変更後に使い、違いを失敗の内訳で示します。合計のチェックを消して2件にする、配送方法を読める入力へ変更して例外を出さなくする、といった変更でも見かけ上のログは短くなります。4,200円・配送なしのまま「見積合計」と「配送情報」が残り、NullPointerException だけが消えたことまで確認します。

配送情報がない場合、3番目のラムダでも delivery().method() を呼び、テスト側でNPEが出ています。配送情報の assertNotNull と方法の比較を同じラムダへ移してください。合計は別のラムダに残し、4,200円・配送なしで「配送情報」「見積合計」の2件になることを確認したいです。配送あり・方法だけ違う場合も1件残してください。

複数の取引や異なる入力をまとめたい場合は、各ケースに名前を付けてテストを分ける方法もあります。配送なしと急送便を1個の assertAll に入れると、どの注文を再現したのかが出力から分かりにくくなります。同じ見積の独立した結果をまとめる場合と、別々の入力を検証する場合で使い分けます。

  • 配送なしの再現を実行し、NPEの発生元が処理本体かテストの値読み出しかを確認した。
  • 配送情報の存在確認と、その中の値の読み出しを同じラムダへ置いた。
  • 配送なし・金額違いの同じ戻り値で、両方の失敗が報告される。
  • 配送あり・方法だけ違う入力で、方法の比較が実行されることを確認した。
  • 確定見積の正常ケースが通り、比較用の失敗を捕まえる処理を実業務のテストへ移していない。

何を確かめるか迷ったら、入力と期待結果の選び方を学ぶ

『ソフトウェアテストの教科書[増補改訂 第2版]』は、配送なし・配送ありのように、仕様のどの条件を別のテストケースとして用意するか考えるときに使えます。今回のレビューなら「欠けた配送情報」と「存在するが違う配送方法」を1つずつ試す理由を説明できるかを見ます。assertAll の呼び方や失敗の集め方は、この記事の実行例とJUnit公式資料で確認してください。

書籍「ソフトウェアテストの教科書[増補改訂 第2版]」の表紙
書影:SBクリエイティブ
PR テストを学ぶ若手向け

ソフトウェアテストの教科書[増補改訂 第2版]

布施昌弘・江添智之・永井努・三堀雅也 著

仕様から、試す入力と期待する結果を選べるようになる。

同値分割・境界値や条件の組合せなど、テストケースを選ぶ考え方を基礎から学ぶ1冊。何を試せばよいかわからない段階で選びます。

  • 正常な値を1件試した後、追加するケースに迷う
  • 入力と期待値を選んだ理由を説明したい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

関連記事テストケースの作り方|仕様・境界値・期待結果をJUnitと対応させる実例 配送ありと配送なしのように条件を分けたいときに。仕様から入力と期待結果を選ぶ手順を、受付システムの例で試せます。 記事を読む 関連記事Javaのテスト入門におすすめの本|テストケースを選べる最初の1冊 JUnitの構文を覚えた後、何を確認すればよいか迷ったときの最初の1冊を選べます。 記事を読む

まとめ

assertAll に分けて渡したラムダは、別のラムダが失敗しても実行されます。前提が崩れると読めなくなる値は、前提の確認と同じラムダに入れます。配送なしなら配送方法で例外を出さず、独立した合計の違いは報告する。自分のテストを直したら、この2点を同じ失敗例で確かめてください。

-設計・テスト・レビュー
-, ,