# バッチ設計書 20-init-tools-native.cmd

## 概要

本ドキュメントは、ネイティブツール初期化スクリプト（eng/common/init-tools-native.cmd）の設計仕様を記述したものである。

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

init-tools-native.cmdは、Windows環境でネイティブビルドツール（CMake、Ninja等）を初期化・インストールするためのバッチファイルである。このスクリプトはinit-tools-native.ps1 PowerShellスクリプトを呼び出し、global.jsonで定義されたネイティブツールをダウンロード・配置する。

**業務上の目的・背景**：.NETプロジェクトの一部（特にランタイムやネイティブコンポーネント）は、C/C++コードをビルドする必要がある。これらのビルドにはCMake、Ninja、その他のネイティブツールが必要となる。init-tools-native.cmdは、これらのツールをglobal.jsonの定義に基づいて自動的にインストールし、ビルド環境を準備する。

**バッチの実行タイミング**：ビルドスクリプト（build.cmd、build.ps1）から自動呼び出し。-restoreオプション指定時にInitializeNativeTools関数から呼び出される。手動実行も可能。

**主要な処理内容**：
1. PowerShellの起動（ExecutionPolicy ByPass、NoProfile、NoLogo）
2. init-tools-native.ps1スクリプトの呼び出し
3. global.jsonの"native-tools"セクションの解析
4. 各ネイティブツールのダウンロードとインストール
5. ツールをPATHに追加

**前後の処理との関連**：restore処理の一部として実行される。インストールされたネイティブツールは後続のネイティブコンポーネントビルドで使用される。

**影響範囲**：%USERPROFILE%/.netcoreeng/native/（デフォルト）または指定されたインストールディレクトリにツールがインストールされる。環境変数PATHが更新される。

## バッチ種別

ツール / ネイティブビルド環境構築

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 / restore時 |
| 実行時刻 | 指定なし |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 / ビルドスクリプト |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Windows OS | Windows環境 |
| PowerShell | PowerShell 5.1以上 |
| ネットワーク接続 | ツールダウンロードに必要 |
| global.json | native-toolsセクションが定義されていること |

### 実行可否判定

- global.jsonにnative-toolsセクションが存在しない場合は何もせずに終了
- CI環境（Azure Pipelines）では-PathPromotionオプションにより既存ツールを使用

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| -BaseUri | string | No | Azure Blob Storage URL | ツールダウンロード元 |
| -InstallDirectory | string | No | %USERPROFILE%/.netcoreeng/native | インストール先 |
| -Clean | switch | No | false | クリーンアップのみ実行 |
| -Force | switch | No | false | 強制再インストール |
| -DownloadRetries | int | No | 5 | ダウンロードリトライ回数 |
| -RetryWaitTimeInSeconds | int | No | 30 | リトライ待機時間 |
| -GlobalJsonFile | string | No | global.json | 設定ファイルパス |
| -PathPromotion | switch | No | false | 既存ツールをPATHに追加 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| global.json | JSON | native-toolsセクション |
| コマンドライン引数 | パラメータ | オプション設定 |

### global.json native-toolsセクション例

```json
{
  "native-tools": {
    "cmake": "3.21.0",
    "ninja": "1.10.2"
  }
}
```

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| %USERPROFILE%/.netcoreeng/native/bin/ | ディレクトリ | ツール実行ファイル |
| 環境変数PATH | 文字列 | ツールパスの追加 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | cmake.exe、ninja.exe等 |
| 出力先 | インストールディレクトリ/bin/ |
| 文字コード | バイナリ |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. バッチファイル起動
   └─ @echo off
2. PowerShell起動
   ├─ NoProfile
   ├─ NoLogo
   └─ ExecutionPolicy ByPass
3. init-tools-native.ps1実行
   ├─ global.json読み込み
   ├─ native-toolsセクション解析
   └─ 各ツールについて：
       ├─ install-tool.ps1呼び出し
       ├─ ツールダウンロード
       └─ 展開・配置
4. PATH設定
   └─ ##vso[task.prependpath]でパス追加（CI時）
5. 終了コード返却
   └─ exit /b %ErrorLevel%
```

### フローチャート

```mermaid
flowchart TD
    A[init-tools-native.cmd開始] --> B[PowerShell起動]
    B --> C[init-tools-native.ps1実行]
    C --> D[global.json読み込み]
    D --> E{native-tools存在?}
    E -->|No| F[正常終了]
    E -->|Yes| G{PathPromotion?}
    G -->|Yes| H{arcade-tools存在?}
    H -->|Yes| I[既存ツールをPATH追加]
    H -->|No| J[警告出力]
    G -->|No| K[各ツールをループ処理]
    K --> L[install-tool.ps1呼び出し]
    L --> M{インストール成功?}
    M -->|Yes| N[次のツール]
    M -->|No| O{中止設定?}
    O -->|Yes| P[エラー終了]
    O -->|No| Q[警告出力]
    N --> R{全ツール完了?}
    Q --> N
    R -->|Yes| S[bin/をPATH追加]
    R -->|No| K
    S --> F
    I --> F
    J --> F
    P --> Z[終了]
    F --> Z
```

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ツールインストール失敗 | ダウンロードエラー | ネットワーク確認、リトライ |
| 1 | global.json読み込み失敗 | ファイル不存在 | global.json確認 |
| 1 | PATH追加失敗 | bin/ディレクトリ不存在 | インストール確認 |

### リトライ仕様

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

### 障害時対応

1. ネットワーク接続を確認
2. -Forceオプションで再インストール
3. -Cleanでクリーンアップしてから再実行
4. 手動でツールをダウンロード・配置

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数ツール |
| 目標処理時間 | ネットワーク速度依存（1-5分） |
| メモリ使用量上限 | 指定なし |

## 排他制御

同一ディレクトリへの同時インストールは推奨されない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 処理開始時 | Processing global.json |
| 進捗ログ | ツールインストール時 | Installing ToolName version |
| 終了ログ | 処理完了時 | Native tools are available from |
| エラーログ | エラー発生時 | 詳細エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 10分 | CI/CDパイプライン |
| エラー件数 | 1件 | 開発者 |

## 備考

- Azure DevOps環境では##vso[task.prependpath]によるPATH追加が行われる
- CI環境でarcade-toolsディレクトリが存在する場合、既存ツールを使用（PathPromotion）
- DoNotAbortNativeToolsInstallationOnFailure変数で失敗時の動作を制御可能
- CommonLibrary.psm1モジュールの関数を使用してインストール処理を実行
- install-tool.ps1がツールごとのインストール処理を担当
