AssertJ完全ガイド：流れるようなアサーションでテストコードを革新する

はじめに：AssertJとは何か？

AssertJは、Javaのためのオープンソースの流暢なアサーションライブラリです。テストコードの可読性と保守性を劇的に向上させることを目的としています。 標準のJUnitが提供するassertEquals(expected, actual)のような形式とは異なり、AssertJは「流れるような(fluent)」インターフェースを採用しています。

これにより、assertThat(actual).is...()のように、自然言語に近い形で直感的にアサーションを記述できます。このアプローチは、コードを読むだけでテストの意図が明確に理解できるという大きな利点をもたらします。

String actual = "AssertJ";
String expected = "AssertJ";
assertEquals(expected, actual);

List<String> list = Arrays.asList("Java", "Kotlin");
assertTrue(list.contains("Java"));

import static org.assertj.core.api.Assertions.*;

String actual = "AssertJ";
assertThat(actual).isEqualTo("AssertJ");

List<String> list = Arrays.asList("Java", "Kotlin");
assertThat(list).contains("Java");

セットアップ：プロジェクトへの導入

AssertJを使い始めるのは非常に簡単です。お使いのビルドツールに応じて、依存関係を追加するだけです。

Mavenの場合

pom.xmlファイルの<dependencies>セクションに以下の定義を追加します。testスコープに設定するのが一般的です。

<dependency>
  <groupId>org.assertj</groupId>
  <artifactId>assertj-core</artifactId>
  <!-- 最新バージョンを確認して指定してください -->
  <version>3.26.3</version>
  <scope>test</scope>
</dependency>

Gradleの場合

build.gradleファイルのdependenciesブロックに以下を追加します。

dependencies {
    // 最新バージョンを確認して指定してください
    testImplementation 'org.assertj:assertj-core:3.26.3'
}

依存関係を追加したら、テストクラスでorg.assertj.core.api.Assertionsクラスのメソッドをスタティックインポートすると、より簡潔に記述できるようになります。

import static org.assertj.core.api.Assertions.*;

基本のアサーション

AssertJの全てのアサーションはassertThat(actualValue)から始まります。このメソッドは、検証対象のオブジェクトを受け取り、その型に応じたアサーションメソッドを持つオブジェクトを返します。

頻繁に使用する基本マッチャー

以下は、オブジェクトの種類を問わず、日常的によく使われる基本的なアサーションメソッドの例です。

型別のアサーション：文字列、数値、日付

AssertJの真価は、特定のデータ型に特化した豊富なアサーションメソッドにあります。これにより、より表現力豊かなテストが可能になります。

String text = "Hello, AssertJ World!";

assertThat(text)
    .isNotNull()
    .startsWith("Hello")
    .endsWith("World!")
    .contains("AssertJ")
    .doesNotContain("JUnit")
    .matches("Hello, .* World!")
    .hasSize(21);

int number = 42;
double floatingPoint = 3.14159;

assertThat(number)
    .isGreaterThan(40)
    .isLessThanOrEqualTo(42)
    .isPositive()
    .isEven();

// 浮動小数点数の比較には誤差を許容するisCloseToが便利
assertThat(floatingPoint).isCloseTo(3.14, within(0.01));

import java.time.LocalDate;

LocalDate today = LocalDate.now();
LocalDate yesterday = today.minusDays(1);
LocalDate tomorrow = today.plusDays(1);

assertThat(today)
    .isAfter(yesterday)
    .isBefore(tomorrow)
    .isBetween(yesterday, tomorrow)
    .isEqualTo(LocalDate.now());

コレクションとMapのアサーション

おそらくAssertJが最も輝く場面の一つが、コレクションやMapの検証です。ループを書いて各要素をチェックするような冗長なコードはもう必要ありません。

コレクション (List, Set)

リストやセットのサイズ、要素の有無、順序などを簡単に検証できます。

List<String> languages = Arrays.asList("Java", "Kotlin", "Scala", "Java");

assertThat(languages)
    .isNotNull()
    .isNotEmpty()
    .hasSize(4)
    .contains("Kotlin")
    .doesNotContain("Python");

// 要素の出現回数も確認できる
assertThat(languages).contains("Java", atLeastOnce());

// 重複を許さないSetに変換して検証
assertThat(languages)
    .as("重複を除いた言語リストの検証")
    .toSet()
    .hasSize(3);

contains, containsExactly, containsOnly の違い

コレクションの要素を検証する際、似て非なるこれらのメソッドの使い分けは重要です。

extracting: オブジェクトのプロパティを抽出して検証

オブジェクトのリストを扱う際に絶大な効果を発揮するのがextracting()です。各オブジェクトから特定のプロパティを抽出し、そのプロパティのリストに対してアサーションを実行できます。

// Userクラス（nameとageプロパティを持つ）を想定
List<User> users = Arrays.asList(new User("Alice", 25), new User("Bob", 30));

// ユーザーリストから名前だけを抽出して検証
assertThat(users)
    .extracting("name")
    .contains("Alice", "Bob")
    .doesNotContain("Charlie");

// 複数のプロパティをタプルとして抽出して検証
assertThat(users)
    .extracting("name", "age")
    .contains(tuple("Alice", 25), tuple("Bob", 30));

Map

Mapのキー、値、エントリの検証も簡単です。

Map<String, String> capitals = new HashMap<>();
capitals.put("Japan", "Tokyo");
capitals.put("France", "Paris");

assertThat(capitals)
    .isNotEmpty()
    .hasSize(2)
    .containsKey("Japan")
    .containsValue("Paris")
    .doesNotContainKey("USA")
    .containsEntry("Japan", "Tokyo");

例外のアサーション

特定の条件下で例外が正しくスローされることをテストするのも重要な作業です。AssertJは、ラムダ式を使ってこれを簡潔に記述する方法を提供します。

// 何らかの例外をスローするメソッド
public void withdraw(int amount) {
    if (amount > balance) {
        throw new IllegalArgumentException("Insufficient funds");
    }
    // ...
}

// テストコード
assertThatThrownBy(() -> {
    account.withdraw(1000); // 残高を超える額を引き出す
}).isInstanceOf(IllegalArgumentException.class)
  .hasMessage("Insufficient funds");

// メッセージの一部を検証
assertThatThrownBy(() -> {
    account.withdraw(1000);
}).hasMessageContaining("funds");

// 特定の例外型に特化したアサーション
assertThatExceptionOfType(IOException.class).isThrownBy(() -> {
    // I/Oエラーを引き起こす処理
}).withMessage("%s not found", "file.txt")
  .withCauseInstanceOf(FileNotFoundException.class);

AssertJの便利な機能

基本的な使い方に加え、AssertJにはテストコードの品質をさらに向上させるための便利な機能が備わっています。

`as()`によるエラーメッセージのカスタマイズ

テストが失敗したとき、なぜ失敗したのかを即座に理解できることが重要です。as()メソッドを使うと、アサーションに説明を追加し、失敗時のエラーメッセージを分かりやすくカスタマイズできます。

User user = new User("Bob", 20);

// as() を使わない場合のエラーメッセージ
// org.junit.ComparisonFailure: expected:<true> but was:<false>

// as() を使った場合
assertThat(user.isAdmin())
    .as("ユーザー '%s' は管理者権限を持っているはず", user.getName())
    .isTrue();

// 失敗時のメッセージ:
// [ユーザー 'Bob' は管理者権限を持っているはず]
// expected: true
// but was: false

複雑なテストケースでは、この一言がデバッグの時間を大幅に短縮してくれます。

`SoftAssertions`による複数アサーションの実行

通常、テストメソッド内で最初のアサーションが失敗すると、その時点でテストは中止され、後続のアサーションは実行されません。しかし、一つのオブジェクトの複数のプロパティを一度に検証したい場合、これでは不便です。 SoftAssertionsは、この問題を解決します。すべてのアサーションを実行し、失敗したものをまとめて報告してくれます。

import org.assertj.core.api.SoftAssertions;

// ...

@Test
void userPropertiesShouldBeCorrect() {
    User user = new User("Alice", 99, "support@example.com");
    SoftAssertions soft = new SoftAssertions();

    soft.assertThat(user.getName()).isEqualTo("Bob"); // 失敗
    soft.assertThat(user.getAge()).isLessThan(100); // 成功
    soft.assertThat(user.getEmail()).endsWith("@test.com"); // 失敗

    // 全てのアサーションを評価し、失敗があれば報告する
    soft.assertAll();
}

このテストを実行すると、名前とEmailの両方のアサーションが失敗したことが一度に報告され、修正が効率的に行えます。JUnit 5のassertAllと似ていますが、AssertJの流暢なAPIスタイルで記述できるのが利点です。

カスタムアサーションの作成

プロジェクトが大きくなり、独自のドメインオブジェクト（例：User, Order, Product）を扱うようになると、繰り返し同じような検証を行う場面が増えてきます。このような場合、カスタムアサーションを作成することで、テストの可読性を飛躍的に高め、ドメイン固有の検証ロジックを再利用できます。

なぜカスタムアサーションが必要か？

例えば、Productというクラスがあり、それが「販売可能」である条件が「在庫が1以上あり、かつ非公開フラグが立っていない」だとします。カスタムアサーションがない場合、テストコードは次のようになります。

Product product = new Product("Laptop", 10, false);

assertThat(product.getStock()).isGreaterThan(0);
assertThat(product.isPrivate()).isFalse();

これでも問題はありませんが、「販売可能であること」というビジネスルールがコード上に直接表現されていません。カスタムアサーションを使うと、これを次のように書き換えられます。

// カスタムアサーションを使った場合の理想形
ProductAssert.assertThat(product).isSellable();

こちらのほうが、テストの意図が遥かに明確です。

カスタムアサーションの作り方

カスタムアサーションの作成は、3つのステップで行います。

1. アサーションクラスの作成: AbstractAssert を継承したクラスを作成します。
2. アサーションメソッドの実装: ドメイン固有の検証ロジックをメソッドとして実装します。
3. エントリーポイントメソッドの作成: assertThat(YourObject) という形で呼び出せるようにします。

import org.assertj.core.api.AbstractAssert;
import org.assertj.core.api.Assertions;

// Productクラスは name, stock, isPrivate を持つと仮定
public class ProductAssert extends AbstractAssert<ProductAssert, Product> {

    public ProductAssert(Product actual) {
        super(actual, ProductAssert.class);
    }

    // エントリーポイントとなるstaticメソッド
    public static ProductAssert assertThat(Product actual) {
        return new ProductAssert(actual);
    }

    // カスタムアサーションメソッド
    public ProductAssert isSellable() {
        isNotNull(); // まずnullチェック

        if (actual.getStock() <= 0) {
            failWithMessage("Expected product to be sellable, but stock was <%s>", actual.getStock());
        }
        if (actual.isPrivate()) {
            failWithMessage("Expected product to be sellable, but it was private");
        }

        return this; // メソッドチェーンのためにthisを返す
    }
    
    public ProductAssert hasName(String name) {
        isNotNull();
        Assertions.assertThat(actual.getName())
            .overridingErrorMessage("Expected product's name to be <%s> but was <%s>", name, actual.getName())
            .isEqualTo(name);
        return this;
    }
}

import static com.example.asserts.ProductAssert.assertThat;

// ...

@Test
void productShouldBeSellable() {
    Product sellableProduct = new Product("Keyboard", 5, false);
    Product notSellableProduct = new Product("Mouse", 0, false);
    Product privateProduct = new Product("Monitor", 10, true);

    // カスタムアサーションで可読性の高いテストを実現
    assertThat(sellableProduct)
        .isSellable()
        .hasName("Keyboard");
        
    // 失敗するケースのテスト
    assertThatThrownBy(() -> assertThat(notSellableProduct).isSellable());
    assertThatThrownBy(() -> assertThat(privateProduct).isSellable());
}

このように、カスタムアサーションはテストコードをドメインの言葉で語らせるための強力なツールです。適切に活用することで、テストは単なるコードの正しさの検証から、仕様書そのものへと昇華させることができます。

まとめ

AssertJは、Javaにおけるテストコードの記述を、より直感的で、表現力豊かで、楽しいものに変えてくれる強力なライブラリです。流れるようなAPIはコードの可読性を高め、豊富なアサーションメソッドは定型的な検証コードを削減します。

特に、コレクションの操作、例外の検証、そしてカスタムアサーションによるドメイン固有のルールの表現は、大規模なアプリケーションのテスト品質と保守性を維持する上で非常に価値があります。

もし、まだJUnitの標準アサーションのみを使用しているのであれば、ぜひ次のプロジェクトでAssertJの導入を検討してみてください。一度その書きやすさと表現力に慣れてしまうと、もう元には戻れなくなることでしょう。