# バッチ設計書 10-unittest.yml

## 概要

本ドキュメントは、serve-dプロジェクトにおけるユニットテスト実行用GitHub Actionsワークフロー `.github/workflows/unittest.yml` のバッチ設計書である。

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

本バッチは、push（masterブランチ）およびプルリクエスト時にトリガーされるGitHub Actionsワークフローであり、各サブパッケージのユニットテスト、ミニマルサーバーのビルド・テスト、統合テストを包括的に実行する。

**業務上の目的・背景**：serve-dプロジェクトのコード品質を継続的に検証するためのCIワークフローである。masterブランチへのpushやプルリクエストの作成時に自動実行され、変更がプロジェクト全体の品質基準を満たしているかを確認する。dmd/ldcの2種類のコンパイラと3種類のOS（Linux、Windows、macOS）のマトリクスビルドにより、幅広い環境での動作を保証する。

**バッチの実行タイミング**：masterブランチへのpush時、およびプルリクエスト作成・更新時に自動トリガーされる。

**主要な処理内容**：
1. D言語コンパイラ（dmd-latest / ldc-latest）のインストール
2. workspace-dサブパッケージのテスト
3. protocolサブパッケージのシリアライゼーションテスト
4. dcdサブパッケージのDCD通信ライブラリテスト
5. lspサブパッケージのLSPテスト
6. serverbaseサブパッケージのテスト
7. null_serverのビルド確認
8. null_server_testの実行
9. メインパッケージのテスト
10. 統合テスト（runtests.sh）の実行

**前後の処理との関連**：統合テストステップでtest/runtests.sh（No.7）を呼び出す。テスト対象のサブパッケージはtest.bat（No.6）と一部重複するが、本ワークフローではより多くのサブパッケージ（workspace-d、protocol、dcd）が追加でテストされる。

**影響範囲**：テスト結果がGitHub ActionsのUI上に表示される。プルリクエストのステータスチェックとして機能し、マージ可否の判断材料となる。

## バッチ種別

CI/CDワークフロー

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | push/PRイベント発生時 |
| 実行時刻 | イベント発生時 |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | push（masterブランチ）/ pull_request |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHubリポジトリ | Pure-D/serve-dリポジトリにアクセス可能であること |
| GitHub Actionsランナー | ubuntu-22.04、windows-latest、macos-latestが利用可能であること |

### 実行可否判定

masterブランチへのpushまたはプルリクエストイベントにより自動的にトリガーされる。fail-fast: falseが設定されているため、1つのマトリクスジョブが失敗しても他のジョブは継続実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | Gitイベントから自動的に情報を取得 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| serve-dリポジトリ | Git | actions/checkout@v4でチェックアウト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHub Actions UI | テキスト | 各テストステップの成功/失敗結果 |
| PRステータスチェック | ステータス | マージ可否の判断に使用 |

### 出力ファイル仕様

ファイル出力はない。

## 処理フロー

### 処理シーケンス

```
1. マトリクス構成の決定
   └─ OS: ubuntu-22.04, windows-latest, macos-latest
   └─ DC: dmd-latest, ldc-latest
   └─ 除外: windows-latest + dmd-latest、macos-latest + dmd-latest
2. ソースコードのチェックアウト
   └─ actions/checkout@v4
3. D言語コンパイラのインストール
   └─ dlang-community/setup-dlang@v1（タイムアウト: 5分）
4. workspace-dテスト
   └─ dub test :workspace-d（タイムアウト: 30分）
5. protocolシリアライゼーションテスト
   └─ dub test :protocol（タイムアウト: 10分）
6. DCD通信ライブラリテスト
   └─ dub test :dcd（タイムアウト: 5分）
7. LSPテスト
   └─ dub test :lsp（タイムアウト: 10分）
8. serverbaseテスト
   └─ dub test :serverbase（タイムアウト: 10分）
9. ミニマルサーバーのビルド
   └─ dub build --root=null_server（タイムアウト: 10分）
10. ミニマルサーバーのテスト
    └─ dub run --root=null_server_test（タイムアウト: 10分）
11. メインパッケージのテスト
    └─ dub test（タイムアウト: 30分）
12. 統合テスト
    └─ ./runtests.sh（working-directory: ./test、タイムアウト: 30分）
```

### フローチャート

```mermaid
flowchart TD
    A[push master / PR イベント] --> B[マトリクス構成決定]
    B --> C[actions/checkout@v4]
    C --> D[D言語コンパイラインストール]
    D --> E[dub test :workspace-d]
    E --> F[dub test :protocol]
    F --> G[dub test :dcd]
    G --> H[dub test :lsp]
    H --> I[dub test :serverbase]
    I --> J[dub build --root=null_server]
    J --> K[dub run --root=null_server_test]
    K --> L[dub test]
    L --> M[./runtests.sh 統合テスト]
    M --> N[ワークフロー終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイラインストール失敗 | D言語コンパイラのインストールがタイムアウトした場合 | GitHub Actionsのランナー状態を確認する |
| - | テスト失敗 | いずれかのサブパッケージテストが失敗した場合 | テスト失敗の原因を調査し修正する |
| - | ビルドエラー | null_serverのビルドが失敗した場合 | コンパイルエラーを確認する |
| - | タイムアウト | いずれかのステップがタイムアウトした場合 | パフォーマンス問題を調査する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（GitHub Actionsのデフォルト動作に依存） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

fail-fast: falseにより、1つのジョブが失敗しても他のジョブは継続実行される。失敗したテストステップのログをGitHub Actions上で確認し、原因を調査する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | マトリクスの組み合わせ数（4ジョブ: ubuntu dmd、ubuntu ldc、windows ldc、macOS ldc） |
| 目標処理時間 | 各ステップにtimeout-minutesが設定されている（5分〜30分） |
| メモリ使用量上限 | GitHub Actionsランナーのデフォルトリソース |

## 排他制御

マトリクスの各ジョブは独立した仮想マシン上で並列実行されるため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ワークフローログ | 全ステップ | GitHub Actionsの標準ログ |
| テスト結果 | 各テスト実行時 | テスト成功/失敗の詳細 |
| ビルドログ | null_serverビルド時 | ビルド進捗・エラー情報 |
| 統合テスト結果 | runtests.sh実行時 | テストケース毎の成否と集計結果 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー結果 | 失敗時 | GitHub Actions通知 / PRステータスチェック |

## 備考

- マトリクスの除外設定により、WindowsとmacOSではdmd-latestが除外され、ldc-latestのみでテストされる（dmd-latestはubuntu-22.04のみ）
- 全テストステップにMACOSX_DEPLOYMENT_TARGET=10.12が設定されている（macOS以外の環境では影響なし）
- テスト対象サブパッケージ: workspace-d、protocol、dcd、lsp、serverbase、メイン
- null_serverはミニマルなLSPサーバー実装であり、ビルドとテストの両方を確認
- 統合テスト（runtests.sh）はtest/ディレクトリをworking-directoryとして実行される
- 各ステップに個別のtimeout-minutesが設定されており、ハングアップ時の対策が施されている
  - workspace-d: 30分、protocol: 10分、dcd: 5分、lsp: 10分、serverbase: 10分
  - null_server build: 10分、null_server test: 10分、dub test: 30分、統合テスト: 30分
