# バッチ設計書 7-test-coverage

## 概要

本ドキュメントは、GitHub Actions CI/CDパイプラインにおけるテストカバレッジ計測バッチの設計仕様を定義する。

### 本バッチの処理概要

Node.js最新版でJestテストをカバレッジ計測付きで実行し、結果をCodecovにアップロードするバッチ処理である。コードカバレッジを継続的に監視することで、テスト品質を可視化する。

**業務上の目的・背景**：Babelはコンパイラとして高い信頼性が求められるプロジェクトである。コードカバレッジを計測・追跡することで、テストの網羅性を可視化し、未テスト箇所を特定できる。Codecovと連携することで、プルリクエスト単位でのカバレッジ変化を確認でき、品質劣化を防止する。本バッチはビルド済みアーティファクトに対してテストを実行し、ESMテストも含めた包括的な検証を行う。

**バッチの実行タイミング**：リポジトリへのpush時およびプルリクエスト作成時に自動実行される。buildジョブの完了後に実行される。

**主要な処理内容**：
1. リポジトリのチェックアウトとNode.jsセットアップ
2. 依存関係のインストール
3. ビルド済みアーティファクトのダウンロード
4. c8によるカバレッジ計測付きJestテスト実行
5. ESMテストの実行
6. Codecovへのカバレッジレポートアップロード

**前後の処理との関連**：buildジョブに依存し、ビルド済みアーティファクトをダウンロードして使用する。カバレッジデータはCodecovにアップロードされ、プルリクエストにカバレッジレポートが表示される。

**影響範囲**：テスト結果、カバレッジレポート、Codecovダッシュボード、CIパイプライン全体の成功/失敗。

## バッチ種別

テスト実行 / カバレッジ計測 / CI/CD

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（イベント駆動） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | push / pull_request イベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| build | ビルドジョブが正常完了していること |
| babel-artifact | ビルドアーティファクトが利用可能であること |
| CODECOV_TOKEN | Codecov認証トークンがシークレットに設定されていること |

### 実行可否判定

GitHub Actionsのneeds設定に基づき、buildジョブの正常完了後に自動実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| BABEL_ENV | string | No | test | Babel環境設定 |
| BABEL_COVERAGE | boolean | No | true | カバレッジ計測フラグ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| babel-artifact | アーティファクト | ビルド済みパッケージ |
| packages/*/test | JavaScript/TypeScript | テストファイル |
| jest.config.js | JavaScript | Jest設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| coverage/ | LCOV/JSON | カバレッジデータ |
| Codecov | ダッシュボード | カバレッジレポート |
| 標準出力 | テキスト | テスト結果 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| カバレッジ形式 | c8標準出力（v8カバレッジ） |
| レポート名 | babel-7（Codecov上の識別子） |
| 出力先 | coverage/ディレクトリ |

## 処理フロー

### 処理シーケンス

```
1. Checkout code
   └─ actions/checkout@v4でリポジトリをチェックアウト
2. Use Node.js latest
   └─ actions/setup-node@v4でNode.js 25.6.1をセットアップ
3. Install
   └─ yarn installで依存関係をインストール
4. Download artifact
   └─ actions/download-artifact@v4でbabel-artifactをダウンロード
5. Run tests
   └─ yarn c8 jest --ci（カバレッジ計測付きテスト）
   └─ yarn test:esm（ESMテスト）
   └─ BABEL_ENV=test、BABEL_COVERAGE=true
6. Upload coverage report
   └─ codecov/codecov-action@v5でCodecovにアップロード
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[actions/checkout: リポジトリ取得]
    B --> C[actions/setup-node: Node.js セットアップ]
    C --> D[yarn install: 依存関係インストール]
    D --> E[actions/download-artifact: アーティファクト取得]
    E --> F[yarn c8 jest --ci]
    F --> G{テスト成功?}
    G -->|失敗| H[バッチ失敗終了]
    G -->|成功| I[yarn test:esm]
    I --> J{ESMテスト成功?}
    J -->|失敗| H
    J -->|成功| K[codecov/codecov-action: アップロード]
    K --> L[バッチ正常終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチではデータベース操作は行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

### テーブル別操作詳細

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| EXIT_1 | テスト失敗 | Jestテスト失敗時 | テスト結果を確認して修正 |
| EXIT_1 | ESMテスト失敗 | ESMモジュールテスト失敗時 | ESM互換性を確認して修正 |
| CODECOV_ERROR | アップロード失敗 | Codecov通信エラー時 | CODECOV_TOKENの確認、再実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（テスト失敗はリトライ不要） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. GitHub Actionsのジョブログを確認
2. テスト失敗の場合：
   - 失敗したテストケースを特定
   - ローカルで`yarn jest <test-path>`を実行して再現
3. ESMテスト失敗の場合：
   - ESMモジュールの互換性問題を確認
   - `yarn test:esm`で再現
4. Codecovエラーの場合：
   - CODECOV_TOKENの有効性を確認
   - Codecovのサービス状態を確認

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（テスト実行のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数千のテストケース実行 |
| 目標処理時間 | 15分以内 |
| メモリ使用量上限 | ubuntu-latestランナーのデフォルト |

## 排他制御

concurrency設定により、同一ワークフロー・同一リファレンスの実行は1つに制限される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ジョブ開始時 | GitHub Actions自動出力 |
| テストログ | Jest実行時 | テスト結果、成功/失敗件数 |
| カバレッジログ | c8実行時 | カバレッジサマリー |
| アップロードログ | Codecov実行時 | アップロード結果 |
| 終了ログ | ジョブ終了時 | 成功/失敗ステータス |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ成功率 | 100% | GitHubステータスチェック |
| カバレッジ低下 | 設定値による | Codecov PR コメント |

## 備考

- c8はV8のネイティブカバレッジ機能を使用し、高速なカバレッジ計測を実現
- Jest 30を使用（package.jsonで確認）
- test:esmはpackage.jsonで定義されたESMテストスクリプト
- Codecovレポート名は"babel-7"（Babel 9用は別ジョブ）
- BABEL_COVERAGE=trueにより、Babelのソースマップを考慮したカバレッジ計測
- --ciフラグによりCI環境に最適化されたテスト実行
