# バッチ設計書 25-TestDesignTimeProviderPackaging.cmd

## 概要

本ドキュメントは、F#コンパイラプロジェクトにおけるデザインタイムプロバイダーパッケージング機能のテストを実行するバッチスクリプト（TestDesignTimeProviderPackaging.cmd）の設計を記述するものです。

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

このバッチはIsFSharpDesignTimeProviderプロパティによるPackageFSharpDesignTimeToolsターゲットの条件付き包含機能をテストします。タイププロバイダーパッケージにtools/fsharp41フォルダが正しく含まれる/含まれないことを検証する5つのテストケースを実行します。

**業務上の目的・背景**：F#タイププロバイダーをNuGetパッケージとして配布する際、デザインタイムツール（IDE統合用）を適切にパッケージに含める必要があります。IsFSharpDesignTimeProviderプロパティがtrueの場合のみtools/fsharp41フォルダがパッケージに含まれ、通常のライブラリには含まれないことを保証します。また、NETSDK1085エラー（--no-buildシナリオ）やMSB3030エラー（バインディングリダイレクト）のリグレッションを防止します。

**バッチの実行タイミング**：CI/CDパイプラインのci_part3として、EndToEndBuildTests.cmdから呼び出されて実行されます。BasicProviderおよびComboProviderテストの後に実行されます。

**主要な処理内容**：
1. Test 1: PlainLib（通常ライブラリ）のパッケージにtools/fsharp41が含まれないことを確認
2. Test 2: Provider（IsFSharpDesignTimeProvider=true）のパッケージにtools/fsharp41が含まれることを確認
3. Test 3: Host（ProjectReference経由でProviderを参照）のパッケージングテスト
4. Test 4: --no-buildシナリオでNETSDK1085エラーが発生しないことを確認
5. Test 5: AutoGenerateBindingRedirects設定時にMSB3030エラーが発生しないことを確認

**前後の処理との関連**：EndToEndBuildTests.cmdから呼び出されます。ComboProviderテストの後に実行されます。各テストプロジェクト（PlainLib、Provider、Host、RedirectLib）が存在している必要があります。

**影響範囲**：artifactsディレクトリにテスト用NuGetパッケージとバイナリログ（.binlog）が生成されます。

## バッチ種別

テスト実行 / リグレッションテスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | CI/CD毎（プルリクエスト、mainブランチマージ時） |
| 実行時刻 | N/A（イベント駆動） |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | EndToEndBuildTests.cmdからの呼び出し / 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDKのインストール | dotnetコマンドが利用可能であること |
| Windows環境 | .cmdファイルのためWindows環境が必要 |
| PowerShellの利用可能 | nupkg検証にPowerShellを使用 |
| テストプロジェクトの存在 | PlainLib、Provider、Host、RedirectLibプロジェクトが存在すること |

### 実行可否判定

テストプロジェクトが存在しない場合、dotnet build/packでエラーとなります。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| -c | string | No | Debug | ビルド構成（Debug/Release） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| PlainLib/PlainLib.fsproj | MSBuild project | 通常ライブラリプロジェクト |
| Provider/Provider.fsproj | MSBuild project | IsFSharpDesignTimeProvider=trueのプロジェクト |
| Host/Host.fsproj | MSBuild project | Providerを参照するホストプロジェクト |
| RedirectLib/RedirectLib.fsproj | MSBuild project | AutoGenerateBindingRedirects設定のプロジェクト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/*.nupkg | NuGetパッケージ | 各プロジェクトのパッケージ |
| artifacts/*.binlog | バイナリログ | MSBuildのバイナリログ |
| 標準出力 | テキスト | テスト実行状況と結果 |
| 終了コード | 整数 | 0:成功、1:失敗 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | {ProjectName}.1.0.0.nupkg, {test}.binlog |
| 出力先 | tests/EndToEndBuildTests/DesignTimeProviderPackaging/artifacts |
| 文字コード | N/A（バイナリ） |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. 環境変数初期化
   └─ setlocal、スクリプトパス取得、configuration=Debug設定
2. 引数解析
   └─ -cオプションでconfigurationを上書き
3. artifactsディレクトリクリア
   └─ 既存のartifactsを削除し再作成
4. Test 1: PlainLib（通常ライブラリ）
   └─ 4.1. dotnet build PlainLib
   └─ 4.2. dotnet pack PlainLib --no-build
   └─ 4.3. PowerShellでtools/fsharp41が存在しないことを確認
5. Test 2: Provider（IsFSharpDesignTimeProvider=true）
   └─ 5.1. dotnet pack Provider（binlog出力）
   └─ 5.2. PowerShellでtools/fsharp41が存在することを確認
6. Test 3: Host（ProjectReference経由）
   └─ 6.1. dotnet pack Host（binlog出力）
   └─ 6.2. 実装制限の注記付きでパス
7. Test 4: --no-buildシナリオ
   └─ 7.1. dotnet build PlainLib
   └─ 7.2. dotnet pack PlainLib --no-build（binlog出力）
   └─ 7.3. NETSDK1085が発生しないことを確認
8. Test 5: バインディングリダイレクト
   └─ 8.1. dotnet pack RedirectLib（binlog出力）
   └─ 8.2. PowerShellでtools/fsharp41が存在しないことを確認
9. 成功終了
   └─ "All DesignTimeProviderPackaging tests PASSED"出力、exit /b 0
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[環境変数初期化]
    B --> C[artifactsクリア]
    C --> D[Test 1: PlainLib build & pack]
    D --> E{tools/fsharp41なし?}
    E -->|いいえ| F[Test 1 失敗]
    E -->|はい| G[Test 2: Provider pack]
    F --> Z[失敗終了]
    G --> H{tools/fsharp41あり?}
    H -->|いいえ| I[Test 2 失敗]
    H -->|はい| J[Test 3: Host pack]
    I --> Z
    J --> K[Test 4: PlainLib --no-build]
    K --> L{NETSDK1085なし?}
    L -->|いいえ| M[Test 4 失敗]
    L -->|はい| N[Test 5: RedirectLib pack]
    M --> Z
    N --> O{tools/fsharp41なし?}
    O -->|いいえ| P[Test 5 失敗]
    O -->|はい| Q[成功終了]
    P --> Z
    Q --> R[All tests PASSED出力・exit /b 0]
    Z --> S[tests FAILED出力・exit /b 1]
```

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

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

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

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | Test 1失敗 | PlainLibにtools/fsharp41が含まれる | PackageFSharpDesignTimeToolsターゲットを確認 |
| 1 | Test 2失敗 | Providerにtools/fsharp41が含まれない | IsFSharpDesignTimeProvider設定を確認 |
| 1 | Test 3失敗 | Hostのpack失敗 | binlogで詳細確認 |
| 1 | Test 4失敗 | NETSDK1085発生 | binlogで早期ターゲット実行を確認 |
| 1 | Test 5失敗 | MSB3030またはtools/fsharp41が含まれる | binlogでバインディングリダイレクト問題を確認 |

### リトライ仕様

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

### 障害時対応

1. 該当テストのbinlogファイルを確認
2. artifactsディレクトリを削除して再実行
3. nupkgファイルを手動で展開してコンテンツを確認
4. プロジェクトファイルのIsFSharpDesignTimeProvider設定を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（テスト実行のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 5テストケース |
| 目標処理時間 | 5-10分（環境依存） |
| メモリ使用量上限 | dotnetプロセス依存 |

## 排他制御

同時実行は推奨されません。artifactsディレクトリへの同時書き込みで競合が発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 各テスト実行前 | "=== Test N: {テスト名} ===" |
| 進捗ログ | 各コマンド実行前 | "[Test N] Command: {コマンドライン}" |
| 結果ログ | 各テスト完了時 | "[Test N] PASSED" または "[Test N] FAILED" |
| 終了ログ | バッチ終了時 | "All DesignTimeProviderPackaging tests PASSED/FAILED" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプライン |
| 実行時間 | 20分超過 | CI/CDパイプライン |

## 備考

- PowerShellでSystem.IO.Compression.ZipFileを使用してnupkgの内容を検証します
- Test 3はMSBuild評価フェーズの制限により、ProjectReference経由の参照チェックが正しく機能しない可能性があります
- 各テストのbinlogファイルは障害時のデバッグに有用です
- FSharpTestCompilerVersion=coreclrを使用してCoreCLRコンパイラでビルドします
