# バッチ設計書 13-RunToolsTests

## 概要

本ドキュメントは、Avaloniaフレームワークの開発ツール（ジェネレーターおよびデザイナーサポート）に対するテストを実行するNukeビルドターゲット「RunToolsTests」の設計仕様を記載したものです。

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

RunToolsTestsターゲットは、Avaloniaフレームワークに付属する開発者向けツール群の機能テストを実行するバッチ処理です。コード生成機能（Source Generators）とデザイナーサポート機能の品質を検証します。

**業務上の目的・背景**：Avaloniaの開発者体験を支える重要な機能として、XAMLからC#コードを自動生成するSource Generatorと、ビジュアルデザイナーとの連携機能があります。これらのツール群が正しく動作しないと、開発者の生産性低下やビルドエラーを引き起こす可能性があります。本バッチは、これらのツールが様々なユースケースで正しく動作することを検証し、開発者ツールの品質を担保します。

**バッチの実行タイミング**：CIパイプライン実行時（プルリクエスト、マスターブランチへのプッシュ時）、または開発者によるローカルビルド時に手動で実行されます。Compileターゲット完了後に自動的に実行されます。

**主要な処理内容**：
1. Avalonia.Generators.Testsプロジェクトのテスト実行（Source Generatorのテスト）
2. Avalonia.DesignerSupport.Testsプロジェクトのテスト実行（デザイナーサポートのテスト、Windows環境のみ）
3. 各ターゲットフレームワークでのテスト実行
4. テスト結果のレポート出力（CI環境の場合）

**前後の処理との関連**：Compileターゲットに依存しており、ソリューション全体のコンパイル完了後に実行されます。RunTestsターゲットの一部として統合テスト実行に含まれ、Package/CiAzure系ターゲットの前提条件となります。

**影響範囲**：テスト結果はArtifactsディレクトリ配下のtest-resultsフォルダに出力されます。デザイナーサポートテストはWindows環境でのみ実行されます。

## バッチ種別

テスト実行 / 開発ツール品質検証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CI/CDパイプライン実行時） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | Compileターゲット完了後 / 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Compileターゲット完了 | ソリューション全体のコンパイルが成功していること |
| .NET SDK | 対象の.NET SDKがインストールされていること |
| SkipTestsパラメータ | falseであること（デフォルト） |
| Windows環境（一部） | DesignerSupport.TestsはWindows環境でのみ実行 |

### 実行可否判定

- `Parameters.SkipTests`がfalseの場合のみ実行
- `--skip-tests`パラメータが指定された場合はスキップ
- OnlyWhenStatic条件により、テストスキップフラグがtrueの場合は実行されない
- DesignerSupport.Testsは`Parameters.IsRunningOnWindows`がtrueの場合のみ実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| configuration | string | No | Release | ビルド構成（Debug/Release） |
| skip-tests | bool | No | false | テストをスキップするかどうか |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Avalonia.Generators.Tests.csproj | C#プロジェクト | ジェネレーターテストプロジェクト |
| Avalonia.DesignerSupport.Tests.csproj | C#プロジェクト | デザイナーサポートテストプロジェクト |
| ビルド済みアセンブリ | DLL | Compileターゲットで生成されたテストアセンブリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/test-results/ | TRX | テスト結果ファイル（Azure Pipelines実行時） |
| コンソール出力 | テキスト | テスト実行結果のサマリー |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | {プロジェクト名}_{フレームワーク}.trx |
| 出力先 | artifacts/test-results/ |
| 文字コード | UTF-8 |
| 区切り文字 | N/A（XML形式） |

## 処理フロー

### 処理シーケンス

```
1. 実行条件チェック
   └─ SkipTestsパラメータの確認
2. Compileターゲット依存関係の確認
   └─ ビルド完了の確認
3. Avalonia.Generators.Testsの実行
   └─ 各ターゲットフレームワークでSource Generatorテスト実行
4. Windows環境チェック
   └─ IsRunningOnWindowsの確認
5. Avalonia.DesignerSupport.Testsの実行（Windows環境のみ）
   └─ デザイナーサポート機能のテスト実行
6. テスト結果の出力
   └─ 結果ファイルの生成（CI環境の場合）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{SkipTests?}
    B -->|Yes| Z[スキップ終了]
    B -->|No| C[Compile完了確認]
    C --> D[Generators.Tests実行]
    D --> E{Windows環境?}
    E -->|Yes| F[DesignerSupport.Tests実行]
    E -->|No| G{全テスト成功?}
    F --> G
    G -->|Yes| H[成功終了]
    G -->|No| I[失敗終了]
```

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

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

本バッチはデータベース操作を行いません。

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

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

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| TestFailed | テスト失敗 | ジェネレーターの出力が期待値と異なる | テストケースまたはジェネレーターの修正 |
| ProjectNotFound | プロジェクト未発見 | テストプロジェクトが存在しない | プロジェクトパスの確認 |
| GeneratorError | ジェネレーター実行エラー | Source Generatorが例外をスロー | ジェネレーターコードのデバッグ |
| DesignerConnectionFailed | デザイナー接続失敗 | デザイナープロセスとの通信エラー | 環境設定の確認 |

### リトライ仕様

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

### 障害時対応

1. ジェネレーターテスト失敗の場合：生成されたコードと期待値を比較し、差分を分析
2. デザイナーサポートテスト失敗の場合：Windows環境でのみ発生するため、該当環境でデバッグ
3. 環境依存エラーの場合：.NET SDKバージョンと依存パッケージを確認

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百件のテストケース |
| 目標処理時間 | CI環境で5分以内 |
| メモリ使用量上限 | 利用可能メモリに依存 |

## 排他制御

- 同一マシン上での複数実行は推奨されない
- ビルドディレクトリへの排他アクセスが必要
- CI環境では各ジョブが独立したワークスペースで実行

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 各テストプロジェクト実行開始時 | "Running tests from {projectName}" |
| 進捗ログ | 各フレームワーク実行時 | "Running for {projectName} ({tfm}) ..." |
| 終了ログ | テスト完了時 | テスト結果サマリー |
| エラーログ | テスト失敗時 | 失敗したテストケースの詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 15分 | Azure Pipelines通知 |
| テスト失敗件数 | 1件以上 | PRコメント/ビルド失敗通知 |

## 備考

- Avalonia.DesignerSupport.TestsはWindows環境でのみ実行される
- Source Generatorのテストは、コンパイル時コード生成の正確性を検証
- Microsoft.Testing.Platform（MTP）を使用しているため、DotNetRunでテストを実行
- デザイナーサポートテストはプレビュー機能のBunテストも含む場合がある（RunHtmlPreviewerTestsは別ターゲット）
