# バッチ設計書 12-RunRenderTests

## 概要

本ドキュメントは、Avaloniaフレームワークのレンダリング機能に対するテストを実行するNukeビルドターゲット「RunRenderTests」の設計仕様を記載したものです。

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

RunRenderTestsターゲットは、Avaloniaフレームワークのグラフィックレンダリング機能、特にSkiaベースのレンダリングエンジンの動作を検証するテストを実行するバッチ処理です。

**業務上の目的・背景**：Avaloniaはクロスプラットフォームの.NET UIフレームワークであり、SkiaSharpを使用したレンダリングが中核機能の一つです。UIコンポーネントの描画が正しく行われることは、ユーザー体験に直接影響するため、レンダリング品質の継続的な検証が不可欠です。本バッチは、描画結果のスナップショットテストやレンダリングロジックの単体テストを通じて、視覚的な回帰を早期に検出し、クロスプラットフォームでの一貫した描画品質を保証します。

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

**主要な処理内容**：
1. Avalonia.Skia.RenderTestsプロジェクトのテスト実行
2. 各ターゲットフレームワーク（net8.0, net10.0等）でのテスト実行
3. レンダリング結果の比較・検証
4. テスト結果のレポート出力（CI環境の場合）

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

**影響範囲**：テスト結果はArtifactsディレクトリ配下のtest-resultsフォルダに出力されます。レンダリングテストは画像比較を行う場合があり、参照画像との差分が検出された場合はテスト失敗となります。

## バッチ種別

テスト実行 / レンダリング品質検証

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Compileターゲット完了 | ソリューション全体のコンパイルが成功していること |
| .NET SDK | 対象の.NET SDKがインストールされていること |
| SkipTestsパラメータ | falseであること（デフォルト） |
| Skiaランタイム | SkiaSharpネイティブライブラリが利用可能であること |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Avalonia.Skia.RenderTests.csproj | C#プロジェクト | レンダリングテストプロジェクト |
| 参照画像ファイル | PNG等 | スナップショット比較用の参照画像 |
| ビルド済みアセンブリ | DLL | Compileターゲットで生成されたテストアセンブリ |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. 実行条件チェック
   └─ SkipTestsパラメータの確認
2. Compileターゲット依存関係の確認
   └─ ビルド完了の確認
3. Avalonia.Skia.RenderTestsプロジェクトの検索
   └─ GlobFilesでプロジェクトファイルを特定
4. ターゲットフレームワークの取得
   └─ csprojからTargetFrameworksを解析
5. 各ターゲットフレームワークでテスト実行
   └─ DotNetRunによるテスト実行
6. テスト結果の出力
   └─ 結果ファイルの生成（CI環境の場合）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{SkipTests?}
    B -->|Yes| Z[スキップ終了]
    B -->|No| C[Compile完了確認]
    C --> D[RenderTestsプロジェクト検索]
    D --> E[TargetFrameworks取得]
    E --> F{フレームワークループ}
    F --> G[DotNetRunでテスト実行]
    G --> H{次のフレームワーク?}
    H -->|Yes| F
    H -->|No| I{全テスト成功?}
    I -->|Yes| J[成功終了]
    I -->|No| K[失敗終了]
```

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

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| TestFailed | テスト失敗 | レンダリング結果が期待値と異なる | 参照画像の更新または描画コードの修正 |
| ProjectNotFound | プロジェクト未発見 | テストプロジェクトが存在しない | プロジェクトパスの確認 |
| SkiaLoadFailed | Skia読み込み失敗 | SkiaSharpネイティブライブラリが見つからない | ネイティブ依存関係の確認 |
| ImageComparisonFailed | 画像比較失敗 | スナップショット画像の差分検出 | 差分画像の確認と修正 |

### リトライ仕様

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

### 障害時対応

1. レンダリングテスト失敗の場合：差分画像を確認し、意図的な変更であれば参照画像を更新
2. Skiaロードエラーの場合：プラットフォーム固有のSkiaSharpネイティブパッケージを確認
3. 環境依存エラーの場合：CI環境と同等の環境でローカル再現を試みる

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百件のレンダリングテストケース |
| 目標処理時間 | CI環境で5分以内 |
| メモリ使用量上限 | 利用可能メモリに依存（画像処理のため多め） |

## 排他制御

- 同一マシン上での複数実行は推奨されない
- グラフィックリソースへのアクセスが必要
- CI環境では各ジョブが独立したワークスペースで実行

## ログ出力

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

## 監視・アラート

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

## 備考

- Skiaレンダリングテストは画像のピクセル比較を行う場合があり、環境依存の微細な差異に注意が必要
- Microsoft.Testing.Platform（MTP）を使用しているため、DotNetRunでテストを実行
- net4系フレームワークのテストはLinux/macOSではスキップされる可能性がある
