出荷明細の順番を変えても、同じ明細が何枚あるかまで確認する記事のアイキャッチ

設計・テスト・レビュー

JUnitでListを順不同に比較する|AssertJで重複の件数まで確かめる

出荷CSVを確認すると、同じ商品が別々の梱包に入っているのに、明細が1行しかありませんでした。倉庫の取り込み側は1梱包につき1行を受け取る契約です。ところが、出力を Set に変えてから比べるJUnitテストは通っていました。

行順を問わない場合も、同じ行が何回出るべきかは確認できます。AssertJの containsExactlyInAnyOrder なら、並び替えを許しながら、明細ごとの不足と余分を検出できます。

この記事でわかること

  • 順序の違いだけで assertEquals が落ちる理由
  • Set と containsOnly が明細の欠落を見落とす条件
  • containsExactlyInAnyOrder で重複の件数まで確かめる書き方

記事と同じコードを実行する

ZIPを展開し、JDK 17とMaven 3.9系で mvn test を実行します。出荷CSVのデータ行を作るJava本体、JUnitとAssertJを使うテスト、pom.xml、READMEを収録。重複行を落とす変更を加え、旧比較の誤合格と厳密比較の失敗を確認できます。

サンプルZIPをダウンロード GitHubでコード全文と実行手順を見る

出荷順は自由でも、別梱包なら同じ明細が2行必要

今回のCSVは商品コードと数量を1梱包ずつ出力します。SKU-100 は1個ずつ2箱、SKU-200 は1個で1箱です。CSVに梱包番号を出さないため、SKU-100,1 が同じ文字列で2行並びます。倉庫側は先頭がどの商品かを使いませんが、1行を1梱包として取り込みます。

Aが2行・Bが1行なら、並び替えだけが通る

Aは SKU-100,1、Bは SKU-200,1。

期待値AABA 2行・B 1行
並び替えBAA一致
1行欠落BAAが1行不足

期待値が [A, A, B] なら、[B, A, A] は正常です。[B, A] はAが1行不足し、[B, A, A, A] はAが1行余分です。[A, B, B] は総行数が同じでも、商品ごとの梱包数が違います。先にこの違いを仕様として決めれば、どの比較が必要かを選べます。

SetとcontainsOnlyは、同じ行が何回出たかを見ない

順序を気にしないために、期待値と実際の出力を両方 HashSet にすると、[A, A, B] と [B, A] がどちらもAとBだけになります。変換した時点で、Aが2行必要だったという情報を失っています。Java 17のSetの仕様でも、同じ要素を重複して持たないことが定められています。

重複の不足を見落とす比較(再現用テストの抜粋)

assertEquals(new HashSet<>(EXPECTED), new HashSet<>(actual));
assertThat(actual).containsOnly(REPEATED, REPEATED, OTHER);

AssertJの containsOnly も、期待した種類だけが出たことを、重複を無視して確認するメソッドです。上の例は期待値の引数に REPEATED を2回書いていますが、実際が1行でも通ります。たとえば「出荷に登場した商品コードの種類」を確認したいなら使えます。今回は梱包数を表す行が欠けると困るため、重複の件数を残して比較します。

containsExactlyInAnyOrderなら、並び替えだけを許せる

順不同で明細ごとの回数を確かめる比較(テストの抜粋)

assertThat(actual).containsExactlyInAnyOrder(REPEATED, REPEATED, OTHER);

assertThat に実際のListを渡し、期待する3行を containsExactlyInAnyOrder に書きます。REPEATED を2回渡すのは、同じ明細が2行必要だからです。実際がB、A、Aの並びなら通り、Aが1行しかない場合や3行ある場合は落ちます。期待値をすでにListに持っている場合は、containsExactlyInAnyOrderElementsOf(expected) も使えます。AssertJ 3.27.7のAPIで、重複を無視する比較と件数まで確認する比較を見分けられます。

比較要素の並びも一致同じ要素の回数も一致
Listの assertEquals/containsExactly必要必要
containsExactlyInAnyOrder不要必要
Set へ変換して比較/containsOnly不要確認しない

順位や指定の並び順も仕様なら、順序を含めて比較する

たとえば倉庫側が「商品コードの昇順で取り込む」と決めているなら、B、A、Aは行数が正しくても契約違反です。期待するA、A、Bの順序を assertEquals(expected, actual) や containsExactly でそのまま確かめます。Java 17のList.equalsの仕様は、要素数と同じ位置の値を比べると定めています。

テストが順序の違いだけで落ちたら、比較を変える前に、出力仕様や取り込み側が行の位置を使うかを確認します。順序を要求しているのに両方をソートしてから比較すると、出力側の並び違反を見落とします。配列そのものを比較する場合は、Listと違って配列用のアサーションを使います。

関連記事Java配列のequalsがfalseになる原因|Arrays.equalsとassertArrayEqualsで直す 配列を比べる場合は、参照と要素の違いを整理して、配列用のassertArrayEqualsを使う場面を確認できます。 記事を読む

実装にdistinctを入れ、古い比較の誤合格と修正版の失敗を見る

ZIPを展開し、pom.xml のあるフォルダで mvn test を実行します。JDK 17、Maven 3.9系、JUnit Jupiter 5.12.2、AssertJ 3.27.7、Surefire 3.5.3の例です。ShipmentCsv.dataRows は検証済みの商品コードと数量を文字列にし、入力の1梱包を1行へ変換します。このサンプルで比べるのはヘッダーなしのデータ行です。

ShipmentCsv.java(全文)

package info.syachiku.shipping;

import java.util.List;

public final class ShipmentCsv {
    private ShipmentCsv() {
    }

    public static List<String> dataRows(List<ShipmentLine> lines) {
        return lines.stream()
                .map(line -> line.productCode() + "," + line.units())
                .toList();
    }

    public record ShipmentLine(String productCode, int units) {
    }
}

6件のテストには、正常な並び替え、順序を要求する比較、旧比較の誤合格、不足、余分、総行数は同じで各件数が違う例が含まれます。たとえば rejectsMissingDuplicate は、比較が AssertionError を投げることを期待します。通常実行でこのテストが緑になるのは、欠落が検出されたためです。

ShipmentCsvTest.java(全文)
package info.syachiku.shipping;

import java.util.HashSet;
import java.util.List;

import info.syachiku.shipping.ShipmentCsv.ShipmentLine;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

class ShipmentCsvTest {
    private static final String REPEATED = "SKU-100,1";
    private static final String OTHER = "SKU-200,1";
    private static final List<String> EXPECTED = List.of(REPEATED, REPEATED, OTHER);
    private static final List<String> REORDERED = List.of(OTHER, REPEATED, REPEATED);
    private static final List<String> MISSING = List.of(OTHER, REPEATED);
    private static final List<ShipmentLine> SHIPMENT = List.of(
            new ShipmentLine("SKU-200", 1),
            new ShipmentLine("SKU-100", 1),
            new ShipmentLine("SKU-100", 1));

    @Test
    void acceptsReorderedExportWithEveryLine() {
        var actual = ShipmentCsv.dataRows(SHIPMENT);

        assertThat(actual).containsExactlyInAnyOrder(REPEATED, REPEATED, OTHER);
    }

    @Test
    void orderedAssertionsDistinguishSequenceWhenItIsRequired() {
        assertThrows(AssertionError.class, () -> assertEquals(EXPECTED, REORDERED));
        assertThrows(AssertionError.class,
                () -> assertThat(REORDERED).containsExactly(REPEATED, REPEATED, OTHER));

        assertEquals(EXPECTED, List.of(REPEATED, REPEATED, OTHER));
        assertThat(EXPECTED).containsExactly(REPEATED, REPEATED, OTHER);
    }

    @Test
    void oldAssertionsAcceptTheBrokenExport() {
        var actual = ShipmentCsv.dataRows(SHIPMENT).stream().distinct().toList();
        assertEquals(MISSING, actual);

        assertEquals(new HashSet<>(EXPECTED), new HashSet<>(actual));
        assertThat(actual).containsOnly(REPEATED, REPEATED, OTHER);
    }

    @Test
    void rejectsMissingDuplicate() {
        assertThrows(AssertionError.class,
                () -> assertThat(MISSING).containsExactlyInAnyOrder(REPEATED, REPEATED, OTHER));
    }

    @Test
    void rejectsExtraDuplicate() {
        var actual = List.of(OTHER, REPEATED, REPEATED, REPEATED);

        assertThrows(AssertionError.class,
                () -> assertThat(actual).containsExactlyInAnyOrder(REPEATED, REPEATED, OTHER));
    }

    @Test
    void rejectsDifferentCountsEvenWhenTotalSizeMatches() {
        var actual = List.of(REPEATED, OTHER, OTHER);
        assertEquals(EXPECTED.size(), actual.size());

        assertThrows(AssertionError.class,
                () -> assertThat(actual).containsExactlyInAnyOrder(REPEATED, REPEATED, OTHER));
    }
}
pom.xml(全文)
<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>info.syachiku</groupId>
  <artifactId>junit-list-any-order-sample</artifactId>
  <version>1.0.0</version>
  <properties>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>net.bytebuddy</groupId>
        <artifactId>byte-buddy</artifactId>
        <version>1.17.8</version>
      </dependency>
    </dependencies>
  </dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <version>5.12.2</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.assertj</groupId>
      <artifactId>assertj-core</artifactId>
      <version>3.27.7</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.3.1</version>
      </plugin>
      <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>

別の場所にZIPを展開し、本体の .map(...) と .toList() の間に .distinct() を足すと、同じ明細が1行にまとめられます。この状態で、旧比較だけを明示して実行すると1件成功します。続けて全体を実行すると、実際のCSVデータ行を厳密に比べるテストが1件失敗します。ログの could not find the following elements に、足りない SKU-100,1 が1行分出ます。確認後は .distinct() を外します。

通常実行・旧比較だけ・故障版全体のログ抜粋

修正版の mvn test
[INFO] Tests run: 6, Failures: 0, Errors: 0, Skipped: 0

欠落版で旧比較だけを実行
mvn -Dtest=ShipmentCsvTest#oldAssertionsAcceptTheBrokenExport test
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

欠落版の mvn test
but could not find the following elements:
  ["SKU-100,1"]
[ERROR] Tests run: 6, Failures: 1, Errors: 0, Skipped: 0

レビューでは、順序と明細ごとの件数を別々に確認する

レビューコメント例「このCSVは1梱包で1行なので、SKU-100が1行に減ると取り込み側では1箱不足します。出荷順には指定がないため、並び違いは許しつつ、同じ行が2件あることまでテストしましょう。」

行数が一致するという追加のassertionだけでは、A2件・B1件がA1件・B2件に変わる不具合を防げません。必要な場合は、明細の文字列全体を比べます。この例なら商品コードだけに変換すると数量の違いを確認できないため、SKU-100,1 のようなデータ行をそのまま比較します。

提出前に、並び替え・不足・余分の3通りを試す

  • 出力する行の順序が契約に含まれるか、取り込み側と確認した。
  • 同じ明細が複数行必要な場合は、期待値に必要な回数を書いた。
  • 順序を問わない契約では並び替えが通り、不足・余分は落ちる。
  • 総件数が同じでも、明細ごとの件数が違えば落ちる。

どの入力で不足や余分を確かめるか迷う場合は、『ソフトウェアテストの教科書[増補改訂 第2版]』の第4章「同値分割テスト・境界値テスト」が参考になります。今回ならAが2件必要という条件に対し、1件・2件・3件を選ぶ考え方につながります。

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

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

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

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

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

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

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

関連記事テストケースの作り方|仕様・境界値・期待結果をJUnitと対応させる実例 期待する明細数の前後を試すように、業務仕様からテスト入力と期待値を選ぶ手順を学べます。 記事を読む 関連記事JUnitのParameterizedTest・CsvSourceの使い方|境界値と空文字を正しくテストする 期待値が異なる複数ケースをJUnitへ渡すときは、テストデータとしてのCsvSourceとケースIDの使い方を確認できます。 記事を読む

まとめ

順序を問わないListでも、同じ要素が何回必要かは仕様として残ります。明細の不足と余分を検出したいときは containsExactlyInAnyOrder を使い、期待値に必要な回数を書きます。順序も契約に含まれる場合は、assertEquals や containsExactly で並びまで確認します。

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