# バッチ設計書 12-test_nimhcr_integration.bat

## 概要

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

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

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

**業務上の目的・背景**：Hot Code Reloadingは、開発者がアプリケーションを再起動することなくコードの変更を反映できる機能です。この機能の品質を担保するため、Windows環境においても統合テストを自動実行し、HCR機能がnimrtlおよびnimhcrライブラリと正しく連携して動作することを検証します。クロスプラットフォーム対応のため、UNIX系のシェルスクリプト版（test_nimhcr_integration.sh）と同等の機能をWindows環境で提供します。

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

**主要な処理内容**：
1. 環境変数の設定（NIM、NIM_FLAGS）
2. nimrtl.nimのコンパイル（Nimランタイムライブラリ）
3. nimhcr.nimのコンパイル（HCRモジュール本体）
4. HCRフラグを有効化してnimhcr_integration.nimをコンパイル
5. 統合テストを実行

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

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

## バッチ種別

テスト実行 / 統合テスト

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

コマンドが失敗した場合、後続のコマンドは実行されますが、最終的なテスト結果により成否が判定されます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| NIM | 文字列 | No | nim | 使用するNimコンパイラコマンド |
| NIM_FLAGS | 文字列 | No | -d:debug | Nimコンパイラに渡す追加フラグ |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. 環境変数設定
   └─ NIM=nim, NIM_FLAGS=-d:debug を設定
2. nimrtl.nimコンパイル
   └─ %NIM% c --outdir:"." %NIM_FLAGS% ../../lib/nimrtl.nim
3. nimhcr.nimコンパイル
   └─ %NIM% c --outdir:"." %NIM_FLAGS% ../../lib/nimhcr.nim
4. HCRフラグ設定
   └─ HCR_FLAGS=--forceBuild --hotCodeReloading:on --nimcache:nimcache %NIM_FLAGS%
5. HCR統合テストコンパイル
   └─ %NIM% %HCR_FLAGS% c nimhcr_integration.nim
6. 統合テスト実行
   └─ nimhcr_integration %NIM% %HCR_FLAGS% c nimhcr_integration.nim
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[環境変数設定]
    B --> C[nimrtl.nimコンパイル]
    C --> D[nimhcr.nimコンパイル]
    D --> E[HCRフラグ設定]
    E --> F[nimhcr_integration.nimコンパイル]
    F --> G[統合テスト実行]
    G --> H[バッチ終了]
```

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

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

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

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

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

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

Windowsバッチファイルはデフォルトでエラー時も後続コマンドを実行します。失敗した場合は以下を確認してください：
1. Nimコンパイラが正しくインストールされているか
2. 必要なソースファイルが存在するか
3. コンパイルエラーメッセージの内容
4. DLLのロードパスが正しいか（カレントディレクトリまたはPATH上）

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- UNIX/Linux/macOS環境では同等の機能を持つ `test_nimhcr_integration.sh` を使用してください
- HCR機能は実験的な機能であり、すべての環境で動作保証されているわけではありません
- `-d:debug`フラグはデバッグビルドを有効にし、デバッグ情報を含めた状態でテストを実行します
- UNIX版と異なり、nimcacheのクリーンアップは行われません（必要に応じて手動でクリアしてください）
