# バッチ設計書 19-koch.nim（tests）

## 概要

本ドキュメントは、Nimコンパイラのテストスイートを実行する `koch tests` コマンドの設計書です。このコマンドはtestamentテストランナーを使用して、Nimプロジェクトの各種テストを実行します。

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

このバッチは、Nimコンパイラと標準ライブラリのテストスイートを実行するためのインターフェースを提供します。testamentと呼ばれるNim専用のテストフレームワークを使用し、カテゴリ別、個別、または全テストの実行が可能です。

**業務上の目的・背景**：ソフトウェア品質を維持するため、コンパイラや標準ライブラリの変更が既存機能に影響を与えないことを検証する必要があります。このコマンドは、開発者がローカル環境でテストを実行し、変更の影響を確認するための手段を提供します。testamentは、テストの期待結果、コンパイルオプション、実行条件などを柔軟に指定でき、複雑なコンパイラテストに対応しています。

**バッチの実行タイミング**：以下のタイミングで実行されます：
- コンパイラや標準ライブラリの変更後
- プルリクエスト作成前の確認
- 特定の機能やバグ修正の検証時
- リリース前の品質確認

**主要な処理内容**：
1. testamentのコンパイル（--opt:speedオプション付き）
2. testamentの実行（指定されたオプションとカテゴリで）
3. テスト結果の出力
4. 成功/失敗の判定と終了コードの返却

**前後の処理との関連**：`koch boot`でNimコンパイラがビルドされている必要があります。テスト実行後は、テスト結果に基づいて開発者がコードを修正するか、マージ可能と判断します。

**影響範囲**：テスト実行のみであり、ソースコードやビルド成果物には影響しません。テスト結果が標準出力に出力され、終了コードで成否が報告されます。

## バッチ種別

テスト実行 / テストスイート

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Nimコンパイラがビルド済み | bin/nimが存在し実行可能であること |
| koch.nimがコンパイル済み | kochコマンドが実行可能であること |
| tests/ディレクトリが存在 | テストスイートが配置されていること |

### 実行可否判定

Nimコンパイラが存在しない場合、testamentのコンパイルに失敗します。テストディレクトリが存在しない場合、testamentがエラーを報告します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| カテゴリ | 文字列 | No | all | テストカテゴリ（async、stdlib等） |
| --nim:パス | 文字列 | No | 自動検出 | 使用するNimコンパイラのパス |
| 追加オプション | 文字列 | No | なし | testamentに渡す追加オプション |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| testament/testament.nim | Nimソースファイル | テストランナーのソース |
| tests/ | ディレクトリ | テストスイート |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト結果、進捗情報 |
| testament/testament実行ファイル | バイナリ | コンパイルされたテストランナー |
| 終了コード | 整数 | 0=全テスト成功、非0=失敗あり |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | testament（拡張子は環境依存） |
| 出力先 | testament/ |
| 文字コード | バイナリ |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. testamentコンパイル
   └─ nimexec "cc --opt:speed testament/testament"
2. testamentパス構築
   └─ getCurrentDir() / "testament/testament".exe
3. --nimオプション追加
   └─ --nim:findNim() でNimコンパイラパスを指定
4. 引数処理
   └─ 引数がなければ"all"を使用、あれば指定された引数を使用
5. testament実行
   └─ testCmd（testamentパス + --nim + 引数）を実行
6. 結果判定
   └─ tryExecで実行し、失敗時はquit("tests failed", QuitFailure)
```

### フローチャート

```mermaid
flowchart TD
    A[tests開始] --> B[testamentコンパイル]
    B --> C[testamentパス構築]
    C --> D[--nimオプション追加]
    D --> E{引数あり?}
    E -->|Yes| F[指定された引数を使用]
    E -->|No| G["all"を使用]
    F --> H[testament実行]
    G --> H
    H --> I{実行成功?}
    I -->|Yes| J[tests完了]
    I -->|No| K[エラー終了]
```

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

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

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

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| QuitFailure | テスト失敗 | 1つ以上のテストが失敗 | 失敗したテストを確認して修正 |
| コンパイルエラー | ソースエラー | testamentのコンパイル失敗 | testamentソースを確認 |

### リトライ仕様

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

### 障害時対応

1. 失敗したテストのログを確認
2. テストが期待する動作と実際の動作を比較
3. コンパイラまたはテストコードを修正
4. テストを再実行して修正を確認

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テストカテゴリに依存（数百〜数千テスト） |
| 目標処理時間 | カテゴリに依存（数分〜数十分） |
| メモリ使用量上限 | 環境依存 |

## 排他制御

同一ディレクトリで同時に複数のtestsを実行すると、一時ファイルやテスト出力が競合する可能性があります。同時実行は非推奨です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| テスト結果 | 各テスト完了時 | テスト名、成功/失敗、実行時間 |
| サマリー | 全テスト完了時 | 成功/失敗/スキップ件数 |
| エラー詳細 | テスト失敗時 | 期待値と実際の値の差分 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト結果 | 非ゼロ終了コード | CI/CDシステム |
| テスト失敗件数 | 1件以上 | 標準出力 |

## 備考

- testamentはNim専用のテストフレームワークで、特殊なコメント記法でテスト条件を指定できます
- `koch tests cat async`のように、カテゴリを指定して特定のテストのみ実行できます
- 使用可能なカテゴリ：async、stdlib、gc、threads、js、cpp、debugger、errmsgs等
- `--opt:speed`でtestamentをコンパイルすることで、テスト実行のオーバーヘッドを削減しています
- testamentは並列実行に対応しており、マルチコア環境で高速にテストを実行できます
- `|`演算子により、引数が空の場合は"all"がデフォルトとして使用されます
- テスト失敗時は`quit("tests failed", QuitFailure)`で明示的にエラー終了します
