# バッチ設計書 26-TestDesignTimeProviderPackaging.sh

## 概要

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

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

このバッチはIsFSharpDesignTimeProviderプロパティによるPackageFSharpDesignTimeToolsターゲットの条件付き包含機能をLinux/macOS環境でテストします。Windows版（.cmd）と同等の5つのテストケースを実行し、クロスプラットフォームでの動作を保証します。

**業務上の目的・背景**：F#タイププロバイダーのNuGetパッケージング機能はクロスプラットフォームで一貫して動作する必要があります。Linux/macOS環境でもIsFSharpDesignTimeProviderプロパティによるtools/fsharp41フォルダの条件付き包含が正しく機能することを検証します。また、NETSDK1085エラーやMSB3030エラーのリグレッションをクロスプラットフォームで防止します。

**バッチの実行タイミング**：Linux/macOSでのCI/CDパイプライン、または開発者のローカル環境でのテスト時に実行されます。EndToEndBuildTests.cmdに相当するLinux/macOS版の統合スクリプトから呼び出される可能性があります。

**主要な処理内容**：
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エラーが発生しないことを確認

**前後の処理との関連**：Windows版のTestDesignTimeProviderPackaging.cmdと同等の機能を提供します。各テストプロジェクト（PlainLib、Provider、Host、RedirectLib）が存在している必要があります。

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

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDKのインストール | dotnetコマンドが利用可能であること |
| Linux/macOS環境 | Bashが利用可能なUnix系環境 |
| unzipコマンドの利用可能 | nupkg検証にunzipを使用 |
| テストプロジェクトの存在 | PlainLib、Provider、Host、RedirectLibプロジェクトが存在すること |

### 実行可否判定

set -eにより、いずれかのコマンドが失敗した時点で即座に終了します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| -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:成功、非0:失敗 |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. エラー時即座終了設定
   └─ set -e
2. 環境変数初期化
   └─ SCRIPT_DIR取得、configuration=Debug設定
3. 引数解析
   └─ -cオプションでconfigurationを上書き
4. 作業ディレクトリ移動・artifactsクリア
   └─ cd $SCRIPT_DIR、rm -rf artifacts、mkdir -p artifacts
5. Test 1: PlainLib（通常ライブラリ）
   └─ 5.1. dotnet pack PlainLib（binlog出力）
   └─ 5.2. unzipでtools/fsharp41が存在しないことを確認
6. Test 2: Provider（IsFSharpDesignTimeProvider=true）
   └─ 6.1. dotnet pack Provider（binlog出力）
   └─ 6.2. unzipでtools/fsharp41が存在することを確認
7. Test 3: Host（ProjectReference経由）
   └─ 7.1. dotnet pack Host（binlog出力）
   └─ 7.2. 実装制限の注記付きでパス
8. Test 4: --no-buildシナリオ
   └─ 8.1. dotnet build PlainLib
   └─ 8.2. dotnet pack PlainLib --no-build（binlog出力）
   └─ 8.3. NETSDK1085が発生しないことを確認
9. Test 5: バインディングリダイレクト
   └─ 9.1. dotnet pack RedirectLib（binlog出力）
   └─ 9.2. unzipでtools/fsharp41が存在しないことを確認
10. 成功終了
    └─ "All DesignTimeProviderPackaging tests PASSED"出力、exit 0
```

### フローチャート

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

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 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" |

## 監視・アラート

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

## 備考

- Windows版（.cmd）と同等の機能をLinux/macOS向けに提供します
- unzipコマンドでnupkgの内容を検証します（Windows版のPowerShell相当）
- set -eにより、いずれかのコマンドが失敗した時点でスクリプト全体が終了します
- Test 3はMSBuild評価フェーズの制限により、ProjectReference経由の参照チェックが正しく機能しない可能性があります
- FSharpTestCompilerVersion=coreclrを使用してCoreCLRコンパイラでビルドします
