# バッチ設計書 10-eng/test-determinism.cmd

## 概要

本ドキュメントは、F#コンパイラプロジェクトのWindows環境向け決定論的ビルドテストスクリプト「eng/test-determinism.cmd」の設計仕様を記載する。

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

eng/test-determinism.cmdは、F#コンパイラの決定論的ビルド（deterministic build）を検証するためのWindows向けテストスクリプトである。PowerShellスクリプト（eng/test-determinism.ps1）をラップし、同じソースコードから複数回ビルドを行い、生成されるバイナリが完全に同一であることを確認する。

**業務上の目的・背景**：決定論的ビルドは、同じソースコードからは常に同一のバイナリが生成されることを保証する重要な品質特性である。これにより、ビルドの再現性が確保され、セキュリティ監査、バイナリの検証、ビルドキャッシュの有効活用が可能になる。F#コンパイラはこの特性をサポートしており、本テストはその正確性を継続的に検証する。タイムスタンプ、ファイルパス、ランダム要素などがバイナリに影響しないことを確認する。

**バッチの実行タイミング**：CIパイプラインの一部として定期的に実行される。また、コンパイラの出力に影響を与える可能性のある変更（コード生成、メタデータ処理など）がある場合に手動で実行される。

**主要な処理内容**：
1. PowerShellの実行ポリシーをRemoteSignedに設定する
2. eng/test-determinism.ps1スクリプトを呼び出す
3. ブートストラップコンパイラを構築する
4. 初回ビルドを実行し、バイナリのハッシュを記録する
5. 同じソースから再度ビルドを実行する
6. 2回目のビルドのバイナリハッシュを比較する
7. ハッシュが一致しない場合はエラーを報告する

**前後の処理との関連**：このバッチは独立したテストとして実行される。事前にソースコードのチェックアウトが必要。テスト失敗時は決定論性に影響を与える変更の調査が必要。

**影響範囲**：artifacts配下にビルド成果物が生成される。テスト用に複数回のビルドが行われるため、通常のビルドより時間がかかる。

## バッチ種別

テスト処理（決定論的ビルド検証）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時/CI |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動/CI |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| PowerShell | PowerShellが利用可能であること |
| Visual Studio | MSBuildに必要 |

### 実行可否判定

特別な実行可否判定ロジックはない。前提条件が満たされていれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| %* | string | No | - | test-determinism.ps1に渡される追加のコマンドライン引数 |
| -configuration | string | No | Debug | ビルド構成（Debug/Release） |
| -msbuildEngine | string | No | vs | MSBuildエンジン（dotnet/vs） |
| -altRootDrive | string | No | q: | パスマップ検証用の代替ドライブ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード | .fs/.fsproj | プロジェクトディレクトリ内のF#ソースファイル |
| ソリューションファイル | .sln | Microsoft.FSharp.Compiler.sln |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/bin | DLL/EXE | コンパイル済みバイナリ（複数回生成） |
| artifacts/log | .binlog | バイナリログファイル |
| artifacts/log/DeterminismFailures | ZIP | 失敗時の差分情報 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | determinism.zip（失敗時） |
| 出力先 | artifacts/log |
| 文字コード | バイナリ |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. コマンドライン引数の受け取り
   └─ %*で渡されたすべての引数を取得
2. PowerShellの起動
   └─ ExecutionPolicy RemoteSigned、NoProfileオプションで実行
3. test-determinism.ps1の呼び出し
4. ブートストラップコンパイラの構築
   └─ Make-BootstrapBuildの呼び出し
5. 初回ビルド（Initial）の実行
   └─ Microsoft.FSharp.Compiler.slnをビルド
6. バイナリハッシュの記録
   └─ DLL、EXE、PDBのMD5ハッシュを記録
7. 2回目ビルド（Test1）の実行
   └─ 同じソースから再度ビルド
8. ハッシュの比較
   └─ 初回と2回目のハッシュを比較
9. 結果の判定
   └─ 不一致がある場合は失敗情報をZIPに保存
```

### フローチャート

```mermaid
flowchart TD
    A[test-determinism.cmd開始] --> B[PowerShell起動]
    B --> C[test-determinism.ps1呼び出し]
    C --> D[ブートストラップビルド]
    D --> E[初回ビルド実行]
    E --> F[バイナリハッシュ記録]
    F --> G[2回目ビルド実行]
    G --> H[ハッシュ比較]
    H --> I{全ハッシュ一致?}
    I -->|Yes| J[正常終了]
    I -->|No| K[失敗情報保存]
    K --> L[エラー終了]
```

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

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

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

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

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 決定論性失敗 | バイナリハッシュが不一致 | determinism.zipを確認し原因を調査 |
| 1 | ビルドエラー | コンパイルエラー発生時 | エラーメッセージを確認しソースコードを修正 |
| 1 | 環境エラー | .NET SDK未インストール時 | 適切なSDKをインストール |

### リトライ仕様

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

### 障害時対応

1. determinism.zipファイルを確認する
2. 左右の差分バイナリを比較ツールで確認する
3. .keyファイルがある場合はデバッグ情報を確認する
4. コンパイラチームに分析を依頼する

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 2回のフルビルド |
| 目標処理時間 | 環境依存（通常30-90分） |
| メモリ使用量上限 | 環境依存 |

## 排他制御

同一ディレクトリでの同時実行は推奨されない。テスト中はartifactsディレクトリが複数回クリーンアップされる。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | テスト開始時 | 構成情報 |
| 進捗ログ | 各ビルド中 | ビルドフェーズ、ファイルハッシュ |
| 終了ログ | テスト終了時 | 成功/失敗ステータス、検証したバイナリ数 |
| エラーログ | 失敗時 | 不一致のバイナリ名、ハッシュ値 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 環境依存 | CIシステム |
| テスト失敗 | 即時 | コンパイラチーム |

## 備考

- このスクリプトは決定論的ビルドの検証専用
- FSharp.Core.dll、FSharp.Compiler.Service.dllなどの主要バイナリを検証
- 40個以上のバイナリが検証対象
- 失敗時はdeterminism.zipがartifacts/logに生成される
- パスマップ実装の検証も行われる（altRootDriveオプション使用時）
- Deterministic=true、DebugDeterminism=trueでビルドが実行される
