JUnit 5でテストを指定した順序で実行する方法

JUnitでは、デフォルトでテストメソッドの実行順序は決まっておらず、毎回同じ順序になるとは限りません。しかし、テスト同士に依存関係がある場合など、特定の順序でテストを実行したいケースは少なくありません。

例えば、ユーザー管理APIをテストするシナリオを考えてみましょう。この場合、テストは次の順序で実行するのが自然です。

• 1. ユーザー作成(create)のテスト
• 2. ユーザー更新(update)のテスト
• 3. ユーザー削除(delete)のテスト

ユーザーの更新や削除をテストするには、対象となるユーザーがあらかじめ作成されている必要があるためです。

JUnit 5では、@TestMethodOrderと@Orderという2つのアノテーションを組み合わせることで、テストの実行順序を簡単に制御できます。

テストを指定した順序で実行する

具体的なコード例を見てみましょう。

import org.junit.jupiter.api.*;

@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class TestOrder {

    @Test
    @Order(1)
    public void testCreateUser() {
        // ユーザー作成をテストするコード
    }

    @Test
    @Order(2)
    public void testUpdateUser() {
        // ユーザー更新をテストするコード
    }

    @Test
    @Order(3)
    public void testDeleteUser() {
        // ユーザー削除をテストするコード
    }
}

テストクラスに@TestMethodOrder(MethodOrderer.OrderAnnotation.class)を付与し、各テストメソッドに@Orderで数値を指定すると、その数値の昇順でテストが実行されます。上記の例では、「作成 → 更新 → 削除」の順にテストが流れていきます。

@Orderの値に関する注意点

@Orderに指定する値は、各テストメソッドで重複しないようにしましょう。同じ値を持つテスト同士の相対的な順序は保証されません。また、値には負の数も指定でき、小さい数値ほど先に実行されます。

その他のMethodOrderer実装

MethodOrderer.OrderAnnotation以外にも、JUnit 5にはいくつかの並び替え戦略が用意されています。

• MethodOrderer.MethodName: メソッド名のアルファベット順で実行
• MethodOrderer.DisplayName: @DisplayNameで指定した表示名の順で実行
• MethodOrderer.Random: ランダムな順序で実行(シードを固定すれば再現可能)

用途に応じてこれらを使い分けることで、テストスイートの可読性と保守性を高めることができます。