# バッチ設計書 4-restore.sh

## 概要

本ドキュメントは、F#コンパイラプロジェクトのLinux/macOS環境向け依存関係リストアスクリプト「restore.sh」の設計仕様を記載する。

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

restore.shは、F#コンパイラプロジェクトの依存関係（NuGetパッケージ等）を復元するためのLinux/macOS向けエントリーポイントスクリプトである。シンボリックリンクを正しく解決した上で、eng/build.shを--restoreオプションのみで呼び出すことで、ビルドを行わずに依存関係の復元のみを実行する。

**業務上の目的・背景**：F#コンパイラはクロスプラットフォーム対応のプロジェクトであり、Linux/macOS環境でも開発・ビルドが可能である必要がある。本スクリプトは、Windows環境のRestore.cmdに対応するUnix系プラットフォーム向けのエントリーポイントを提供する。CI/CD環境でのキャッシュ準備、コンテナベースのビルド環境での依存関係準備など、様々なシナリオで使用される。

**バッチの実行タイミング**：開発環境のセットアップ時、依存関係の更新後、ビルドエラーのトラブルシューティング時に随時実行される。Docker環境でのビルドイメージ準備や、CI/CDパイプラインでのキャッシュ活用シナリオで頻繁に使用される。

**主要な処理内容**：
1. BASH_SOURCEからスクリプトパスを取得する
2. シンボリックリンクを解決し、実際のスクリプト位置を特定する
3. スクリプトルートディレクトリを特定する
4. eng/build.shを--restoreオプションのみで呼び出す

**前後の処理との関連**：このバッチはビルドの前処理として使用される。リストア完了後、build.shでビルドを実行できる。CI環境では、リストアとビルドを分離することでキャッシュを効率的に活用できる。

**影響範囲**：NuGetパッケージキャッシュが更新される。obj/project.assets.jsonファイルが生成または更新される。

## バッチ種別

リストア処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| Bash | Bashシェルが利用可能であること |
| 実行権限 | スクリプトに実行権限があること（chmod +x） |
| ネットワーク | NuGetフィードへのアクセスが可能であること |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $@ | string | No | - | eng/build.shに渡される追加のコマンドライン引数 |
| --configuration | string | No | Debug | ビルド構成（Debug/Release） |
| --verbosity | string | No | minimal | MSBuildの詳細度（q/m/n/d/diag） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| プロジェクトファイル | .fsproj/.csproj | パッケージ参照を含むプロジェクトファイル |
| NuGet.config | XML | NuGetフィード設定 |
| Directory.Packages.props | XML | 中央パッケージ管理設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| obj/project.assets.json | JSON | 復元されたパッケージのアセット情報 |
| NuGetキャッシュ | .nupkg | ダウンロードされたパッケージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | project.assets.json |
| 出力先 | 各プロジェクトのobjフォルダ |
| 文字コード | UTF-8 |
| 区切り文字 | N/A（JSON形式） |

## 処理フロー

### 処理シーケンス

```
1. BASH_SOURCEからスクリプトパスを取得
   └─ 現在のスクリプトファイルのパスを特定
2. シンボリックリンクの解決
   └─ -hオプションでシンボリックリンクかどうか判定
   └─ readlinkコマンドで実際のパスを取得
3. スクリプトルートディレクトリの特定
   └─ cd -P と dirname で絶対パスを取得
4. eng/build.shの呼び出し
   └─ --restore オプションと追加引数を渡す
```

### フローチャート

```mermaid
flowchart TD
    A[restore.sh開始] --> B[BASH_SOURCE取得]
    B --> C{シンボリックリンク?}
    C -->|Yes| D[readlinkで解決]
    D --> C
    C -->|No| E[scriptrootを特定]
    E --> F[eng/build.sh呼び出し]
    F --> G[NuGetパッケージ復元]
    G --> H{復元成功?}
    H -->|Yes| I[正常終了]
    H -->|No| J[エラー終了]
```

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

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

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

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

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ネットワークエラー | NuGetフィードに接続できない | ネットワーク接続を確認 |
| 1 | パッケージ不在 | 指定バージョンのパッケージが存在しない | パッケージバージョンを確認 |
| 1 | 認証エラー | プライベートフィードへの認証失敗 | 認証情報を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、原因を特定する
2. ネットワーク接続を確認する
3. NuGet.configのフィード設定を確認する
4. 必要に応じてNuGetキャッシュをクリアして再実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のリストアセッション |
| 目標処理時間 | 環境依存（通常1-5分） |
| メモリ使用量上限 | 環境依存 |

## 排他制御

同一ディレクトリでの同時実行は推奨されない。パッケージロックファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | リストア開始時 | プロジェクト情報 |
| 進捗ログ | リストア中 | パッケージダウンロード状況 |
| 終了ログ | リストア終了時 | 成功/失敗ステータス |
| エラーログ | エラー発生時 | エラーコード、エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | N/A（ローカル実行） | N/A |
| エラー件数 | N/A | N/A |

## 備考

- このスクリプトはプロジェクトルートから実行することを想定している
- Windows環境では代わりにRestore.cmdを使用する
- シンボリックリンクを通じて呼び出された場合も正しく動作する
- 追加オプションについてはeng/build.shの--helpを参照
