# バッチ設計書 13-cover

## 概要

本ドキュメントは、webpackプロジェクトにおけるnpm script `cover` の処理内容、実行条件、入出力仕様、エラー処理等を定義するバッチ設計書である。

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

`cover` は、webpackプロジェクトのテストカバレッジを取得し、レポートを生成するバッチである。JestのCoverageオプションを利用してテスト実行時のコードカバレッジデータを収集し、nycを使用してlcovおよびテキスト形式のレポートを生成する。

**業務上の目的・背景**：webpackプロジェクトのコード品質を定量的に評価するために、テストカバレッジの測定が不可欠である。本バッチにより、どのコードがテストでカバーされているか、どの部分にテストが不足しているかを可視化し、テスト戦略の改善やコード品質の維持に活用する。カバレッジレポートはCI/CDパイプラインでの品質ゲートとしても利用可能である。

**バッチの実行タイミング**：開発者がカバレッジを確認したい場合に手動実行する。CI/CDパイプラインでの品質チェック時にも使用可能。サブコマンド（`cover:all`、`cover:unit`、`cover:basic`、`cover:integration` 等）によりテスト範囲を限定した実行も可能。

**主要な処理内容**：
1. `yarn cover:all` - Jestの `--coverage` オプション付きで全テストを実行し、カバレッジデータをJSON形式で収集
2. `yarn report:cover` - nycを使用してカバレッジデータからlcovおよびテキスト形式のレポートを生成

**前後の処理との関連**：テストコード自体は `test` スクリプトと同じJest設定（`jest.config.js`）を使用する。`cover:base` は `test:base` と同様のNode.jsフラグ（`--expose-gc`、`--max-old-space-size=4096`、`--experimental-vm-modules`）でJestを起動する。生成されたカバレッジレポートは `coverage/` ディレクトリに出力される。`types:cover:report` は型カバレッジ用の別系統のレポートを生成する。

**影響範囲**：テスト実行自体はプロジェクトファイルを変更しない。カバレッジデータは `coverage/` ディレクトリに出力され、レポートファイル（lcov、テキスト）が生成される。`jest.config.js` の `coverageDirectory` 設定により `<rootDir>/coverage` に出力される。`.nyc_output` ディレクトリがnycの作業ディレクトリとして一時的に使用される。

## バッチ種別

テストカバレッジ取得 / レポート生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行（`yarn cover`）、CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js 10.13.0以上 | package.jsonのenginesフィールドによる要件 |
| npm依存関係インストール済み | jest-cli、nyc等が必要 |
| テストコード存在 | test/配下にテストファイル（*.test.js、*.basictest.js等）が必要 |
| --expose-gc対応 | V8のGC APIを使用するため、Node.jsの--expose-gcフラグが必要 |

### 実行可否判定

全ての前提条件が満たされていれば実行可能。`&&` 演算子により `cover:all` が失敗した場合は `report:cover` は実行されない。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチ（cover）はパラメータを受け取らない。サブコマンドによりテスト対象を限定可能 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| test/*.test.js | JavaScript | テストファイル群 |
| test/*.basictest.js | JavaScript | 基本テストファイル群 |
| test/*.longtest.js | JavaScript | 長時間テストファイル群 |
| test/*.unittest.js | JavaScript | ユニットテストファイル群 |
| test/*.spectest.js | JavaScript | スペックテストファイル群 |
| jest.config.js | JavaScript | Jest設定ファイル |
| lib/**/*.js | JavaScript | カバレッジ測定対象のソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| coverage/ | ディレクトリ | カバレッジデータおよびレポートの出力先 |
| coverage/coverage-final.json | JSON | Jestが出力するカバレッジデータ（json形式） |
| coverage/lcov-report/ | HTML | lcov形式のカバレッジレポート |
| coverage/lcov.info | テキスト | lcov形式のカバレッジサマリー |
| 標準出力 | テキスト | テキスト形式のカバレッジレポート（nyc report --reporter=text） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | coverage-final.json、lcov.info 等 |
| 出力先 | `<rootDir>/coverage` （jest.config.jsのcoverageDirectory設定） |
| 文字コード | UTF-8 |
| 区切り文字 | JSON形式 / lcov形式 |

## 処理フロー

### 処理シーケンス

```
1. cover:all 実行
   ├─ Node.jsオプション設定: --expose-gc --max-old-space-size=4096 --experimental-vm-modules
   ├─ Jest起動: --logHeapUsage --coverage
   ├─ テストファイル検索: jest.config.js の testMatch パターンに基づく
   ├─ テスト実行: 各テストファイルを実行しカバレッジデータを収集
   └─ カバレッジデータ出力: coverage/ ディレクトリにJSON形式で保存
2. report:cover 実行
   ├─ nyc report --reporter=lcov: lcov形式のレポート生成
   ├─ nyc report --reporter=text: テキスト形式のレポート生成（標準出力）
   └─ -t coverage: カバレッジデータの読み込み元を指定
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[cover:all<br>Jest --coverage]
    B --> B1[Node.jsオプション設定<br>--expose-gc<br>--max-old-space-size=4096<br>--experimental-vm-modules]
    B1 --> B2[テストファイル検索<br>testMatch パターンに基づく]
    B2 --> B3[テスト実行<br>カバレッジデータ収集]
    B3 --> B4{テスト結果}
    B4 -->|成功| C[report:cover<br>nyc report]
    B4 -->|失敗| Z[バッチ異常終了]
    C --> C1[lcovレポート生成]
    C1 --> C2[テキストレポート生成]
    C2 --> D[バッチ正常終了]
```

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | 該当なし | 該当なし | 該当なし |

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| exit 1 | テスト失敗 | いずれかのテストケースが失敗 | テストコードまたは対象コードを修正 |
| exit 1 | Jest設定エラー | jest.config.jsの設定不正 | Jest設定ファイルを確認・修正 |
| exit 1 | メモリ不足 | ヒープサイズ4096MBを超過 | テスト対象を分割して実行（cover:unit等） |
| exit 1 | nycレポート生成失敗 | カバレッジデータの読み込みエラー | coverageディレクトリの存在とデータを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

テスト失敗の場合は、失敗したテストケースのエラーメッセージを確認し、対象コードまたはテストコードを修正する。メモリ不足の場合は、サブコマンド（`cover:unit`、`cover:basic`）を使用してテスト範囲を限定する。カバレッジレポート生成失敗の場合は、`report:cover:clean` で一時ファイルを削除してから再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（データベース操作なし） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千テストケース |
| 目標処理時間 | テスト規模に依存（数十分〜数時間） |
| メモリ使用量上限 | 4096MB（--max-old-space-size=4096） |

## 排他制御

同一プロジェクトディレクトリ内での同時実行は推奨されない。テスト実行時に `test/js` ディレクトリへの出力が発生するため、競合の可能性がある。CIでは各ジョブが独立した環境で実行される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | Jest起動時 | テスト環境情報、テストスイート数 |
| 進捗ログ | テスト実行中 | 各テストスイートの実行結果、ヒープ使用量（--logHeapUsage） |
| 終了ログ | Jest完了時 | テスト結果サマリー（成功数、失敗数、スキップ数） |
| カバレッジログ | report:cover実行時 | テキスト形式のカバレッジサマリー（標準出力） |
| エラーログ | テスト失敗時 | 失敗したテストケースのエラーメッセージ、スタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| プロセス終了コード | != 0 | CI/CDパイプライン |
| テスト実行時間 | タイムアウト値（1テストあたり30秒 - jest.config.jsのtestTimeout） | Jest標準エラー出力 |
| ヒープ使用量 | 4096MB | Node.js OOM エラー |

## 備考

- `cover` は `cover:all && report:cover` として実行される。`cover:all` は `cover:base --coverage` と等価であり、`cover:base` は `test:base` と同様のNode.jsフラグで実行される。
- サブコマンドにより対象テストを限定可能：`cover:unit`（*.unittest.js）、`cover:basic`（*.basictest.js）、`cover:integration`（*.basictest.js + *.longtest.js + *.test.js）、`cover:test262`（*.spectest.js）。
- `jest.config.js` の `coverageReporters` は `["json"]` に設定されており、JestはJSON形式でカバレッジデータを出力する。lcov等のレポートはnycにより後続ステップで生成される。
- `coveragePathIgnorePatterns` により、ランタイムファイル（*.runtime.js）、テストディレクトリ、スキーマ、サンプル、node_modulesはカバレッジ対象から除外される。
- `report:cover:clean` で `.nyc_output` と `coverage` ディレクトリを削除可能。`report:cover:merge` は複数のカバレッジデータをマージする機能を提供する。
- Jest 30系（^30.2.0）を使用しており、`--experimental-vm-modules` フラグによりESモジュールのテストに対応している。
