# バッチ設計書 59-Get-WttLog

## 概要

本ドキュメントは、WTTログDLLをビルド出力ディレクトリにコピーするPowerShellスクリプト「Get-WttLog.ps1」のバッチ設計書である。

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

本バッチは、MuxCustomBuildパッケージに含まれるwttlog.dllを検索し、指定されたビルド出力ディレクトリにコピーする。WTTログDLLはTAEFテスト実行時に必要なランタイムライブラリであり、本バッチによりテスト実行環境にDLLを配置する。

**業務上の目的・背景**：TAEFテスト実行にはwttlog.dllが必要であるが、このDLLはNuGetパッケージ（MuxCustomBuild）に含まれている。ビルド出力ディレクトリにテスト実行に必要なDLLを正しく配置するために本バッチが使用される。

**バッチの実行タイミング**：ビルド後、テスト実行前にCI/CDパイプライン内で実行される。

**主要な処理内容**：
1. packages配下のMuxCustomBuild*パッケージディレクトリを検索
2. パッケージ内のtools/{BuildPlatform}/wttlog.dllのパスを構築
3. bin/{RationalizedPlatform}/{Configuration}/にDLLをコピー

**前後の処理との関連**：NuGetパッケージの復元（ビルド時）が前提。コピーされたDLLはTAEFテスト実行時に参照される。

**影響範囲**：ビルド出力ディレクトリにwttlog.dllが配置される。テスト実行環境に影響する。

## バッチ種別

ファイルコピー（テスト環境準備）

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| MuxCustomBuildパッケージ | packages/MuxCustomBuild* ディレクトリが存在すること |
| ビルド出力 | bin/{RationalizedPlatform}/{Configuration}/ ディレクトリが存在すること |

### 実行可否判定

パラメータが正しく指定されていれば実行される。パッケージディレクトリが存在しない場合はエラーとなる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| BuildPlatform | string | Yes | - | ビルドプラットフォーム（例：x64, x86, ARM64） |
| RationalizedPlatform | string | Yes | - | 正規化されたプラットフォーム名（出力ディレクトリ用） |
| Configuration | string | Yes | - | ビルド構成（例：Debug, Release） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/MuxCustomBuild*/tools/{BuildPlatform}/wttlog.dll | DLL | WTTログランタイムライブラリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| bin/{RationalizedPlatform}/{Configuration}/wttlog.dll | DLL | コピーされたWTTログDLL |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | wttlog.dll |
| 出力先 | ./bin/{RationalizedPlatform}/{Configuration}/ |
| 形式 | Windows DLL |

## 処理フロー

### 処理シーケンス

```
1. MuxCustomBuildパッケージの検索
   └─ Get-Item でpackages/MuxCustomBuild*を検索
2. wttlog.dllパスの構築
   └─ パッケージディレクトリ/tools/{BuildPlatform}/wttlog.dll
3. 出力先パスの構築
   └─ bin/{RationalizedPlatform}/{Configuration}/
4. ファイルコピー
   └─ copy コマンドでDLLをコピー
5. 正常終了
   └─ Exit 0
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[MuxCustomBuildパッケージ検索]
    B --> C[wttlog.dllパス構築]
    C --> D[出力先パス構築]
    D --> E[wttlog.dllをコピー]
    E --> F[Exit 0]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | パッケージ未発見 | MuxCustomBuild*パッケージが存在しない | NuGetパッケージの復元を実行 |
| N/A | コピー失敗 | 出力先ディレクトリが存在しない、またはアクセス権限不足 | ビルドが正常完了したか確認 |

### リトライ仕様

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

### 障害時対応

NuGetパッケージの復元とビルドの正常完了を確認し、再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 単一ファイルコピー |
| コミットタイミング | copyコマンド完了時 |
| ロールバック条件 | なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ファイル |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行の制御は行っていない。ファイルコピーのみの処理であり、排他制御の必要性は低い。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 明示的なログ出力は行わない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 特になし | N/A | N/A |

## 備考

- 非常にシンプルなスクリプトで、単一のDLLファイルをコピーするのみ
- CmdLetBindingが定義されており、-Verbose等の共通パラメータに対応
- 明示的に Exit 0 で終了しており、コピーコマンドのエラーコードに関わらず正常終了する
- Get-Item の結果を配列の最初の要素（$i[0]）で参照しており、複数バージョンのパッケージが存在する場合は最初に見つかったものが使用される
- Join-Pathで安全にパスを結合している
