# バッチ設計書 18-テストスイート実行（uv_run_tests_a）

## 概要

本ドキュメントは、libuvプロジェクトの単体テストスイート実行バッチ「uv_run_tests_a」のバッチ設計書である。435以上のテストケースを含む包括的なテストスイートであり、CMakeビルド後にctestまたはuv_run_tests_aバイナリで一括実行する。

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

uv_run_tests_aは、libuvの全機能に対する単体テストを一括実行するテストバイナリである。テストケースは `test/test-list.h` で宣言・登録され、各テストは個別のCソースファイルとして実装されている。

**業務上の目的・背景**：libuvはクロスプラットフォーム非同期I/Oライブラリであり、TCP/UDP、ファイルシステム、プロセス管理、スレッド同期など多岐にわたるAPIを提供している。これらのAPIが各プラットフォーム（Linux、macOS、Windows、FreeBSD等）で正しく動作することを保証するため、包括的なテストスイートが不可欠である。テストは静的ライブラリ（uv_a）にリンクされたスタンドアロンバイナリとしてビルドされ、CI/CDパイプライン（CI-unix.yml: No.7、CI-win.yml: No.8）から自動実行される。

**バッチの実行タイミング**：CI/CDパイプラインでのプルリクエスト・プッシュ時の自動実行、および開発者によるローカルでの手動実行。

**主要な処理内容**：
1. CMakeによるテストバイナリのビルド（LIBUV_BUILD_TESTS=ON）
2. テストランナーの初期化（プラットフォーム固有のランナー設定）
3. test-list.hに登録された435以上のテストケースの逐次実行
4. 各テストの成功/失敗判定と結果集計
5. テスト結果のレポート出力

**前後の処理との関連**：CMakeLists.txt（No.4）でビルドターゲットが定義される。CI-unix.yml（No.7）やCI-win.yml（No.8）から呼び出される。sanitizer.yml（No.9）でのサニタイザーテストでも使用される。tsansupp.txt（No.20）がThreadSanitizer実行時の抑制設定として参照される。

**影響範囲**：テスト結果はCI/CDパイプラインのパス/フェイル判定に直接影響し、プルリクエストのマージ可否を決定する。

## バッチ種別

テスト実行（単体テストスイート）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | プルリクエスト/プッシュごと（CI）、随時（ローカル） |
| 実行時刻 | CI実行時またはローカル手動実行時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | CI/CDワークフロー実行 / 手動（ctest または ./uv_run_tests_a） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| CMakeビルド完了 | LIBUV_BUILD_TESTS=ONでCMakeビルドが成功していること |
| 静的ライブラリ | uv_a（libuv静的ライブラリ）がビルド済みであること |
| テストバイナリ | uv_run_tests_a実行ファイルがビルド済みであること |
| プラットフォームランナー | runner-unix.c（Unix）またはrunner-win.c（Windows）がリンクされていること |

### 実行可否判定

CMakeLists.txtの `LIBUV_BUILD_TESTS` オプションがONであり、かつ `LIBUV_BUILD_SHARED` が有効で、`CMAKE_SOURCE_DIR` がプロジェクトルートと一致する場合にテストバイナリがビルドされる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| テスト名 | string | No | 全テスト | 特定テストのみ実行する場合に指定（例: `./uv_run_tests_a tcp_ping_pong`） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| test/test-list.h | C言語ヘッダ | TEST_DECLARE/TEST_ENTRY マクロによるテスト一覧定義（435以上のテスト） |
| test/test-*.c | C言語ソース | 各テストケースの実装ファイル |
| test/runner.c | C言語ソース | テストランナーメインロジック |
| test/runner-unix.c | C言語ソース | Unix系プラットフォーム向けランナー |
| test/runner-win.c | C言語ソース | Windows向けランナー |
| test/run-tests.c | C言語ソース | テスト実行エントリポイント |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 各テストの実行結果（PASS/FAIL/SKIP） |
| 終了コード | 整数 | 0: 全テストPASS、非0: 失敗テストあり |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 直接のファイル出力なし（標準出力） |
| 出力先 | stdout / stderr |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. テストランナー初期化
   └─ プラットフォーム固有の初期化処理
2. テストリスト読み込み
   └─ test-list.hに定義されたTASK_LIST_STARTからTASK_LIST_ENDまでのテスト一覧
3. テスト実行ループ
   └─ 各テストケースを逐次実行
   └─ テストプロセスのフォーク/生成
   └─ タイムアウト監視
4. テスト結果判定
   └─ 各テストの終了コードによるPASS/FAIL判定
5. 結果集計と出力
   └─ 成功数/失敗数/スキップ数の集計
   └─ 最終結果の出力
```

### フローチャート

```mermaid
flowchart TD
    A[uv_run_tests_a実行] --> B[ランナー初期化]
    B --> C[テストリスト読み込み]
    C --> D{特定テスト指定?}
    D -->|Yes| E[指定テストのみ実行]
    D -->|No| F[全テスト実行ループ]
    E --> G[テスト結果判定]
    F --> H[各テストをフォーク/生成]
    H --> I[テスト実行]
    I --> J{タイムアウト?}
    J -->|Yes| K[FAIL: タイムアウト]
    J -->|No| L{終了コード = 0?}
    L -->|Yes| M[PASS]
    L -->|No| N[FAIL]
    K --> O[次のテストへ]
    M --> O
    N --> O
    O --> P{全テスト完了?}
    P -->|No| H
    P -->|Yes| G
    G --> Q[結果集計・出力]
    Q --> R{全テストPASS?}
    R -->|Yes| S[終了コード 0]
    R -->|No| T[終了コード 非0]
```

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | - | - | - |

### テーブル別操作詳細

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0終了コード | テスト失敗 | テストケースのアサーション失敗 | 失敗テストのログを確認し該当コードを修正 |
| SIGTERM | タイムアウト | テストが制限時間内に完了しない | テストのデッドロックや無限ループを調査 |
| SIGSEGV | セグメンテーション違反 | メモリアクセス違反 | ASANビルドで詳細を確認し修正 |
| SIGABRT | アボート | uv_assert等の内部アサーション失敗 | デバッグビルドで原因を特定 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（テストは決定的であるべきため） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

1. 特定テストの失敗：`./uv_run_tests_a テスト名` で個別テストを再実行し詳細を確認する
2. プラットフォーム固有の失敗：CI/CDの各プラットフォームマトリクスのログを比較する
3. サニタイザーで検出されたエラー：sanitizer.yml（No.9）のビルドで詳細情報を取得する
4. タイムアウト：デッドロック解析ツール（gdb、lldb）でスレッド状態を確認する

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 435以上のテストケース |
| 目標処理時間 | 数分〜十数分（プラットフォーム依存） |
| メモリ使用量上限 | テストケース依存（一般的には数百MB以内） |

## 排他制御

テストスイートは並列実行に対応していない。複数のuv_run_tests_aインスタンスの同時実行は、ポートの競合やファイルシステム操作の衝突を引き起こす可能性がある。一部のテストはヘルパープロセス（echo-server、blackhole-server等）を起動し、テスト完了後に終了させる。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | テスト実行開始時 | テストスイート開始メッセージ |
| 進捗ログ | 各テスト実行時 | テスト名、PASS/FAIL/SKIP |
| 終了ログ | テスト完了時 | 総テスト数、成功数、失敗数 |
| エラーログ | テスト失敗時 | 失敗テストの詳細情報、アサーション位置 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト失敗数 | 1件以上 | CI/CDステータスチェック |
| テスト実行時間 | プラットフォーム依存 | CI/CDワークフロータイムアウト |

## 備考

- テストケースは大きく以下のカテゴリに分類される：
  - ループ・タイマー（loop_alive, loop_close, loop_stop等）
  - 同期プリミティブ（barrier, condvar, semaphore, mutex等）
  - ネットワーク（tcp_ping_pong, udp_send_recv, dns等）
  - ファイルシステム（fs_open, fs_read, fs_stat等）
  - プロセス管理（spawn, process_title等）
  - パイプ・IPC（pipe_bind, ipc_send_recv等）
  - TTY（tty, tty_file等）
  - スレッド（thread_create, threadpool等）
  - シグナル（signal等）
  - プラットフォーム固有（Windows専用テストは`#ifdef _WIN32`で条件付き定義）
- テストバイナリは静的ライブラリ（uv_a）にリンクされるため、共有ライブラリのインストールは不要
- Windows環境では追加でws2_32（Winsock）ライブラリがリンクされる
- 一部のテストはプラットフォーム固有であり、`#ifdef` / `#ifndef` で条件付き定義されている
- ctestからの実行にも対応しており、`ctest --output-on-failure` で失敗テストの詳細ログを取得可能
