# バッチ設計書 2-minitest/main.hack

## 概要

本ドキュメントは、HackTestフレームワークを使用したテストランナーのエントリポイント `minitest/main.hack` の設計仕様を記載する。このプログラムはHackTestを継承したテストクラスを自動検出し、非同期でテストを実行する。

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

`minitest/main.hack` は、HSL（Hack Standard Library）プロジェクトのテストランナーとして機能するHackプログラムである。HHVMのFacts拡張を使用してHackTestを継承した全てのテストクラスを自動検出し、リフレクションを使用してテストメソッドを実行する。

**業務上の目的・背景**：HSLの単体テストを自動的に検出・実行するための軽量テストフレームワークを提供する。外部の重量級テストフレームワーク（PHPUnit等）に依存せず、HSL固有の要件（非同期テスト、DataProvider対応）を満たすシンプルなテストランナーを実現する。

**バッチの実行タイミング**：minitest.sh経由で実行される。開発者による手動実行（随時）、およびCI/CDパイプラインによる自動実行（push時、pull_request時、日次スケジュール）。

**主要な処理内容**：
1. 実行環境の検証（ext_facts有効性、HSL Systemlib無効、ネイティブオートローダー設定確認）
2. HH\Facts\subtypesを使用したHackTest継承クラスの自動検出
3. コマンドライン引数によるテストクラス/ファイルのフィルタリング
4. 各テストクラスのインスタンス化とrunAsync()メソッドによるテスト実行
5. テスト結果の標準出力への出力

**前後の処理との関連**：minitest.shからHHVM経由で呼び出される。テスト結果はCI/CDパイプラインで評価され、テスト失敗時はビルド失敗となる。

**影響範囲**：テスト実行結果は標準出力・標準エラー出力に出力される。テストコード内でファイルI/Oが行われる場合は、そのテスト固有の影響範囲が存在する。

## バッチ種別

テスト実行（テストランナー）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 / CI/CDパイプラインによる自動実行 |
| 実行時刻 | 随時（CI/CDでは15:42 UTC 日次スケジュール） |
| 実行曜日 | 全曜日（CI/CD日次スケジュール） |
| 実行日 | 毎日（CI/CD日次スケジュール） |
| トリガー | minitest.sh経由 / HHVM直接実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ext_facts拡張 | HH\Facts\enabled()がtrueを返すこと |
| HSL Systemlib無効 | hhvm.hsl_systemlib_enabledがfalseであること |
| ネイティブオートローダー | HH\Lib\Vec\map関数が存在すること |
| HackTestクラス | HH\__Private\MiniTest\HackTestクラスが存在すること |

### 実行可否判定

1. `HH\Facts\enabled()` がtrueであること（falseの場合、exit(1)）
2. `ini_get('hhvm.hsl_systemlib_enabled')` がfalseであること（trueの場合、exit(1)）
3. `HH\Lib\Vec\map` 関数が存在すること（存在しない場合、exit(1)）
4. `HackTest` クラスが存在すること（存在しない場合、exit(1)）
5. フィルタリング後のテストクラスが1つ以上存在すること（0の場合、exit(1)）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $argv[1..n] | コマンドライン引数 | No | なし | テストクラス名またはファイルパスの部分一致フィルタ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| HH\Facts\subtypes() | Facts API | HackTestを継承した全クラスの検出 |
| HH\Facts\type_to_path() | Facts API | クラス名からファイルパスへの変換 |
| リフレクションAPI | ReflectionClass | テストクラスのメタデータ取得 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト実行結果（テストクラス名、メソッド名、OK/SKIPPED表示） |
| 標準エラー出力 | テキスト | エラーメッセージ |
| 終了コード | 整数 | 0: 成功、1: 失敗 |

### 出力ファイル仕様

本バッチはファイル出力を行わない（標準出力・標準エラー出力のみ）。

## 処理フロー

### 処理シーケンス

```
1. 環境検証
   └─ ext_facts有効性、HSL Systemlib無効、オートローダー設定確認
2. テストクラス検出
   └─ HH\Facts\subtypes()でHackTest継承クラスを取得
3. フィルタリング（オプション）
   └─ コマンドライン引数でクラス名/ファイルパスによるフィルタリング
4. テストクラスループ
   ├─ インスタンス化可否チェック（abstract/constructorパラメータ）
   ├─ テストクラスインスタンス化
   └─ runAsync()によるテスト実行
5. 完了
   └─ 全テスト完了後、プロセス終了
```

### フローチャート

```mermaid
flowchart TD
    A[main開始] --> B{ext_facts有効?}
    B -->|No| C[stderr出力, exit 1]
    B -->|Yes| D{HSL Systemlib無効?}
    D -->|No| E[stderr出力, exit 1]
    D -->|Yes| F{オートローダー設定済み?}
    F -->|No| G[stderr出力, exit 1]
    F -->|Yes| H{HackTestクラス存在?}
    H -->|No| I[stderr出力, exit 1]
    H -->|Yes| J[HH\Facts\subtypesでテストクラス取得]
    J --> K{argv引数あり?}
    K -->|Yes| L[クラス名/ファイルパスでフィルタリング]
    K -->|No| M{テストクラスあり?}
    L --> M
    M -->|No| N[stderr出力, exit 1]
    M -->|Yes| O[テストクラスループ開始]
    O --> P{インスタンス化可能?}
    P -->|No| Q[次のクラスへ]
    P -->|Yes| R[インスタンス生成]
    R --> S[await runAsync]
    S --> T{次のクラスあり?}
    T -->|Yes| O
    T -->|No| U[main終了]
    Q --> T
```

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

N/A（データベース操作なし）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ext_facts無効 | HH\Facts\enabled()がfalse | HHVMの設定確認、Autoload.DB.Path設定 |
| 1 | HSL Systemlib有効 | hhvm.hsl_systemlib_enabled が有効 | -vEval.HSLSystemlibEnabled=false オプション指定 |
| 1 | オートローダー未設定 | Vec\map関数が見つからない | ネイティブオートローダーの設定確認 |
| 1 | HackTestクラスなし | HackTestクラスが見つからない | オートローダーの設定確認 |
| 1 | テストクラスなし | フィルタリング結果が空 | フィルタ条件の確認 |
| 1 | DataProvider不存在 | DataProviderメソッドが見つからない | DataProviderメソッド名の確認 |
| 1 | DataProvider非公開 | DataProviderが非publicまたは非static | メソッドをpublic staticに変更 |

### リトライ仕様

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

### 障害時対応

テスト失敗時は標準出力のテスト結果を確認し、失敗したテストメソッドを特定する。invariant_violation によるテスト失敗はスタックトレースが出力される。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テストクラス数に依存（数十〜数百クラス） |
| 目標処理時間 | CI/CD環境で数分以内 |
| メモリ使用量上限 | HHVMデフォルト設定に依存 |

## 排他制御

テスト実行自体には排他制御はない。テストコード内でファイルI/Oや共有リソースを使用する場合は、各テストの責任で排他制御を行う必要がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | テストクラス開始時 | "Starting {クラス名}..." |
| 進捗ログ（runAsync） | runAsync開始時 | "--- {クラス名}::runAsync()" |
| 進捗ログ（メソッド） | テストメソッド開始時 | "-----   {クラス名}::{メソッド名}()" |
| 進捗ログ（DataProvider） | DataProvider実行時 | "-----     Invoking DataProvider {クラス名}::{メソッド名}()" |
| 進捗ログ（データセット） | データセット実行時 | "-----     Invoking with data set {キー}..." |
| スキップログ | テストスキップ時 | "------- SKIPPED: {メッセージ}" |
| 終了ログ | テストクラス完了時 | "OK: {クラス名}" |
| 警告ログ | コンストラクタ問題 | "!!! class {クラス名} has constructor with required parameters" |
| エラーログ | エラー発生時 | 標準エラー出力にエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | GitHub Actions（CI/CD） |
| 処理時間 | CI/CDタイムアウト設定に依存 | GitHub Actions |

## 備考

- `<<__EntryPoint>>` アトリビュートを持つasync関数として実装
- HackTestクラスのrunAsync()メソッドは非同期実行に対応
- DataProviderアトリビュートによるパラメータ化テストに対応
- SkippedTestExceptionによるテストスキップ機能を提供
- テストメソッドは `test` プレフィックスを持つpublicメソッドとして検出される
- 抽象クラスや必須コンストラクタパラメータを持つクラスはスキップされる
