モック（Mock）を使った依存関係の分離テスト

プログラミング

モック（Mock）を使った依存関係の分離テスト：詳細と応用

モックとは何か、なぜ必要か

ソフトウェア開発において、テストは品質保証の要です。特に、単体テスト（ユニットテスト）は、コードの各部分が意図した通りに動作するかを個別に検証する重要な工程です。しかし、多くのプログラムは、他のクラスや外部サービスといった「依存関係」を持っています。これらの依存関係が、テスト対象のコード（テスト対象、またはUnit）の単体テストを困難にする場合があります。

例えば、データベースにアクセスするクラスや、ネットワーク通信を行うクラスをテストする場合、実際のデータベースやネットワークを使用すると、テストの実行に時間がかかったり、環境構築が複雑になったり、テスト結果が不安定になったりします。また、外部サービスに依存している場合、そのサービスが利用できない、あるいは有料であるといった問題も生じます。

そこで登場するのがモックです。モックとは、テスト対象が依存しているオブジェクトの「偽物」を作成する技術です。この偽物は、実際のオブジェクトと同じインターフェース（メソッドの呼び出し方など）を持っていますが、内部の動作はテストのために制御されています。具体的には、モックは、特定のメソッドが呼び出された際に、あらかじめ定義された値を返したり、特定の例外を発生させたりするように設定されます。

モックを使用する最大のメリットは、依存関係を分離できることです。テスト対象は、モックされた依存関係に対して、あたかも実際のオブジェクトであるかのように振る舞います。これにより、テスト対象のコードのロジックのみに集中してテストを実行できます。

モックの基本的な使い方

モックを作成し、テスト対象に注入するには、いくつかの一般的なパターンがあります。

コンストラクタインジェクション

テスト対象のクラスのコンストラクタで、依存関係のオブジェクトを受け取るように設計します。テスト時には、実際のオブジェクトの代わりにモックオブジェクトをコンストラクタに渡します。

例： 

class Calculator {
    private Adder adder;

    public Calculator(Adder adder) {
        this.adder = adder;
    }

    public int add(int a, int b) {
        return adder.add(a, b);
    }
}

// テストコード
Adder mockAdder = mock(Adder.class);
when(mockAdder.add(anyInt(), anyInt())).thenReturn(5); // どんな引数でも5を返すように設定

Calculator calculator = new Calculator(mockAdder);
assertEquals(5, calculator.add(2, 3)); // テスト対象のaddメソッドを呼び出す

セッターインジェクション

依存関係のオブジェクトを、メソッド（セッター）を通じて設定します。コンストラクタインジェクションと同様に、テスト時にはモックオブジェクトをセッターで設定します。

インターフェースインジェクション

依存関係をインターフェースとして定義し、テスト対象はそのインターフェースを通じて依存関係を利用します。テスト時には、そのインターフェースを実装したモックオブジェクトを渡します。

モックによるテストの具体例とメリット

ここでは、より具体的なシナリオでモックの利点を見ていきましょう。

例1：外部API連携クラスのテスト

あるサービスが、外部の天気予報APIにリクエストを送信し、その結果を処理するクラスを考えます。 

class WeatherService {
    private WeatherApiClient apiClient;

    public WeatherService(WeatherApiClient apiClient) {
        this.apiClient = apiClient;
    }

    public String getWeather(String city) {
        String rawData = apiClient.fetchWeatherData(city);
        // rawDataを解析して整形するロジック
        return parseWeatherData(rawData);
    }

    private String parseWeatherData(String rawData) {
        // ... 実際の解析処理 ...
        return "晴れ";
    }
}

この `WeatherService` をテストする際、実際の `WeatherApiClient` を使用すると、ネットワークの遅延やAPIの応答によってはテストが失敗する可能性があります。また、APIの仕様変更や利用制限などの外部要因にテストが左右されてしまいます。

モックを使用すると、`WeatherApiClient` の `fetchWeatherData` メソッドが特定の都市名に対して、あらかじめ定義された「架空の天気データ」を返すように設定できます。 

// テストコード
WeatherApiClient mockApiClient = mock(WeatherApiClient.class);
when(mockApiClient.fetchWeatherData("Tokyo")).thenReturn("{"weather": "sunny"}");

WeatherService weatherService = new WeatherService(mockApiClient);
assertEquals("晴れ", weatherService.getWeather("Tokyo")); // 期待通りの結果が得られる

この方法により、ネットワークの状態や外部APIの可用性に依存せず、`WeatherService` の `getWeather` メソッドの解析ロジックのみを独立してテストできます。

例2：データベースアクセスオブジェクト（DAO）のテスト

ユーザー情報をデータベースから取得するDAOクラスがあるとします。 

class UserDao {
    private DatabaseConnection dbConnection;

    public UserDao(DatabaseConnection dbConnection) {
        this.dbConnection = dbConnection;
    }

    public User getUserById(int id) {
        // dbConnection を使ってクエリを実行し、結果を User オブジェクトにマッピングする
        return dbConnection.executeQuery("SELECT * FROM users WHERE id = " + id);
    }
}

`UserDao` をテストするには、実際のデータベースへの接続が必要になります。これは、テスト環境のセットアップを複雑にし、テスト実行時間を増大させます。

モックを使用すると、`DatabaseConnection` の `executeQuery` メソッドが特定のクエリに対して、あらかじめ作成した「架空のユーザーデータ」を返すように設定できます。 

// テストコード
DatabaseConnection mockDbConnection = mock(DatabaseConnection.class);
User mockUser = new User(1, "Alice");
when(mockDbConnection.executeQuery("SELECT * FROM users WHERE id = 1")).thenReturn(mockUser);

UserDao userDao = new UserDao(mockDbConnection);
assertEquals(mockUser, userDao.getUserById(1)); // 期待通りのユーザーオブジェクトが返される

これにより、データベースにアクセスすることなく `UserDao` のマッピングロジックを検証できます。

モックの高度な使い方と考慮事項

モックは単に値を返すだけでなく、より高度な制御が可能です。

例外の発生

依存関係のオブジェクトがエラーを返すシナリオもテストしたい場合があります。モックでは、特定のメソッド呼び出し時に例外を発生させるように設定できます。 

// ネットワークエラーをシミュレート
when(mockApiClient.fetchWeatherData("London")).thenThrow(new NetworkException("Connection timed out"));
// ... エラーハンドリングのテスト ...

引数の検証

テスト対象のコードが、依存関係のメソッドを正しい引数で呼び出しているかを確認することも重要です。モックライブラリは、メソッドが呼び出された際に渡された引数を検証する機能を提供しています。 

// 特定の都市名でAPIが呼び出されたか検証
verify(mockApiClient).fetchWeatherData("Paris");
// 複数の引数を持つメソッドの検証
verify(mockDbConnection).prepareStatement("INSERT INTO ... WHERE id = ?");

コールド（Cold）とスタブ（Stub）の違い

モックという言葉は、しばしばスタブやドライバーといった関連する概念と混同されがちです。

  • スタブ (Stub): テスト対象のコードからの呼び出しに対して、あらかじめ定義された値を返すだけのシンプルな偽物です。
  • ドライバー (Driver): テスト対象のコードを呼び出すための偽物です。
  • モック (Mock): スタブの機能に加え、メソッドの呼び出し回数、引数、順序などを検証する機能を持つ、より高度な偽物です。

現代のモックライブラリでは、これらの区別は曖昧になりつつあり、多くの場合、一つのライブラリでスタブとしてもモックとしても機能させることができます。テストの目的（単に値を返すことが目的か、呼び出しを検証することが目的か）に応じて、使い分けることが重要です。

モック化の対象

原則として、テスト対象のコードが直接依存しているオブジェクトをモック化します。しかし、依存関係が複雑に連鎖している場合（AがBに依存し、BがCに依存している場合）、Aをテストする際にBをモック化することが一般的です。Cまでモック化する必要があるかは、Aのテストで検証したい範囲によります。

過度なモック化への注意

モックは強力なツールですが、過度に依存しすぎると、テストが実環境の振る舞いから乖離してしまうリスクがあります。

  • テストの脆さ（Fragility）: 依存関係の内部実装が少し変更されただけで、モックの設定も変更する必要が生じ、テストが壊れやすくなります。
  • テストカバレッジの低下: モックで実際の振る舞いを模倣しきれない場合、バグを見逃す可能性があります。

したがって、モックは依存関係の分離と単体テストの実現のために活用しつつ、統合テストやエンドツーエンドテストも適切に組み合わせることが、堅牢なテスト戦略には不可欠です。

まとめ

モック（Mock）は、ソフトウェアテストにおいて、依存関係を分離し、テスト対象のコードのみに焦点を当てて検証するための強力な手法です。コンストラクタインジェクションやセッターインジェクションなどの手法を用いて、テスト対象に偽の依存関係オブジェクト（モック）を注入します。これにより、外部サービス、データベース、その他の複雑なコンポーネントへの依存を排除し、高速かつ安定した単体テストを実現できます。

モックは、期待される値を返すだけでなく、例外の発生やメソッド呼び出しの検証など、高度な制御を可能にします。しかし、過度なモック化はテストの脆さやカバレッジの低下を招く可能性があるため、スタブやドライバーといった関連概念との違いを理解し、統合テストなど他のテスト手法とバランスを取りながら活用することが、効果的なソフトウェア開発プロセスには不可欠です。