Dart および Flutter テストカバレッジの実装

目次

• テスト基礎
• カバレッジディレクティブ
• ワークフロー: カバレッジレポートの設定と生成
• ワークフロー: 高度な手動カバレッジ収集
• 例

テスト基礎

標準的な Dart テストパラダイムを使用してテストスイートを構成します。Dart プロジェクトには package:test を、Flutter プロジェクトには flutter_test を使用します。

• ユニットテスト: 個別の関数、メソッド、またはクラスを検証します。
• コンポーネント/ウィジェットテスト: コンポーネントの動作、レイアウト、およびインタラクションを検証します（package:mockito などのモックオブジェクトを使用）。
• 統合テスト: シミュレートされたまたは実際のデバイス上でアプリ全体のフローを検証します。

カバレッジディレクティブ

インラインコメントを使用して、カバレッジメトリクスから特定の行、ブロック、またはファイル全体を除外します。フォーマット中に --check-ignore フラグを渡して、これらのディレクティブを強制します。

• 1 行を無視: // coverage:ignore-line
• コードブロックを無視: // coverage:ignore-start および // coverage:ignore-end
• ファイル全体を無視: // coverage:ignore-file

ワークフロー: カバレッジレポートの設定と生成

coverage パッケージを追加し、テストを実行し、LCOV レポートを生成するには、このシーケンシャルワークフローに従います。

タスク進捗チェックリスト:

• 1. coverage を dev_dependency として追加します。
• 2. 自動化されたカバレッジスクリプトを実行します。
• 3. LCOV 出力を検証します。

1. 依存関係を追加

coverage パッケージをプロジェクトに dev_dependency として追加します。標準的な依存関係には追加しないでください。

標準的な Dart プロジェクトで作業している場合:

dart pub add dev:coverage

Flutter プロジェクトで作業している場合:

flutter pub add dev:coverage

2. カバレッジを収集して LCOV を生成

バンドルされた test_with_coverage スクリプトを使用します。このスクリプトは自動的にすべてのテストを実行し、Dart VM から JSON カバレッジデータを収集し、それを LCOV レポートにフォーマットします。

dart run coverage:test_with_coverage

注: Dart ワークスペース (monorepo) 内で作業している場合は、テストディレクトリを明示的に指定してください（例: dart run coverage:test_with_coverage -- pkgs/foo/test pkgs/bar/test）。

3. フィードバックループ: 出力を検証

バリデータを実行 -> エラーを確認 -> 修正:

1. coverage/ ディレクトリがプロジェクトルートに作成されたことを確認します。
2. coverage/coverage.json (raw data) および coverage/lcov.info (formatted report) が存在することを確認します。
3. 特定のファイルのカバレッジが不足している場合は、テストファイルでインポートされて実行されていることを確認するか、意図的に除外されている場合は // coverage:ignore-file を追加してください。

ワークフロー: 高度な手動カバレッジ収集

VM サービス、アイソレート一時停止に対する細粒度制御が必要な場合、またはブランチ/関数レベルのカバレッジが必要な場合は、手動収集ワークフローを使用します。

タスク進捗チェックリスト:

• 1. VM サービスを有効にしてテストを実行します。
• 2. raw JSON カバレッジを収集します。
• 3. JSON を LCOV にフォーマットします。

1. VM サービスでテストを実行

アイソレートを終了時に一時停止し、VM サービスを特定のポート（例: 8181）で公開しながらテストを実行します。

dart run --pause-isolates-on-exit --disable-service-auth-codes --enable-vm-service=8181 test &

2. Raw カバレッジを収集

実行中の VM サービスからカバレッジデータを抽出し、JSON ファイルに出力します。

dart run coverage:collect_coverage --wait-paused --uri=http://127.0.0.1:8181/ -o coverage/coverage.json --resume-isolates

オプション: より深いメトリクスを収集するために --function-coverage および --branch-coverage を追加します（Dart VM 2.17.0+ が必要）。

3. LCOV にフォーマット

raw JSON データを標準 LCOV フォーマットに変換します。

dart run coverage:format_coverage --packages=.dart_tool/package_config.json --lcov -i coverage/coverage.json -o coverage/lcov.info --check-ignore

例

例: pubspec.yaml 設定

pubspec.yaml が coverage パッケージを厳密に dev_dependencies の下に反映していることを確認します。

name: my_dart_app
environment:
  sdk: ^3.0.0

dependencies:
  path: ^1.8.0

dev_dependencies:
  test: ^1.24.0
  coverage: ^1.15.0

例: 無視ディレクティブの適用

無視ディレクティブを使用して、生成されたコードまたはテスト不可能な edge cases がカバレッジスコアを低下させないようにします。

// coverage:ignore-file
import 'package:meta/meta.dart';

class SystemConfig {
  final String env;

  SystemConfig(this.env);

  // coverage:ignore-start
  void legacyInit() {
    print('Deprecated initialization');
  }
  // coverage:ignore-end

  bool isProduction() {
    if (env == 'prod') return true;
    return false; // coverage:ignore-line
  }
}