# バッチ設計書 8-runut.cmd

## 概要

本ドキュメントは、コンソール関連の全ユニットテスト DLL を TAEF で一括実行するスクリプト `runut.cmd` のバッチ設計書である。

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

runut.cmd は、OpenConsole プロジェクトのユニットテストを TAEF（Test Authoring and Execution Framework）を使用して一括実行するバッチスクリプトである。コンソールホスト、テキストバッファ、ターミナルコア、インタラクティビティ、パーサー、アダプター、型定義、TIL、ターミナルアプリ、コントロール、SettingsModel の各コンポーネントのテスト DLL を対象とする。

**業務上の目的・背景**：OpenConsole プロジェクトの品質を確保するため、各コンポーネントのユニットテストを一括して実行できる手段を提供する。開発者がコード変更後にリグレッションがないことを素早く確認するために使用される。テストの構成は tests.xml と同期させる必要がある。

**バッチの実行タイミング**：コード変更後のリグレッションテスト、プルリクエスト前の検証、ビルド後の動作確認時に手動で実行する。

**主要な処理内容**：
1. TestHostApp のパス解決（Win32/x86 の場合のパス差異に対応）
2. TAEF（TE.exe）による複数テスト DLL の一括実行（第1グループ：11個の DLL）
3. 第1グループの終了コードを保存
4. SettingsModel テストの個別実行（専用の TE.exe を使用）
5. 全体の終了コードを返却（第1グループまたは第2グループのいずれかがエラーの場合にエラーを返す）

**前後の処理との関連**：razzle.cmd で設定された TAEF、OPENCON、PLATFORM、_LAST_BUILD_CONF 環境変数を前提とする。事前にビルド（bcz.cmd 等）が完了し、テスト DLL が生成されている必要がある。

**影響範囲**：テスト実行のみであり、ソースコードやビルド成果物への変更は発生しない。テスト結果は標準出力に表示される。

## バッチ種別

テスト実行

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| razzle.cmd 実行済み | TAEF、OPENCON、PLATFORM、_LAST_BUILD_CONF 環境変数が設定されていること |
| ビルド完了 | テスト対象の DLL がビルド出力ディレクトリに生成されていること |
| TAEF インストール済み | TE.exe（TAEF テストランナー）が利用可能であること |

### 実行可否判定

テスト DLL が存在しない場合は TAEF がエラーを報告する。明示的な事前チェックは行わない。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| %* | 可変引数 | No | - | TAEF（TE.exe）に転送される追加オプション |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Conhost.Unit.Tests.dll | テスト DLL | コンソールホストのユニットテスト |
| TextBuffer.Unit.Tests.dll | テスト DLL | テキストバッファのユニットテスト |
| Terminal.Core.Unit.Tests.dll | テスト DLL | ターミナルコアのユニットテスト |
| Conhost.Interactivity.Win32.Unit.Tests.dll | テスト DLL | Win32 インタラクティビティのユニットテスト |
| ConParser.Unit.Tests.dll | テスト DLL | コンソールパーサーのユニットテスト |
| ConAdapter.Unit.Tests.dll | テスト DLL | コンソールアダプターのユニットテスト |
| Types.Unit.Tests.dll | テスト DLL | 型定義のユニットテスト |
| til.unit.tests.dll | テスト DLL | TIL（Terminal Infrastructure Library）のユニットテスト |
| Terminal.App.Unit.Tests.dll | テスト DLL | ターミナルアプリのユニットテスト |
| Control.Unit.Tests.dll | テスト DLL | コントロールのユニットテスト |
| TerminalApp.LocalTests.dll | テスト DLL | ターミナルアプリのローカルテスト |
| SettingsModel.Unit.Tests.dll | テスト DLL | 設定モデルのユニットテスト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | TAEF テスト結果 |
| 終了コード | 整数 | 0: 全テスト成功、非0: テスト失敗あり |

### 出力ファイル仕様

ファイル出力はない（TAEF のオプションにより WTT ログ等が出力される場合あり）。

## 処理フロー

### 処理シーケンス

```
1. TestHostApp パスの解決
   └─ Win32/x86 の場合: %OPENCON%\bin\%_LAST_BUILD_CONF%\TestHostApp
   └─ その他の場合: %OPENCON%\bin\%PLATFORM%\%_LAST_BUILD_CONF%\TestHostApp
2. 第1グループのテスト実行（TAEF）
   └─ %TAEF% で 11 個のテスト DLL を一括実行
   └─ 追加引数 %* も TAEF に転送
3. 第1グループの終了コード保存
   └─ _EarlyTestFail に ERRORLEVEL を保存
4. SettingsModel テストの個別実行
   └─ UnitTests_SettingsModel ディレクトリの専用 te.exe で実行
5. 終了コードの判定
   └─ _EarlyTestFail が非0の場合はその値を返却
   └─ それ以外は SettingsModel テストの ERRORLEVEL を返却
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{PLATFORM が Win32?}
    B -->|はい| C[TestHostApp パスを PLATFORM なしで設定]
    B -->|いいえ| D[TestHostApp パスを PLATFORM ありで設定]
    C --> E[TAEF で第1グループ 11 DLL 実行]
    D --> E
    E --> F[_EarlyTestFail に終了コード保存]
    F --> G[SettingsModel テスト実行（専用 te.exe）]
    G --> H{_EarlyTestFail が非0?}
    H -->|はい| I[_EarlyTestFail を終了コードとして返却]
    H -->|いいえ| J[SettingsModel テストの終了コードを返却]
    I --> K[バッチ終了]
    J --> K
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | テスト失敗 | いずれかのテストケースが失敗した場合 | テスト結果を確認し、失敗テストに対応するコードを修正 |
| 非0 | DLL 未検出 | テスト DLL がビルド出力に存在しない場合 | ビルドを実行してテスト DLL を生成 |

### リトライ仕様

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

### 障害時対応

テスト失敗時は TAEF の出力から失敗したテストケースを特定し、該当コードを修正する。DLL 未検出の場合はビルドを実行してから再テストする。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 12 テスト DLL の全テストケース |
| 目標処理時間 | 数分〜数十分（テスト数に依存） |
| メモリ使用量上限 | TAEF に依存 |

## 排他制御

テスト実行中はシステムリソースを使用するため、同時に複数のテストセッションを実行すると競合する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| テスト結果 | テスト実行中・完了時 | TAEF によるテスト結果（Pass/Fail/Skip） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

- コメントに "Keep this file in sync with tests.xml" とあり、テスト構成を tests.xml と同期させる必要がある。
- TerminalApp.LocalTests.dll は TestHostApp（cppwinrt プロジェクト）のパスから実行される。Win32/x86 プラットフォームの場合、パスに PLATFORM が含まれない特殊なディレクトリ構造となっている。
- SettingsModel テストは専用の TE.exe（UnitTests_SettingsModel ディレクトリ内）を使用して実行される。これは他のテスト DLL とは異なるテストランナー設定が必要なためと推測される。
- 終了コードの判定ロジック: 第1グループが失敗した場合はその終了コードが優先的に返却され、第1グループが成功した場合のみ SettingsModel テストの終了コードが返却される。
