# バッチ設計書 37-common-library.sh

## 概要

本ドキュメントは、共通ライブラリ関数バッチ `common-library.sh` の設計仕様を記載したものです。このバッチは、ネイティブビルドツールのインストールや管理に使用する共通シェル関数を提供します。

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

このバッチは、他のネイティブビルドスクリプトから読み込まれ、ファイルダウンロード、アーカイブ展開、シムスクリプト生成などの共通機能を提供する関数ライブラリです。

**業務上の目的・背景**：Arcadeビルドシステムでは、CMakeなどのネイティブツールを自動的にダウンロード・インストールする必要があります。本ライブラリは、ダウンロード処理（リトライ機能付き）、tarアーカイブの展開、ツールへのシムスクリプト生成など、複数のスクリプトで共通して必要となる機能を一元化しています。これにより、コードの重複を避け、保守性を向上させています。

**バッチの実行タイミング**：他のスクリプト（install-cmake.sh、install-cmake-test.sh等）からsourceコマンドで読み込まれます。直接実行するものではありません。

**主要な処理内容（提供する関数）**：
1. GetNativeInstallDirectory: ネイティブツールのインストールディレクトリを取得
2. GetTempDirectory: テンポラリディレクトリのパスを取得
3. ExpandZip: tar.gzアーカイブを展開
4. GetCurrentOS: 現在のOSを取得（Linux/MacOS）
5. GetFile: URLまたはファイルパスからファイルを取得
6. GetTempPathFileName: テンポラリファイルパスを生成
7. DownloadAndExtract: ダウンロードと展開を一括実行
8. NewScriptShim: ツールへのシムスクリプトを生成

**前後の処理との関連**：install-cmake.sh、install-cmake-test.shなどから読み込まれ、それらのスクリプトの基盤となる機能を提供します。

**影響範囲**：読み込むスクリプトに関数を提供。直接的なシステム影響はありません。

## バッチ種別

共通ライブラリ / 関数定義

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（sourceコマンドで読込時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | sourceコマンド |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Bash | Bashシェルが利用可能であること |
| curl または wget | ファイルダウンロード用（GetFile関数） |
| tar | アーカイブ展開用（ExpandZip関数） |

### 実行可否判定

sourceコマンドで読み込まれることを想定。直接実行は想定していません。

## 入力仕様

### 入力パラメータ

各関数の入力パラメータは以下の通りです。

| 関数名 | パラメータ | 説明 |
|-------|----------|------|
| ExpandZip | zip_path, output_directory, force | アーカイブパス、出力先、強制フラグ |
| GetFile | uri, path, force, download_retries, retry_wait_time_seconds | URI、保存先、強制フラグ、リトライ設定 |
| GetTempPathFileName | path | ファイルパス |
| DownloadAndExtract | uri, installDir, force, download_retries, retry_wait_time_seconds | URI、インストール先、リトライ設定 |
| NewScriptShim | shimpath, tool_file_path, force | シムパス、ツールパス、強制フラグ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| NETCOREENG_INSTALL_DIRECTORY | 環境変数 | カスタムインストールディレクトリ（オプション） |

## 出力仕様

### 出力データ

| 関数名 | 出力 | 説明 |
|-------|------|------|
| GetNativeInstallDirectory | 標準出力 | インストールディレクトリパス |
| GetTempDirectory | 標準出力 | テンポラリディレクトリパス |
| GetCurrentOS | 標準出力 | "Linux" または "MacOS" |
| GetTempPathFileName | 標準出力 | テンポラリファイルパス |
| ExpandZip | ファイルシステム | 展開されたファイル群 |
| GetFile | ファイルシステム | ダウンロードされたファイル |
| DownloadAndExtract | ファイルシステム | ダウンロード・展開されたファイル群 |
| NewScriptShim | ファイルシステム | シムスクリプト |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| デフォルトインストールパス | $HOME/.netcoreeng/native/ |
| テンポラリディレクトリ | $HOME/.netcoreeng/native/temp/ |

## 処理フロー

### 関数別処理シーケンス

#### GetNativeInstallDirectory
```
1. NETCOREENG_INSTALL_DIRECTORY環境変数をチェック
   ├─ 設定あり: その値を返す
   └─ 設定なし: $HOME/.netcoreeng/native/を返す
```

#### GetFile
```
1. ファイル存在チェック
   ├─ 存在且つforceなし: スキップ
   └─ 存在且つforceあり: 削除

2. URI判定
   ├─ ファイルパスの場合: コピー
   └─ URLの場合: ダウンロード

3. ダウンロード（URL時）
   ├─ curlがある場合: curl使用
   └─ curlがない場合: wget使用
```

#### ExpandZip
```
1. 出力ディレクトリ確認
   ├─ 存在且つforceなし: スキップ
   └─ 存在且つforceあり: 削除

2. ディレクトリ作成
   └─ mkdir -p

3. アーカイブ展開
   └─ tar -xf
```

#### NewScriptShim
```
1. 既存シム確認
   ├─ 存在且つforceなし: エラー
   └─ 存在且つforceあり: 削除

2. ツールファイル確認
   ├─ 存在しない: 小文字パスで再試行
   └─ それでも存在しない: エラー

3. シムスクリプト生成
   └─ #!/usr/bin/env bash + ツール呼び出し

4. 実行権限付与
   └─ chmod +x
```

### フローチャート

```mermaid
flowchart TD
    subgraph GetFile
        A1[開始] --> B1{ファイル存在?}
        B1 -->|Yes| C1{force?}
        C1 -->|No| D1[スキップ]
        C1 -->|Yes| E1[削除]
        B1 -->|No| F1{URIはファイル?}
        E1 --> F1
        F1 -->|Yes| G1[コピー]
        F1 -->|No| H1{curl存在?}
        H1 -->|Yes| I1[curlでダウンロード]
        H1 -->|No| J1[wgetでダウンロード]
    end

    subgraph NewScriptShim
        A2[開始] --> B2{シム存在?}
        B2 -->|Yes| C2{force?}
        C2 -->|No| D2[エラー]
        C2 -->|Yes| E2[削除]
        B2 -->|No| F2{ツール存在?}
        E2 --> F2
        F2 -->|No| G2[小文字で再試行]
        G2 --> H2{存在?}
        H2 -->|No| I2[エラー]
        F2 -->|Yes| J2[シム生成]
        H2 -->|Yes| J2
        J2 --> K2[chmod +x]
    end
```

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

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

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

## エラー処理

### エラーケース一覧

| 関数 | エラーコード | エラー種別 | 発生条件 | 対処方法 |
|-----|------------|----------|---------|---------|
| ExpandZip | 1 | 削除失敗 | 既存ディレクトリの削除に失敗 | 権限を確認 |
| ExpandZip | 1 | 展開失敗 | tarコマンドが失敗 | アーカイブの整合性を確認 |
| GetFile | 非0 | ダウンロード失敗 | ネットワークエラー | 接続を確認し再試行 |
| DownloadAndExtract | 1 | ダウンロード失敗 | GetFileが失敗 | URLを確認 |
| DownloadAndExtract | 1 | 展開失敗 | ExpandZipが失敗 | ディスク容量を確認 |
| NewScriptShim | 1 | 既存シム | forceなしで既存シムあり | forceオプション使用 |
| NewScriptShim | 1 | ツール未存在 | 指定パスにツールがない | インストールを確認 |

### リトライ仕様

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

### 障害時対応

エラー発生時は、Write-PipelineTelemetryError関数でAzure DevOpsパイプラインにエラー通知されます。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 各関数は複数回呼び出し可能 |
| 目標処理時間 | ダウンロードサイズとネットワーク速度に依存 |
| メモリ使用量上限 | tar展開に必要な量 |

## 排他制御

なし。同時実行時のファイルロックは実装されていません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | ExpandZip実行時 | "Extracting $zip_path to $output_directory" |
| 情報ログ | 既存ディレクトリスキップ時 | "Directory '$output_directory' already exists, skipping extract" |
| 情報ログ | GetFile実行時 | "Downloading $uri" または "File '$path' already exists. Skipping download" |
| 情報ログ | NewScriptShim実行時 | "Generating '$shimpath' shim" |
| 情報ログ | シム生成完了時 | "Finished generating shim '$shimpath'" |
| エラーログ | 各種失敗時 | Write-PipelineTelemetryError経由で出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 関数の戻り値 | 非0 | 呼び出し元スクリプト |

## 備考

- 本スクリプトは関数ライブラリであり、直接実行するものではありません
- curlが利用可能な場合はcurlを優先使用、なければwgetを使用
- シムスクリプトは引数を全てツールに転送する形式
- 大文字/小文字のパス違いを吸収する機能あり（NewScriptShim）
- Write-PipelineTelemetryErrorはAzure DevOpsパイプライン用のエラー出力関数（pipeline-logging-functions.shで定義）
