# バッチ設計書 21-test

## 概要

本ドキュメントは、CoffeeScriptプロジェクトにおけるCakefile `test` タスクの設計仕様を記載したものである。このタスクはCoffeeScript言語のテストスイート全体を実行し、コンパイラの機能が正常に動作していることを検証する。

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

このバッチは、CoffeeScript言語の品質保証を担う中核的なテストスイート実行タスクである。`test/`ディレクトリ配下に格納された全てのテストファイル（.coffeeおよび.litcoffee）を読み込み、CoffeeScriptコンパイラを使用してテストを実行する。

**業務上の目的・背景**：CoffeeScriptコンパイラの品質を継続的に保証するため、コードの変更が既存機能を破壊していないかを検証する必要がある。このテストスイートにより、レキサー、リライター、パーサー、コード生成など全ての処理フェーズが正常に機能していることを確認できる。また、新機能追加時のリグレッションテストとしても機能する。

**バッチの実行タイミング**：開発者がコード変更を行った際に手動で実行される。また、`build:full`タスクや`release`タスクの一部として自動的に呼び出される。CIパイプラインでは、プルリクエストのマージ前やリリース前に必ず実行される。

**主要な処理内容**：
1. CoffeeScriptコンパイラの登録（`CoffeeScript.register()`）
2. グローバル変数とヘルパー関数の初期化
3. Node.jsランタイムの機能に基づくスキップ対象ファイルの判定
4. `test/`ディレクトリ内のテストファイルの列挙と読み込み
5. 各テストファイルのコンパイルと実行
6. 非同期テストの待機と結果収集
7. テスト結果の集計と失敗時のスタックトレース出力

**前後の処理との関連**：通常は`build`タスクでコンパイラがビルドされた後に実行される。`build:full`では2回のビルド後にこのテストが実行され、自己ビルドの検証に使用される。`release`タスクでは、ブラウザテストや統合テストと共に実行される。

**影響範囲**：テスト実行のみで、ソースコードやビルド成果物への変更は行わない。テスト失敗時はプロセスがエラーコード1で終了し、CIパイプラインを停止させる。

## バッチ種別

品質検証 / テスト実行

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動または自動） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動実行 / CIパイプライン / 他タスクからの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js v6以上がインストールされていること |
| ビルド済みコンパイラ | `lib/coffeescript/`にビルドされたコンパイラが存在すること |
| 依存パッケージ | `npm install`により依存パッケージがインストールされていること |
| テストファイル | `test/`ディレクトリにテストファイルが存在すること |

### 実行可否判定

特別な実行可否判定ロジックはない。ただし、特定のES6+機能を使用するテストファイルは、Node.jsランタイムがその機能をサポートしていない場合はスキップされる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | Cakefileタスクとして定義されており、追加パラメータは受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| test/*.coffee | CoffeeScript | 通常のテストファイル |
| test/*.litcoffee | Literate CoffeeScript | 文芸的プログラミング形式のテストファイル |
| test/support/helpers.coffee | CoffeeScript | テストヘルパー関数 |
| lib/coffeescript/ | JavaScript | ビルド済みCoffeeScriptコンパイラモジュール |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト結果サマリー（成功件数、実行時間） |
| 標準出力 | テキスト | 失敗時のエラー詳細とスタックトレース |
| プロセス終了コード | 数値 | 成功時: 0、失敗時: 1 |

### 出力ファイル仕様

ファイル出力は行わない。

## 処理フロー

### 処理シーケンス

```
1. runTests関数の呼び出し
   └─ CoffeeScriptモジュールを引数として受け取る

2. CoffeeScript.register()の実行
   └─ .coffeeファイルのrequire対応を有効化

3. グローバル変数の初期化
   └─ currentFile, passedTests, failuresなどの初期化
   └─ assert関数群（ok, equal, deepEqual等）をグローバルに設定
   └─ カラー出力用定数の設定

4. スキップ対象ファイルの判定
   └─ async/await機能のサポート確認
   └─ 累乗演算子のサポート確認
   └─ オブジェクトRest/Spreadのサポート確認
   └─ 正規表現dotAllフラグのサポート確認
   └─ 数値リテラルセパレータのサポート確認
   └─ BigIntのサポート確認
   └─ import assertionsのサポート確認

5. テストファイルの列挙
   └─ test/ディレクトリ内の.coffeeと.litcoffeeファイルを取得
   └─ スキップ対象ファイルを除外

6. 各テストファイルの実行
   └─ ファイル内容の読み込み
   └─ CoffeeScript.run()によるコンパイルと実行
   └─ 同期テストの即時評価
   └─ 非同期テストのPromise収集

7. 非同期テストの完了待機
   └─ Promise.all()による全非同期テスト完了待機

8. 結果出力と終了処理
   └─ 成功件数と実行時間の出力
   └─ 失敗時はエラー詳細を出力
   └─ 失敗がある場合はプロセスを終了コード1で終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CoffeeScript.register実行]
    B --> C[グローバル変数初期化]
    C --> D[スキップ対象ファイル判定]
    D --> E[test/ディレクトリスキャン]
    E --> F{テストファイル存在?}
    F -->|なし| G[結果出力]
    F -->|あり| H[ファイル読み込み]
    H --> I[CoffeeScript.run実行]
    I --> J{コンパイルエラー?}
    J -->|あり| K[failuresに追加]
    J -->|なし| L{テスト成功?}
    L -->|成功| M[passedTests++]
    L -->|失敗| K
    M --> N{次のファイルあり?}
    K --> N
    N -->|あり| H
    N -->|なし| O[非同期テスト完了待機]
    O --> G
    G --> P{failures存在?}
    P -->|あり| Q[エラー詳細出力]
    P -->|なし| R[成功メッセージ出力]
    Q --> S[exit code 1で終了]
    R --> T[バッチ終了]
```

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

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

データベース操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイルエラー | テストファイルのCoffeeScript構文エラー | エラーメッセージを確認し、該当ファイルを修正 |
| - | アサーションエラー | テストケースの期待値と実際値の不一致 | テストまたは実装を修正 |
| - | ランタイムエラー | テスト実行中のJavaScriptエラー | スタックトレースを確認し、原因を特定して修正 |

### リトライ仕様

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

### 障害時対応

テスト失敗時は以下の情報が出力される：
- 失敗したファイル名
- テストの説明（description）
- エラースタックトレース
- テスト関数のソースコード（利用可能な場合）

これらの情報を基に原因を特定し、テストコードまたは実装コードを修正する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約50テストファイル、数千テストケース |
| 目標処理時間 | 数十秒以内 |
| メモリ使用量上限 | Node.jsデフォルト |

## 排他制御

同時実行に対する排他制御は行わない。ただし、同じ環境で複数のテストプロセスを同時に実行することは推奨されない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | - |
| 進捗ログ | なし | - |
| 終了ログ | テスト完了時 | "passed X tests in Y seconds" |
| エラーログ | テスト失敗時 | "failed X and passed Y tests in Z seconds" + 詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプライン |
| 処理時間 | プロジェクト設定による | CI/CDパイプライン |

## 備考

- Node.jsのバージョンによってサポートされるES6+機能が異なるため、一部のテストファイルは自動的にスキップされる
- `--harmony`フラグを付けて実行することで、より多くのES6+テストが実行可能になる場合がある
- npm scriptsの`test`および`test-harmony`からも実行可能
