# バッチ設計書 7-test/runtests.sh

## 概要

本ドキュメントは、serve-dプロジェクトにおける統合テストランナースクリプト `test/runtests.sh` のバッチ設計書である。

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

本バッチは、serve-dの統合テスト（Integration Tests）を実行するためのテストランナーである。serve-dをビルドした後、`tc*` パターンに一致する各テストケースディレクトリを順次実行し、成功/失敗を集計して最終結果を報告する。

**業務上の目的・背景**：ユニットテスト（test.sh/test.bat）だけではカバーできない、serve-dの実際の動作を検証するための統合テストを実行する。各テストケースは独立したディレクトリとして管理され、dubプロジェクトとして構成されている。DCD（D Completion Daemon）に依存するテストケースでは、自動的にDCDバイナリをダウンロードする機能も備えている。

**バッチの実行タイミング**：開発中に手動で実行されるほか、unittest.yml（No.10）のCIワークフローから自動実行される。コード変更時の統合テストとして使用される。

**主要な処理内容**：
1. 環境変数DCで指定されたコンパイラ（デフォルトdmd）を使用してserve-dをビルド
2. テストケースディレクトリ（tc*パターン）を列挙（引数で指定も可能）
3. 各テストケースについて、DCD依存の場合はDCDバイナリをダウンロード
4. dub upgradeとdubによるテスト実行
5. 成功/失敗カウントを集計し、最終結果を色付きで表示
6. 1件でも失敗があればexit 1で異常終了

**前後の処理との関連**：unittest.yml（No.10）のCIワークフローから呼び出される。DCD依存テストでは `test/data/dcd/download_dcd.d`（No.14）を使用してDCDバイナリをダウンロードする。

**影響範囲**：テスト結果が標準出力に色付きで表示される。DCD依存テストの場合、テストデータディレクトリにDCDバイナリがダウンロードされる。

## バッチ種別

テスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発時・CI） |
| 実行時刻 | CI時はpush/PRイベント発生時 |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動実行 / GitHub Actionsワークフローから呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| D言語コンパイラ | dmdまたはldc2がPATH上にインストールされていること |
| dubパッケージマネージャ | dubがPATH上にインストールされていること |
| テストケースディレクトリ | tc*パターンに一致するテストケースディレクトリが存在すること |
| 実行ディレクトリ | testディレクトリ内で実行すること |
| bash | bash互換シェルが利用可能であること |

### 実行可否判定

`set -euo pipefail` により厳格なエラーハンドリングが有効。ただしテストケースの成否はfail_count/pass_countで管理され、個々のテスト失敗では即座に終了しない。最終的にfail_countが0でない場合にexit 1で終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $@ | コマンドライン引数 | No | tc*（全テストケース） | 実行するテストケースディレクトリを指定 |
| DC | 環境変数 | No | dmd | 使用するD言語コンパイラ |
| CI | 環境変数 | No | 未設定 | CI環境フラグ（設定時にGitHub Actionsグルーピング出力を有効化） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| serve-dプロジェクトソースコード | D言語ソース | ビルド対象のソースコード（親ディレクトリ） |
| tc*テストケースディレクトリ | dubプロジェクト | 各統合テストケース |
| .needs_dcd | マーカーファイル | テストケースがDCDに依存することを示すフラグファイル |
| test/data/dcd/download_dcd.d | D言語スクリプト | DCDバイナリダウンロードスクリプト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト（色付き） | テスト実行結果（各テストケースの成否、最終集計） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| DCD関連ファイル | DCD依存テスト時にdcd-server*/dcd-client*がテストケースディレクトリにコピーされる |

## 処理フロー

### 処理シーケンス

```
1. 変数初期化
   └─ カラーコード定義（RED, GREEN, YELLOW, NORMAL）
   └─ DC環境変数未設定時はdmdをデフォルトに設定
   └─ fail_count=0, pass_count=0 を初期化
2. serve-dのビルド
   └─ 親ディレクトリに移動してdub buildを実行
   └─ DC=dmdの場合: デバッグビルド（--compiler=dmd）
   └─ DC=ldc2の場合: リリースビルド（--build=release --compiler=ldc2）
   └─ CI環境ではGitHub Actionsのgroupingを出力
3. テストケース列挙
   └─ 引数が指定されていればそのテストケースを使用
   └─ 引数なしの場合はtc*パターンで列挙
4. 各テストケースの実行（ループ）
   a. テストケース名を黄色で表示
   b. CI環境ではgrouping開始
   c. テストケースディレクトリに移動
   d. .needs_dcdファイルが存在する場合:
      - download_dcd.dを実行してDCDバイナリをダウンロード
      - dcd-server*/dcd-client*をテストケースディレクトリにコピー
   e. dub upgrade実行
   f. dub --compiler=DCで テスト実行
   g. 成功時: pass_count++、緑色で"Test Pass"表示
   h. 失敗時: fail_count++、赤色で"Test Fail"表示
   i. 元のディレクトリに戻る
5. 最終結果表示
   └─ fail_count=0: 緑色で全テスト成功を表示
   └─ fail_count>0: 赤色で失敗数を表示し、exit 1で終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[変数初期化・カラーコード定義]
    B --> C[serve-dビルド]
    C --> D[テストケース列挙]
    D --> E{次のテストケースあり?}
    E -->|Yes| F[テストケースディレクトリに移動]
    F --> G{.needs_dcd 存在?}
    G -->|Yes| H[DCDバイナリダウンロード・コピー]
    G -->|No| I[dub upgrade]
    H --> I
    I --> J[dub --compiler=DC でテスト実行]
    J -->|成功| K[pass_count++]
    J -->|失敗| L[fail_count++]
    K --> M[元のディレクトリに戻る]
    L --> M
    M --> E
    E -->|No| N{fail_count == 0 ?}
    N -->|Yes| O[緑色で成功表示 → 正常終了]
    N -->|No| P[赤色で失敗表示 → exit 1]
```

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

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

本バッチはデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | テスト失敗 | 1件以上のテストケースが失敗した場合 | 失敗したテストケースのログを確認し修正する |
| - | ビルドエラー | serve-dのビルドが失敗した場合 | コンパイルエラーを修正する |
| - | DCDダウンロードエラー | DCDバイナリのダウンロードに失敗した場合 | ネットワーク接続を確認する |

### リトライ仕様

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

### 障害時対応

テスト失敗時は色付き出力で失敗したテストケースが特定できる。個別のテストケースを引数指定して再実行し、詳細を調査する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | tc*パターンに一致するテストケース数（可変） |
| 目標処理時間 | CI環境で30分以内（unittest.ymlのtimeout-minutes: 30） |
| メモリ使用量上限 | 環境依存 |

## 排他制御

同一ディレクトリでの同時実行は想定されていない。テストケース間でのリソース競合の可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ビルドログ | serve-dビルド時 | dubおよびコンパイラのビルド進捗 |
| テストケース名 | 各テスト開始時 | 黄色でテストケース名を表示 |
| テスト結果 | 各テスト完了時 | 緑色で"Test Pass"または赤色で"Test Fail" |
| 最終集計 | 全テスト完了時 | 成功/失敗件数の合計（緑色または赤色） |
| CI grouping | CI環境時 | GitHub Actionsのgrouping構文（::group:: / ::endgroup::） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| CIジョブ結果 | 失敗時 | GitHub Actions通知（CI実行時） |

## 備考

- テストケースはtc*パターンのディレクトリとして管理される（例: tc_basic, tc_completionなど）
- DMDの場合はデバッグビルド、LDC2の場合はリリースビルドでserve-dをビルドする
- DCD依存テストでは `.needs_dcd` マーカーファイルの存在で判定する
- CI環境（CI環境変数設定時）ではGitHub Actionsのグルーピング構文を出力してログの可読性を向上させる
- テストケースの指定は引数で可能（例: `./runtests.sh tc_basic tc_completion`）
