# バッチ設計書 14-RunLeakTests

## 概要

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

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

RunLeakTestsターゲットは、Avaloniaフレームワークにおけるメモリリークを検出・検証するための専用テストを実行するバッチ処理です。Windows環境でのみ実行され、オブジェクトの適切な解放やガベージコレクションの動作を確認します。

**業務上の目的・背景**：UIフレームワークでは、コントロールやウィンドウのライフサイクル管理が複雑になりやすく、メモリリークが発生しやすい傾向があります。特にイベントハンドラの登録解除漏れ、循環参照、アンマネージドリソースの解放漏れなどが問題となります。本バッチは、こうしたメモリリークを自動的に検出し、長時間稼働するアプリケーションでも安定して動作することを保証します。

**バッチの実行タイミング**：CIパイプライン実行時（プルリクエスト、マスターブランチへのプッシュ時）のうち、Windows環境でのみ実行されます。Compileターゲット完了後に自動的に実行されます。

**主要な処理内容**：
1. Avalonia.LeakTestsプロジェクトのテスト実行
2. オブジェクト参照の追跡・検証
3. GC強制実行後の残存オブジェクト検出
4. テスト結果のレポート出力（CI環境の場合）

**前後の処理との関連**：Compileターゲットに依存しており、ソリューション全体のコンパイル完了後に実行されます。RunTestsターゲットの一部として統合テスト実行に含まれます。Windows環境でのみ実行されるため、LinuxやmacOSのCIジョブでは実行されません。

**影響範囲**：テスト結果はArtifactsディレクトリ配下のtest-resultsフォルダに出力されます。メモリリーク検出時はテスト失敗となり、ビルド全体が失敗します。

## バッチ種別

テスト実行 / メモリ品質検証

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Avalonia.LeakTests.csproj | C#プロジェクト | メモリリークテストプロジェクト |
| ビルド済みアセンブリ | DLL | Compileターゲットで生成されたテストアセンブリ |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

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

### フローチャート

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

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

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| MemoryLeakDetected | メモリリーク検出 | GC後もオブジェクトが残存 | 該当コードのリソース管理を修正 |
| TestFailed | テスト失敗 | アサーションエラー | テストケースまたは対象コードの修正 |
| ProjectNotFound | プロジェクト未発見 | テストプロジェクトが存在しない | プロジェクトパスの確認 |
| OutOfMemory | メモリ不足 | テスト実行中にメモリ枯渇 | テスト環境のメモリ増設 |

### リトライ仕様

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

### 障害時対応

1. メモリリーク検出の場合：WeakReferenceやファイナライザーの実装を確認し、リソース解放ロジックを修正
2. OutOfMemoryの場合：テスト対象のメモリ使用量を分析し、最適化を検討
3. 環境依存エラーの場合：Windows固有の問題として、該当環境でデバッグ

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百件のリークテストケース |
| 目標処理時間 | CI環境で10分以内 |
| メモリ使用量上限 | テスト対象に依存（監視対象として重要） |

## 排他制御

- 同一マシン上での複数実行は推奨されない
- メモリ状態の測定のため、他のプロセスの影響を受ける可能性がある
- CI環境では各ジョブが独立したワークスペースで実行

## ログ出力

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

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 20分 | Azure Pipelines通知 |
| テスト失敗件数 | 1件以上 | PRコメント/ビルド失敗通知 |
| メモリ使用量 | 異常増加時 | テスト内で検出 |

## 備考

- メモリリークテストはWindows環境でのみ実行される（Linux/macOSでは実行されない）
- テストではWeakReferenceを使用してオブジェクトの生存状態を追跡することが多い
- GC.Collect()を強制的に実行し、オブジェクトが適切に解放されることを確認
- Microsoft.Testing.Platform（MTP）を使用しているため、DotNetRunでテストを実行
- 非同期処理やイベントハンドラに関連するリークの検出が主な目的
