# バッチ設計書 34-install-cmake.sh

## 概要

本ドキュメントは、CMakeインストールバッチ `install-cmake.sh` の設計仕様を記載したものです。このバッチは、ネイティブビルドに必要なCMakeツールをダウンロードしてインストールします。

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

このバッチは、指定されたバージョンのCMakeをリモートサーバーからダウンロードし、ローカル環境にインストールして、シムスクリプトを生成します。

**業務上の目的・背景**：.NETランタイムやネイティブコンポーネントのビルドには、CMakeが必要です。CI/CD環境では一貫したバージョンのCMakeを使用することが重要であり、本バッチはArcadeビルドシステムの一部として、指定されたバージョンのCMakeを自動的にダウンロード・インストールします。これにより、ビルド環境の再現性と一貫性を確保できます。

**バッチの実行タイミング**：ネイティブビルドの初期化フェーズで、init-tools-native.shから呼び出されます。

**主要な処理内容**：
1. コマンドライン引数の解析（baseuri、installpath、version等）
2. クリーンモードの場合：既存インストールとテンポラリファイルの削除
3. インストールモードの場合：
   - 既存インストールの確認（強制フラグがない場合はスキップ）
   - CMakeアーカイブのダウンロード
   - アーカイブの展開
   - シムスクリプトの生成

**前後の処理との関連**：common-library.shの関数を使用します。インストール後はシムスクリプト経由でcmakeが呼び出し可能になります。

**影響範囲**：指定されたインストールディレクトリにCMakeがインストールされ、シムスクリプトが生成されます。

## バッチ種別

ツールインストール / セットアップ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルド初期化時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | init-tools-native.sh / 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| common-library.sh | 同一ディレクトリにcommon-library.shが存在すること |
| curl または wget | ファイルダウンロード用のツールが利用可能であること |
| tar | アーカイブ展開用のtarコマンドが利用可能であること |
| ネットワーク接続 | ダウンロード元サーバーへのアクセスが可能であること |

### 実行可否判定

- --cleanオプション指定時：クリーンアップモードで実行
- --forceオプションなし且つ既にインストール済み：スキップ
- それ以外：インストール実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --baseuri | string | No | - | ダウンロード元のベースURL/ディレクトリ |
| --installpath | string | No | - | インストール先のベースディレクトリ |
| --version | string | No | - | CMakeのバージョン |
| --clean | flag | No | false | クリーンアップモード |
| --force | flag | No | false | 強制インストール |
| --downloadretries | number | No | 5 | ダウンロードリトライ回数 |
| --retrywaittimeseconds | number | No | 30 | リトライ間隔（秒） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| リモートサーバー | tar.gz | CMakeのアーカイブファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| インストールディレクトリ | ディレクトリ | CMakeバイナリとライブラリ |
| シムスクリプト | .sh | cmake.sh（cmakeへのラッパー） |
| 終了コード | 数値 | 0: 成功、1: 失敗 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| インストールパス | $install_path/cmake/$version/ |
| シムファイル | $install_path/cmake.sh |

## 処理フロー

### 処理シーケンス

```
1. 引数解析
   └─ --baseuri、--installpath、--version等の解析

2. パス設定
   ├─ tool_os: GetCurrentOSで取得
   ├─ tool_install_directory: $install_path/cmake/$version
   ├─ tool_file_path: $tool_install_directory/cmake-$version-$os-$arch/bin/cmake
   ├─ shim_path: $install_path/cmake.sh
   └─ uri: $base_uri/$os/cmake/cmake-$version-$os-$arch.tar.gz

3. クリーンモード（--clean指定時）
   ├─ tool_install_directoryの削除
   ├─ shim_pathの削除
   └─ テンポラリファイルの削除

4. インストール確認
   └─ 既存インストールあり且つ--forceなし → スキップ

5. ダウンロード＆展開
   ├─ DownloadAndExtract関数でアーカイブ取得・展開
   └─ 失敗時はエラー終了

6. シム生成
   └─ NewScriptShim関数でcmake.shを生成
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[引数解析]
    B --> C[パス設定]
    C --> D{--clean?}
    D -->|Yes| E[クリーンアップ処理]
    E --> F[exit 0]
    D -->|No| G{既存インストールあり?}
    G -->|Yes| H{--force?}
    H -->|No| I[スキップメッセージ]
    I --> J[exit 0]
    H -->|Yes| K[ダウンロード＆展開]
    G -->|No| K
    K --> L{成功?}
    L -->|No| M[エラー出力]
    M --> N[exit 1]
    L -->|Yes| O[シム生成]
    O --> P{成功?}
    P -->|No| Q[エラー出力]
    Q --> R[exit 1]
    P -->|Yes| S[exit 0]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ダウンロード失敗 | ネットワークエラーまたはURLが無効 | ネットワーク接続を確認し再実行 |
| 1 | 展開失敗 | アーカイブが破損またはディスク容量不足 | ディスク容量を確認し再実行 |
| 1 | シム生成失敗 | ツールファイルが存在しないまたは権限エラー | インストール結果を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 5回（デフォルト） |
| リトライ間隔 | 30秒（デフォルト） |
| リトライ対象エラー | ダウンロード失敗 |

### 障害時対応

1. ネットワーク接続を確認
2. --cleanオプションで既存インストールを削除
3. --forceオプションを付けて再実行
4. 手動でCMakeをダウンロードしてインストールパスに配置

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回 |
| 目標処理時間 | 5分以内（ネットワーク速度に依存） |
| メモリ使用量上限 | tar展開に必要な量 |

## 排他制御

同一インストールパスへの同時実行は避けてください。ファイルシステムレベルのロックは実装されていません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | クリーンアップ時 | "Cleaning $tool_install_directory" |
| 情報ログ | スキップ時 | "$tool_name ($version) already exists, skipping install" |
| 情報ログ | ダウンロード時 | "downloading to: $temp_tool_path" |
| エラーログ | 失敗時 | Write-PipelineTelemetryError経由で出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 1 | Azure DevOpsパイプライン |
| 処理時間 | 10分超過 | 手動確認 |

## 備考

- 本バッチはArcadeビルドシステムの一部です
- x86_64アーキテクチャ用のCMakeのみがダウンロードされます
- シムスクリプトは実際のcmakeバイナリへのラッパーとして機能します
- NETCOREENG_INSTALL_DIRECTORY環境変数でデフォルトインストール先を変更可能
