# バッチ設計書 3-ci/funs.sh

## 概要

本ドキュメントは、CI/CDパイプラインで使用されるユーティリティ関数集 `ci/funs.sh` の設計仕様を定義するものである。

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

このバッチは、Nimプロジェクトのビルド、テスト、CI/CD処理で共通的に使用されるユーティリティ関数を提供するシェルスクリプトライブラリである。`build_all.sh`、Azure Pipelines、GitHub Actionsなど、様々なビルドスクリプトやCIパイプラインから読み込まれて使用される。

**業務上の目的・背景**：CI/CDパイプラインおよびビルドスクリプトにおいて、同じ処理を複数箇所で重複して実装することを避けるため、共通処理をユーティリティ関数として集約することが目的である。これにより、メンテナンス性の向上、バグの局所化、一貫性のある処理の実現が可能となる。また、ローカル開発環境とCI環境で同じ関数を使用することで、環境差異による問題を減少させる。

**バッチの実行タイミング**：このスクリプト自体は直接実行されるものではなく、他のシェルスクリプトから `. ci/funs.sh` または `source ci/funs.sh` で読み込まれる。読み込み元のスクリプトが実行される際に、定義された関数が利用可能となる。

**主要な処理内容**：
1. `echo_run` - コマンド実行前にコマンドをログ出力するラッパー関数
2. `nimGetLastCommit` - 最新の非マージコミットメッセージを取得
3. `nimIsCiSkip` - コミットメッセージに `[skip ci]` が含まれるか判定
4. `nimInternalInstallDepsWindows` - Windows環境でのMinGW/DLL依存関係インストール
5. `nimInternalBuildKochAndRunCI` - kochビルドとCI実行
6. `nimDefineVars` - csources関連の変数定義を読み込み
7. `nimCiSystemInfo` - システム情報をログ出力
8. `nimCsourcesHash` - csourcesのハッシュ値を取得
9. `nimBuildCsourcesIfNeeded` - 必要に応じてcsourcesからNimをビルド

**前後の処理との関連**：このスクリプトは `config/build_config.txt` の設定を読み込む。`build_all.sh`、`azure-pipelines.yml`、`.github/workflows/*.yml` など多くのビルドスクリプトやCIワークフローがこの関数群に依存している。

**影響範囲**：このスクリプトの変更は、全てのビルドプロセスとCIパイプラインに影響を与える可能性がある。関数の変更は慎重に行う必要がある。

## バッチ種別

ユーティリティ関数ライブラリ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（他スクリプトから読み込み時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 他スクリプトからの読み込み |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| OS | UNIX/Linux/macOS（POSIXシェル環境） |
| シェル | bash互換シェル |
| Git | `nimGetLastCommit`、`nimBuildCsourcesIfNeeded` で使用 |
| Cコンパイラ | `nimCiSystemInfo` で表示、`nimBuildCsourcesIfNeeded` で使用 |
| curl/7z | `nimInternalInstallDepsWindows` で使用（Windows CI環境のみ） |

### 実行可否判定

- このスクリプトはライブラリとして読み込まれるため、直接の実行可否判定は行わない
- 各関数は呼び出し時に必要な条件を内部で判定

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| NIMCORES | 環境変数 | No | 自動検出 | 並列ビルドに使用するCPUコア数 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/build_config.txt | テキスト | csourcesのバージョン情報（ハッシュ、ブランチ、URL、ディレクトリ） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| bin/nim | 実行可能ファイル | nimBuildCsourcesIfNeededで生成されるNimコンパイラ |
| bin/nim_csources_{hash} | 実行可能ファイル | キャッシュされたブートストラップNimコンパイラ |
| 標準出力 | テキスト | ログ出力、システム情報 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nim, nim_csources_{hash} |
| 出力先 | bin/ |
| 文字コード | N/A（バイナリファイル） |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス（主要関数）

```
【nimBuildCsourcesIfNeeded】
1. nimDefineVars呼び出し
   └─ config/build_config.txt から変数を読み込み
2. キャッシュ確認
   └─ bin/nim_csources_{hash} の存在確認
3. キャッシュなしの場合
   └─ csourcesディレクトリ確認 → なければgit clone → makeでビルド
4. キャッシュ復元
   └─ bin/nim にコピー

【nimInternalBuildKochAndRunCI】
1. kochのビルド
   └─ nim c koch
2. CI実行
   └─ ./koch runCI
3. 失敗時の結果出力
   └─ nim r tools/ci_testresults.nim
```

### フローチャート

```mermaid
flowchart TD
    subgraph nimBuildCsourcesIfNeeded
        A[開始] --> B[nimDefineVars]
        B --> C{キャッシュ存在?}
        C -->|あり| D[キャッシュから復元]
        C -->|なし| E{csourcesディレクトリ存在?}
        E -->|なし| F[git clone]
        E -->|あり| G[makeでビルド]
        F --> H[git checkout]
        H --> G
        G --> I[キャッシュ保存]
        I --> D
        D --> J[bin/nimにコピー]
        J --> K[バージョン表示]
        K --> L[終了]
    end
```

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

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

該当なし（このバッチはデータベースを使用しない）

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | git clone失敗 | ネットワークエラー、認証エラー | インターネット接続を確認 |
| 1 | makeビルド失敗 | Cコンパイラエラー | Cコンパイラのインストールを確認 |
| 1 | koch runCI失敗 | テスト失敗、ビルドエラー | ci_testresults.nimの出力を確認 |
| 1 | curl失敗 | ネットワークエラー（Windows依存関係インストール時） | インターネット接続を確認 |

### リトライ仕様

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

### 障害時対応

1. `nimInternalBuildKochAndRunCI` 失敗時は `tools/ci_testresults.nim` の出力を確認
2. `nimBuildCsourcesIfNeeded` 失敗時は csourcesディレクトリを削除して再実行
3. Windows依存関係インストール失敗時は手動でMinGW/DLLをインストール

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベース不使用） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | N/A |
| 目標処理時間 | csourcesビルド：約30秒（16コア環境） |
| メモリ使用量上限 | 約2GB（コンパイル時） |

## 排他制御

- `nimBuildCsourcesIfNeeded` はサブシェル内で実行され、呼び出し元の変数を汚染しない
- ファイルシステムレベルでの排他制御は実装されていない
- 同時実行時の競合は考慮されていない

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| コマンドログ | 各コマンド実行前 | echo_run関数によりコマンドを表示 |
| システム情報 | nimCiSystemInfo呼び出し時 | pwd, date, uname, git log, PATH, gcc -v, node -v, make -v |
| スキップログ | nimIsCiSkip呼び出し時 | commitMsg, skipci: true/false |
| 進捗ログ | csourcesビルド時 | キャッシュ存在確認結果 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

### 提供される関数一覧

| 関数名 | 説明 | 公開レベル |
|--------|------|-----------|
| `echo_run` | コマンドをログ出力後に実行 | 公開 |
| `nimGetLastCommit` | 最新コミットメッセージを取得 | 公開 |
| `nimIsCiSkip` | CIスキップ判定 | 公開 |
| `nimInternalInstallDepsWindows` | Windows依存関係インストール | 内部（Internal） |
| `nimInternalBuildKochAndRunCI` | kochビルドとCI実行 | 内部（Internal） |
| `nimDefineVars` | 変数定義読み込み | 公開 |
| `_nimNumCpu` | CPUコア数取得 | 内部（_プレフィックス） |
| `_nimBuildCsourcesIfNeeded` | csourcesビルド本体 | 内部（_プレフィックス） |
| `nimCiSystemInfo` | システム情報出力 | 公開 |
| `nimCsourcesHash` | csourcesハッシュ取得 | 公開 |
| `nimBuildCsourcesIfNeeded` | csourcesビルド（キャッシュ対応） | 公開 |

- `_` で始まる関数は内部関数であり、安定性が保証されない
- `Internal` を含む関数も内部使用を想定
- トップレベル文は避け、関数として定義することが推奨されている
- 可能な限りnimスクリプトの使用が推奨されている（コメントより）
