# バッチ設計書 58-OutputTestErrorsForAzureDevops

## 概要

本ドキュメントは、XUnitテスト結果から失敗テストを抽出し、Azure DevOps向けエラーメッセージを出力するPowerShellスクリプト「OutputTestErrorsForAzureDevops.ps1」のバッチ設計書である。

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

本バッチは、ConvertWttLogToXUnit.ps1で生成されたXUnit形式のテスト結果XMLを解析し、失敗したテストをAzure DevOpsのログ出力コマンド形式（##vso[task.logissue]）でエラーメッセージとして出力する。これにより、GitHubのChecksページでAzure DevOps統合が失敗テスト情報を正しく表示できるようになる。

**業務上の目的・背景**：Azure DevOpsはPowerShellスクリプト内で実行されるテストの詳細なエラー情報を自動的に取得できない。Checksページでは"PowerShell exited with code '1'"のような汎用メッセージしか表示されず、どのテストが失敗したかわからない。本バッチは、"##vso[task.logissue type=error]"形式でエラーを出力することで、Azure DevOps統合が失敗テスト名を正しく認識・表示できるようにする。

**バッチの実行タイミング**：Helixテスト結果のXUnit変換後、CI/CDパイプライン内で自動実行される。

**主要な処理内容**：
1. XUnit形式のXMLファイルを読み込み
2. assemblies > assembly > collection > test の階層を走査
3. result="Fail"のテストを検出
4. Azure DevOpsのログ出力コマンド形式でエラーメッセージを出力

**前後の処理との関連**：ConvertWttLogToXUnit.ps1の出力が入力となる。本バッチの出力はAzure DevOpsのログ解析エンジンが処理する。

**影響範囲**：Azure DevOpsのChecksページ・テスト結果表示に影響する。

## バッチ種別

CI/CD連携（テスト結果レポート）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | CI/CDパイプライン実行時 |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| XUnitファイル | ConvertWttLogToXUnit.ps1で生成されたXUnit XMLファイルが存在すること |
| Azure DevOps環境 | Azure DevOpsパイプライン内で実行されること（##vso コマンドが解釈される環境） |

### 実行可否判定

XUnitOutputPathで指定されたファイルが存在する場合に実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| XUnitOutputPath | string | Yes | - | XUnit形式のテスト結果XMLファイルパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| XUnit XMLファイル | XML | ConvertWttLogToXUnit.ps1の出力テスト結果 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | Azure DevOpsのvsoコマンド形式のエラーメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準出力（Azure DevOpsログ） |
| 形式 | "##vso[task.logissue type=error]{テスト名} Failed" |

## 処理フロー

### 処理シーケンス

```
1. XUnitファイル読み込み
   └─ [xml](Get-Content) でXMLとして読み込み
2. アセンブリループ
   └─ assemblies > assembly を走査
3. コレクションループ
   └─ assembly > collection を走査
4. テストループ
   └─ collection > test を走査
5. 失敗テスト検出
   └─ result="Fail" のテストを検出
6. エラーメッセージ出力
   └─ ##vso[task.logissue type=error] 形式で出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[XUnit XMLファイル読み込み]
    B --> C[assembliesの各assemblyを走査]
    C --> D[各collectionを走査]
    D --> E[各testを走査]
    E --> F{result = Fail?}
    F -->|Yes| G["##vso[task.logissue type=error] 出力"]
    F -->|No| H[スキップ]
    G --> E
    H --> E
    E --> I[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | ファイル未存在 | XUnit XMLファイルが存在しない | ConvertWttLogToXUnit.ps1の実行を確認 |
| N/A | XML解析エラー | XUnit XMLの形式が不正 | 入力ファイルの形式を確認 |

### リトライ仕様

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

### 障害時対応

入力XUnitファイルの存在と形式を確認し、必要に応じてConvertWttLogToXUnit.ps1を再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（読み取り・出力のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百テストケース |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

読み取り・出力のみの処理であり、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | 失敗テスト検出時 | "##vso[task.logissue type=error]{テスト名} Failed" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 特になし | N/A | Azure DevOpsが##vsoコマンドを自動解釈 |

## 備考

- スクリプトの背景はコメントで詳細に説明されている（Azure DevOpsがPowerShellスクリプト内のテストエラーを認識できない問題の回避策）
- ##vso[task.logissue type=error] 形式はAzure DevOpsのドキュメントに基づく
- Write-Outputで出力しており、Azure DevOpsのログパイプラインで##vsoプレフィックスが解釈される
- 3重ネストのforeachでXML構造を走査するシンプルな実装
- XUnit XMLの構造は assemblies > assembly > collection > test の階層
