# バッチ設計書 9-npm script: test

## 概要

本ドキュメントは、Jestによるテスト実行バッチ `npm script: test` の設計仕様を定義するものである。`--expose-gc --max-old-space-size=4096` オプション付きでJestを起動し、webpackプロジェクトのテストスイートを実行する。

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

`npm script: test` は、webpackプロジェクトの自動テストを実行するためのバッチである。Jestテストフレームワークを使用し、Node.jsのV8ガベージコレクション制御やメモリ上限設定を適用した状態でテストスイートを実行する。`pretest` フックによりlint処理が先行実行された後、各種テストケースが実行される。

**業務上の目的・背景**：webpackはモジュールバンドラーとして高い品質が求められるため、包括的な自動テストスイートを維持している。テストはbasictest、unittest、longtest、test（統合テスト）、spectest（ECMAScript仕様テスト）の複数カテゴリに分類され、各カテゴリに応じたサブコマンドが用意されている。このバッチはCI/CDパイプラインおよびローカル開発でのテスト実行の中心となる。

**バッチの実行タイミング**：開発者によるローカルテスト実行時、CI/CDパイプラインでのプルリクエスト検証時。`pretest` により自動的にlint処理が先行する。

**主要な処理内容**：
1. `pretest` フックにより `yarn lint` を実行（コード品質チェック）
2. Node.jsオプション `--expose-gc`（V8 GCへのアクセス許可）、`--max-old-space-size=4096`（ヒープメモリ上限4GB）、`--experimental-vm-modules`（ESMモジュールのVM対応）、`--trace-deprecation`（非推奨警告のスタックトレース）を適用
3. jest-cliを起動し、`--logHeapUsage` オプションでヒープ使用量をログ出力しながらテストを実行
4. テスト結果を集計して報告する

**前後の処理との関連**：`pretest` で `yarn lint`（No.10）が先行実行される。サブコマンドとして `test:basic`、`test:unit`、`test:integration`、`test:test262` 等が用意されており、テスト範囲を限定して実行可能。`cover` コマンド（No.13）はテストとカバレッジ計測を組み合わせたバッチである。

**影響範囲**：テスト結果の報告のみでソースコードやデータに変更は加えない。テスト中にwebpackのビルド処理が実行されるため、一時ファイルが生成される場合がある。

## バッチ種別

テスト実行

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発時・CI/CD時） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（npm test / yarn test）またはCI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.jsランタイム | Node.jsがインストールされていること |
| Jest | jest、jest-cli、jest-circusがdevDependencyとしてインストール済みであること |
| webpackセットアップ | `yarn setup` によるシンボリックリンクが作成済みであること（prelintで自動実行） |
| 依存パッケージ | 全devDependenciesがインストール済みであること |

### 実行可否判定

特別な実行可否判定ロジックはない。pretestフック（yarn lint）が失敗した場合はテスト実行が中断される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --testMatch | string | No | 全テスト | テスト対象のファイルパターン（サブコマンドで指定） |
| -u | フラグ | No | false | スナップショットの更新（test:update-snapshots） |
| その他Jest引数 | 各種 | No | 各種 | Jestに渡される任意の引数 |

### サブコマンド一覧

| サブコマンド | testMatchパターン | 説明 |
|-------------|------------------|------|
| test:basic | `<rootDir>/test/*.basictest.js` | 基本テスト |
| test:unit | `<rootDir>/test/*.unittest.js` | ユニットテスト |
| test:integration | `<rootDir>/test/*.{basictest,longtest,test}.js` | 統合テスト |
| test:test262 | `<rootDir>/test/*.spectest.js` | ECMAScript仕様テスト |
| test:update-snapshots | 全テスト + -u フラグ | スナップショット更新 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| test/*.basictest.js | JavaScriptテストファイル | 基本テストケース |
| test/*.unittest.js | JavaScriptテストファイル | ユニットテストケース |
| test/*.longtest.js | JavaScriptテストファイル | 長時間実行テストケース |
| test/*.test.js | JavaScriptテストファイル | 統合テストケース |
| test/*.spectest.js | JavaScriptテストファイル | ECMAScript仕様テストケース |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力（stdout） | テキスト | テスト結果サマリー、ヒープ使用量 |
| 標準エラー出力（stderr） | テキスト | テスト失敗の詳細 |
| process.exitCode | 数値 | 0: 全テスト成功、1: テスト失敗あり |

### 出力ファイル仕様

テスト実行自体はファイル出力を行わないが、スナップショット更新（-u）時にはスナップショットファイルが更新される。

## 処理フロー

### 処理シーケンス

```
1. pretestフック実行
   └─ yarn lint を実行（コード品質チェック）
   └─ 失敗した場合はテスト実行を中断
2. Node.jsオプション適用
   └─ --expose-gc: V8ガベージコレクションへのプログラムアクセスを有効化
   └─ --max-old-space-size=4096: ヒープメモリ上限を4GBに設定
   └─ --experimental-vm-modules: VMモジュールのESMサポートを有効化
   └─ --trace-deprecation: 非推奨機能使用時のスタックトレースを有効化
3. Jest起動
   └─ node_modules/jest-cli/bin/jest を実行
   └─ --logHeapUsage でヒープ使用量をテストごとに表示
4. テスト実行
   └─ テストファイルの検出・読み込み
   └─ 各テストケースの実行
   └─ 結果集計・レポート出力
```

### フローチャート

```mermaid
flowchart TD
    A[npm test 実行] --> B[pretest: yarn lint]
    B --> C{lint成功?}
    C -->|No| D[中断]
    C -->|Yes| E[Node.jsオプション適用]
    E --> F[Jest起動]
    F --> G[テストファイル検出]
    G --> H[テストケース実行]
    H --> I[結果集計]
    I --> J{全テスト成功?}
    J -->|Yes| K[exitCode=0]
    J -->|No| L[exitCode=1]
    K --> M[バッチ終了]
    L --> M
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| exitCode=1 | lint失敗 | pretestのyarn lintが失敗 | lintエラーを修正 |
| exitCode=1 | テスト失敗 | いずれかのテストケースが失敗 | テストの失敗原因を調査・修正 |
| OOM | メモリ不足 | ヒープメモリ4GBを超過 | テストの分割実行、またはメモリ上限の引き上げ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A（Jestの--retries等はjest.config.jsで別途設定可能） |

### 障害時対応

テスト失敗時はJestの出力を確認して個別のテストケースの失敗原因を調査する。メモリ不足の場合はサブコマンド（test:basic、test:unit等）でテスト範囲を限定して実行する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千のテストケース |
| 目標処理時間 | フルテストスイートで数分〜数十分 |
| メモリ使用量上限 | 4096 MB（--max-old-space-size=4096で設定） |

## 排他制御

排他制御は行わない。Jestのワーカープロセスにより並列実行される。`--logHeapUsage` によりメモリ使用量を監視可能。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| テスト進捗 | 各テストスイート完了時 | テスト名、結果（pass/fail）、実行時間 |
| ヒープ使用量 | 各テスト完了時 | ヒープメモリ使用量（--logHeapUsage） |
| テストサマリー | 全テスト完了時 | 合格/失敗/スキップのテスト数 |
| 失敗詳細 | テスト失敗時 | 期待値と実際値の差分、スタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト実行結果 | 失敗テスト数 > 0 | CI/CDパイプライン通知 |

## 備考

- `pretest` スクリプトで `yarn lint` が自動実行されるため、`npm test` は常にlintチェックを含む
- `--expose-gc` はglobal.gc()関数を有効にし、テスト中の明示的なGC呼び出しを可能にする
- `--experimental-vm-modules` はNode.jsのVMモジュールでESMをサポートするための実験的フラグ
- deno対応のサブコマンド（test:base:deno、test:basic:deno）も存在する
- test:baseは直接呼び出しの基本コマンドで、各サブコマンドから共通的に使用される
- package.jsonの `"test": "yarn test:base"` により、`npm test` は `test:base` にリダイレクトされる
