# バッチ設計書 41-test.sh

## 概要

本ドキュメントは、Babelプロジェクトにおけるローカルテスト実行バッチ `test.sh` の設計について記載する。このバッチはJestテストフレームワークを使用して、packages、codemods、eslintディレクトリ配下のテストを実行する。

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

**業務上の目的・背景**：開発者がローカル環境でBabelプロジェクトのテストを効率的に実行できるようにするためのバッチである。CI/CDパイプラインとは異なり、開発中に特定のテストを絞り込んで実行したり、デバッグモードでテストを実行したりする柔軟性を提供する。これにより、開発サイクルを短縮し、品質を確保しながら迅速なフィードバックを得ることができる。

**バッチの実行タイミング**：開発者が手動でローカル環境で実行する。コード変更後のテスト検証、バグ修正の確認、新機能の動作確認など、開発作業中に随時実行される。

**主要な処理内容**：
1. 環境変数の確認とJestオプションの構築
2. デバッグモード（TEST_DEBUG）が有効な場合、Node.jsのインスペクタを有効化し、直列実行モードに設定
3. CI環境の場合、ワーカー数を100%に設定し、CIモードを有効化
4. TEST_GREP環境変数によるテスト名フィルタリングの適用
5. TEST_ONLY環境変数による対象パッケージの絞り込み
6. Jestテストランナーの実行

**前後の処理との関連**：このバッチは独立して実行可能だが、テスト実行前に `make build` または `yarn gulp build-dev` によるビルドが必要な場合がある。Makefileでは `test` ターゲットの一部として、lintチェック後に `test-only` ターゲット経由で呼び出される。

**影響範囲**：packages、codemods、eslintディレクトリ配下の全テストファイルに影響する。テスト結果はコンソールに出力され、終了コードによって成否が判定される。

## バッチ種別

テスト実行

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発者の手動実行） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（ターミナルから直接実行またはMakefile経由） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Yarnを通じてNode.jsが実行可能であること |
| 依存関係インストール済み | `yarn install` によりnode_modulesが構築済みであること |
| ビルド完了 | テスト対象のパッケージがビルド済みであること（必要に応じて） |
| Bash環境 | シェルスクリプトとしてBash環境で実行可能であること |

### 実行可否判定

スクリプトは常に実行可能だが、ビルドが未完了の場合やnode_modulesが存在しない場合はテストが失敗する。`set -e` によりエラー発生時は即座に終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| TEST_DEBUG | 環境変数（文字列） | No | 未設定 | 設定時、Node.jsインスペクタを有効化しデバッグモードで実行 |
| CI | 環境変数（文字列） | No | 未設定 | CI環境を示すフラグ。設定時、ワーカー数100%とCIモードを有効化 |
| TEST_GREP | 環境変数（文字列） | No | 未設定 | テスト名のフィルタパターン（Jest -t オプションに渡される） |
| TEST_ONLY | 環境変数（文字列） | No | 未設定 | 対象パッケージ名のパターン（正規表現の一部として使用） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/test/**/*.js | JSファイル | 各パッケージのテストファイル |
| codemods/*/test/**/*.js | JSファイル | codemodのテストファイル |
| eslint/*/test/**/*.js | JSファイル | ESLintプラグインのテストファイル |
| jest.config.ts | TypeScript | Jestの設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト実行結果、進捗、成功/失敗の詳細 |
| 標準エラー出力 | テキスト | エラーメッセージ、スタックトレース |
| 終了コード | 数値 | 0: 成功、非0: 失敗 |

### 出力ファイル仕様

本バッチは直接ファイル出力を行わない。カバレッジ計測時は別途coverageディレクトリにレポートが出力される（jest.config.tsで設定）。

## 処理フロー

### 処理シーケンス

```
1. 初期設定
   └─ set -e でエラー時終了を有効化、変数初期化

2. デバッグモード判定
   └─ TEST_DEBUG環境変数がある場合、--inspect-brkと--runInBandを追加

3. CI環境判定
   └─ CI環境変数がある場合、--maxWorkers=100%と--ciを追加

4. テストフィルタ判定
   └─ TEST_GREPがある場合、-t オプションでテスト名フィルタを追加

5. パッケージ絞り込み判定
   └─ TEST_ONLYがある場合、対象パスパターンを追加

6. Jest実行
   └─ yarn node経由でJestを実行し、構築したオプションを渡す
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{TEST_DEBUG設定?}
    B -->|Yes| C[--inspect-brk追加<br>--runInBand追加]
    B -->|No| D{CI環境?}
    C --> D
    D -->|Yes| E[--maxWorkers=100%追加<br>--ci追加]
    D -->|No| F{TEST_GREP設定?}
    E --> F
    F -->|Yes| G[-t オプション追加]
    F -->|No| H{TEST_ONLY設定?}
    G --> H
    H -->|Yes| I[パスパターン追加]
    H -->|No| J[Jest実行]
    I --> J
    J --> K{テスト成功?}
    K -->|Yes| L[終了コード0で終了]
    K -->|No| M[終了コード非0で終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | テスト失敗 | テストケースが失敗した場合 | 失敗したテストの内容を確認し、コードを修正 |
| 127 | コマンド未発見 | Jestが見つからない場合 | yarn installを実行して依存関係をインストール |
| - | ビルドエラー | ソースが未ビルドの場合 | make build-devを実行してビルド |

### リトライ仕様

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

### 障害時対応

テスト失敗時は、失敗したテストケースの出力を確認し、該当するテストファイルとソースコードを調査する。デバッグが必要な場合は `TEST_DEBUG=true` を設定して実行し、Chrome DevToolsでステップ実行による調査を行う。

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

本バッチはデータベーストランザクションを使用しない。

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数千件のテストケース |
| 目標処理時間 | 全テスト: 数分〜数十分（フィルタリング時は数秒〜数分） |
| メモリ使用量上限 | Node.jsのデフォルト設定に依存 |

## 排他制御

同時実行の制限はない。ただし、同一ディレクトリで複数のテストプロセスを並行実行した場合、一時ファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | テスト実行中 | 各テストスイートの実行状況 |
| 結果ログ | テスト終了時 | 成功/失敗件数、所要時間 |
| エラーログ | テスト失敗時 | 失敗したテストの詳細、スタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | ローカル実行のため監視対象外 |

## 備考

- Windows環境では本スクリプトは直接実行できない。代わりに `yarn jest` コマンドを使用する
- jest-light-runnerを使用しており、高速なテスト実行が可能
- カバレッジ計測は別途 `make test-cov` または `BABEL_COVERAGE=true` 環境変数で実行する
