# バッチ設計書 11-test_nimhcr_integration.sh

## 概要

本ドキュメントは、NimコンパイラのHot Code Reloading（HCR）機能の統合テストを実行するシェルスクリプト `test_nimhcr_integration.sh` の設計書です。UNIX/Linux/macOS環境向けのHCRモジュールテストバッチについて記載します。

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

このバッチは、Nimコンパイラに搭載されているHot Code Reloading（HCR）機能が正常に動作することを検証するための統合テストを実行します。HCRは、アプリケーション実行中にコードを再コンパイルして動的にロードする機能であり、開発効率を大幅に向上させる重要な機能です。

**業務上の目的・背景**：Hot Code Reloadingは、開発者がアプリケーションを再起動することなくコードの変更を反映できる機能です。この機能の品質を担保するため、統合テストを自動実行し、HCR機能がnimrtlおよびnimhcrライブラリと正しく連携して動作することを検証します。HCR機能のリグレッションを早期に検出し、開発者体験を維持することが目的です。

**バッチの実行タイミング**：開発者が手動で実行、またはCIパイプラインにおいてHCR関連コードの変更時に実行されます。

**主要な処理内容**：
1. nimcacheディレクトリのクリーンアップ（既存のキャッシュを削除）
2. nimrtl.nimのコンパイル（Nimランタイムライブラリ）
3. nimhcr.nimのコンパイル（HCRモジュール本体）
4. HCRフラグを有効化してnimhcr_integration.nimをコンパイル
5. LD_LIBRARY_PATHを設定して統合テストを実行

**前後の処理との関連**：このバッチは単独で実行可能ですが、Nimコンパイラが事前にビルドされている必要があります。後続処理として、テスト結果がCI/CDパイプラインに報告されます。

**影響範囲**：nimcacheディレクトリ、lib/nimrtl.nim、lib/nimhcr.nimのコンパイル成果物、およびテスト実行結果に影響します。

## バッチ種別

テスト実行 / 統合テスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行またはCI時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Nimコンパイラが利用可能 | `nim`コマンドがPATH上で実行可能であること |
| UNIX/Linux/macOS環境 | シェルスクリプト実行環境が必要 |
| lib/nimrtl.nimが存在 | Nimランタイムライブラリのソースが必要 |
| lib/nimhcr.nimが存在 | HCRモジュールのソースが必要 |
| tests/dll/nimhcr_integration.nimが存在 | 統合テストのソースが必要 |

### 実行可否判定

スクリプトは `set -e` により、コマンドが失敗した時点で即座に終了します。前提条件が満たされていない場合、コンパイルエラーが発生してバッチは中断されます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| NIM_FLAGS | 文字列 | No | -d:debug | Nimコンパイラに渡す追加フラグ |
| コマンドライン引数 | 文字列 | No | -d:debug | NIM_FLAGSを上書きするオプション |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| lib/nimrtl.nim | Nimソースファイル | Nimランタイムライブラリのソース |
| lib/nimhcr.nim | Nimソースファイル | HCRモジュールのソース |
| tests/dll/nimhcr_integration.nim | Nimソースファイル | 統合テストのソース |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| nimrtl（共有ライブラリ） | .so/.dylib | コンパイルされたNimランタイムライブラリ |
| nimhcr（共有ライブラリ） | .so/.dylib | コンパイルされたHCRモジュール |
| nimhcr_integration（実行ファイル） | バイナリ | コンパイルされた統合テスト実行ファイル |
| nimcache/ | ディレクトリ | コンパイルキャッシュ |
| 標準出力 | テキスト | テスト実行結果 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nimrtl.so、nimhcr.so、nimhcr_integration等 |
| 出力先 | tests/dll/（現在のディレクトリ） |
| 文字コード | バイナリ |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. nimcacheディレクトリ削除
   └─ rm -rf nimcacheで既存キャッシュをクリア
2. NIM_FLAGS設定
   └─ コマンドライン引数があれば使用、なければ-d:debugをデフォルトとして設定
3. nimrtl.nimコンパイル
   └─ nim c --outdir:"." $NIM_FLAGS ../../lib/nimrtl.nim
4. nimhcr.nimコンパイル
   └─ nim c --outdir:"." $NIM_FLAGS ../../lib/nimhcr.nim
5. HCR統合テストコンパイル
   └─ nim --forceBuild --hotCodeReloading:on --nimcache:nimcache $NIM_FLAGS c nimhcr_integration.nim
6. LD_LIBRARY_PATH設定
   └─ 現在のディレクトリをライブラリ検索パスに追加
7. 統合テスト実行
   └─ ./nimhcr_integration $NIM $HCR_FLAGS c nimhcr_integration.nim
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[nimcacheディレクトリ削除]
    B --> C[NIM_FLAGS設定]
    C --> D[nimrtl.nimコンパイル]
    D --> E{コンパイル成功?}
    E -->|Yes| F[nimhcr.nimコンパイル]
    E -->|No| Z[エラー終了]
    F --> G{コンパイル成功?}
    G -->|Yes| H[nimhcr_integration.nimコンパイル]
    G -->|No| Z
    H --> I{コンパイル成功?}
    I -->|Yes| J[LD_LIBRARY_PATH設定]
    I -->|No| Z
    J --> K[統合テスト実行]
    K --> L[バッチ終了]
```

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | N/A |

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非ゼロ終了 | コンパイルエラー | nimrtl.nimのコンパイル失敗 | ソースコードを確認し、エラーを修正 |
| 非ゼロ終了 | コンパイルエラー | nimhcr.nimのコンパイル失敗 | ソースコードを確認し、エラーを修正 |
| 非ゼロ終了 | コンパイルエラー | nimhcr_integration.nimのコンパイル失敗 | ソースコードを確認し、エラーを修正 |
| 非ゼロ終了 | テスト失敗 | 統合テストの実行失敗 | テストコードまたはHCR実装を確認 |

### リトライ仕様

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

### 障害時対応

`set -e`により、エラー発生時は即座にスクリプトが終了します。失敗した場合は以下を確認してください：
1. Nimコンパイラが正しくインストールされているか
2. 必要なソースファイルが存在するか
3. コンパイルエラーメッセージの内容
4. 共有ライブラリのロードパスが正しいか

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のテスト実行 |
| 目標処理時間 | 数分以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同一ディレクトリで同時に複数実行すると、nimcacheやコンパイル成果物が競合する可能性があります。同時実行は非推奨です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | コンパイル開始時 | "===== Compiling HCR Integration Test =====" |
| 進捗ログ | 各コンパイルコマンド実行時 | コンパイラの出力 |
| 終了ログ | テスト終了時 | テスト結果 |
| エラーログ | エラー発生時 | コンパイラまたはテストのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト結果 | 非ゼロ終了コード | CI/CDシステム |

## 備考

- Windows環境では同等の機能を持つ `test_nimhcr_integration.bat` を使用してください
- HCR機能は実験的な機能であり、すべての環境で動作保証されているわけではありません
- `-d:debug`フラグはデバッグビルドを有効にし、デバッグ情報を含めた状態でテストを実行します
