DartおよびFlutterアプリケーションのテスト

目次

• テストファイルの構成
• テストの記述
• テストの実行
• テスト実装ワークフロー
• 例

テストファイルの構成

テストファイルをlibディレクトリ構造に対応させて整理し、予測可能性を保ちます。

• すべてのテストコードをパッケージのルートにあるtestディレクトリに配置します。
• すべてのテストファイル名の末尾に_test.dartを付けます（例：lib/src/utils.dartはtest/src/utils_test.dartでテストします）。
• 統合テストを作成する場合は、パッケージのルートにあるintegration_testディレクトリに配置します。

テストの記述

Dartアプリケーションの標準テストライブラリとしてpackage:testを使用します。

• package:test/test.dartをインポートします（Flutterの場合はpackage:flutter_test/flutter_test.dart）。
• group()関数を使用して関連するテストをグループ化し、共有コンテキストを提供します。
• test()関数を使用して個別のテストケースを定義します。
• expect()関数をマッチャー（例：equals()、isTrue、throwsA()）とともに使用して結果を検証します。
• 標準的なasync/await構文を使用して非同期テストを記述します。テストランナーは自動的にFutureの完了を待機します。
• setUp()およびtearDown()コールバックを使用してテストのセットアップとクリーンアップを管理します。
• 依存性注入に依存するコードをテストする場合は、package:mockitoをpackage:testとともに使用して、モックオブジェクトを生成し、固定シナリオを設定し、相互作用を検証します。

テストの実行

プロジェクトタイプとテスト位置に基づいて、適切なテストランナーを選択します。

• 純粋なDartプロジェクトで作業している場合は、dart testコマンドを使用してテストを実行します。
• Flutterプロジェクトで作業している場合は、flutter testコマンドを使用してテストを実行します。
• 統合テストを実行する場合は、デフォルトランナーはそれを無視するため、明示的にディレクトリパスを指定します：dart test integration_testまたはflutter test integration_test。

テスト実装ワークフロー

新しいテストスイートを実装する際は、この順序に従ったワークフローに従います。チェックリストをコピーして進捗を追跡してください。

タスク進捗

• 1. test/ディレクトリにテストファイルを作成し、_test.dartサフィックスを確認します。
• 2. package:test/test.dartとターゲットライブラリをインポートします。
• 3. main()関数を定義します。
• 4. setUp()を使用して共有リソースまたはモックを初期化します。
• 5. group()を使用して機能別にグループ化されたtest()ケースを記述します。
• 6. 適切なCLIコマンドを使用してテストスイートを実行します。
• 7. フィードバックループ：テスト実行 → 失敗のスタックトレースを確認 → 実装またはアサーションを修正 → パスするまで再実行。

例

標準ユニットテストスイート

グループ化、セットアップ、同期および非同期テストを示しています。

import 'package:test/test.dart';
import 'package:my_package/calculator.dart';

void main() {
  group('Calculator', () {
    late Calculator calc;

    setUp(() {
      calc = Calculator();
    });

    test('adds two numbers correctly', () {
      expect(calc.add(2, 3), equals(5));
    });

    test('handles asynchronous operations', () async {
      final result = await calc.fetchRemoteValue();
      expect(result, isNotNull);
      expect(result, greaterThan(0));
    });
  });
}

Mockitoによるモッキング

依存性注入テスト用のモックオブジェクトの設定を示しています。

import 'package:test/test.dart';
import 'package:mockito/mockito.dart';
import 'package:mockito/annotations.dart';
import 'package:my_package/api_client.dart';
import 'package:my_package/data_service.dart';

// build_runnerを使用してモックを生成します：dart run build_runner build
@GenerateNiceMocks([MockSpec<ApiClient>()])
import 'data_service_test.mocks.dart';

void main() {
  group('DataService', () {
    late MockApiClient mockApiClient;
    late DataService dataService;

    setUp(() {
      mockApiClient = MockApiClient();
      dataService = DataService(apiClient: mockApiClient);
    });

    test('returns parsed data on successful API call', () async {
      // モックを設定します
      when(mockApiClient.get('/data')).thenAnswer((_) async => '{"id": 1}');

      // テスト対象システムを実行します
      final result = await dataService.fetchData();

      // 結果と相互作用を検証します
      expect(result.id, equals(1));
      verify(mockApiClient.get('/data')).called(1);
    });
  });
}