# バッチ設計書 12-toolkit test

## 概要

本ドキュメントは、Nushellプロジェクトにおける`toolkit test`コマンドのバッチ設計書です。Cargoテストを実行してNushellの機能が正常に動作することを検証するコマンドの仕様を定義します。

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

`toolkit test`は、Nushellプロジェクトのテストスイートを実行し、コードの動作が期待通りであることを確認するバッチ処理です。

**業務上の目的・背景**：ソフトウェア開発において、コード変更が既存機能を破壊していないことを確認することは重要です。テストスイートを実行することで、回帰テストを自動化し、品質を担保します。開発者がコード変更後に迅速にテストを実行できる環境を提供することで、開発効率と品質の両立を図ります。

**バッチの実行タイミング**：開発者がコード変更を行った後、PR提出前に手動で実行します。また、`toolkit check pr`の一部として自動的に実行されます。CI/CDパイプラインでも実行されます。

**主要な処理内容**：
1. 指定された機能（features）またはワークスペース全体でテストを実行
2. オプションでcargo-nextestを使用した高速テスト実行
3. テスト結果の報告

**前後の処理との関連**：`toolkit check pr`コマンドの一部として、`toolkit clippy`の後に実行されます。テスト成功後に`toolkit test stdlib`が実行されます。

**影響範囲**：Nushellワークスペース全体のテストコード。テスト実行に伴い一時ファイルが生成される場合がありますが、テスト完了後にクリーンアップされます。

## バッチ種別

テスト実行 / 品質検証

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rust環境 | Rustツールチェーンがインストールされていること |
| Nushell環境 | Nushellがインストールされ、toolkitモジュールが利用可能であること |
| プロジェクトディレクトリ | Nushellプロジェクトのルートディレクトリで実行すること |
| cargo-nextest（オプション） | --fastオプション使用時は`cargo install cargo-nextest`が必要 |

### 実行可否判定

Cargoプロジェクトとして正常にビルドできる状態であれば実行可能。コンパイルエラーがある場合は、テスト実行前にエラーが発生します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --fast | flag | No | false | cargo-nextestを使用して高速テストを実行 |
| --features | list<string> | No | [] | テストを実行する機能のリスト |
| --workspace | flag | No | false | ワークスペース全体でテストを実行（--featuresを上書き） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| テストコード | Rustファイル群 | ワークスペース配下の全テストファイル |
| Cargo.toml | TOML | ワークスペースとクレートの設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト実行結果 |
| 標準エラー出力 | テキスト | エラーメッセージ |

### 出力ファイル仕様

ファイル出力はありません（コンソール出力のみ）。

## 処理フロー

### 処理シーケンス

```
1. パラメータの評価
   └─ --fast、--features、--workspaceの組み合わせを判定

2. テストコマンドの選択
   └─ --fast指定時: cargo nextest run
   └─ 通常時: cargo test

3. スコープの決定
   └─ --workspace指定時: --all または --workspace オプションを付与
   └─ --features指定時: --features オプションで機能を指定

4. テスト実行
   └─ 選択されたコマンドとオプションでテストを実行

5. 結果の出力
   └─ テスト結果を標準出力に表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{--fast指定?}
    B -->|Yes| C{--workspace指定?}
    B -->|No| D{--workspace指定?}
    C -->|Yes| E[cargo nextest run --all]
    C -->|No| F[cargo nextest run --features]
    D -->|Yes| G[cargo test --workspace]
    D -->|No| H[cargo test --features]
    E --> I[テスト実行]
    F --> I
    G --> I
    H --> I
    I --> J{テスト成功?}
    J -->|Yes| K[正常終了]
    J -->|No| L[異常終了]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | テスト失敗 | アサーション失敗 | 失敗したテストを確認し、コードを修正 |
| - | コンパイルエラー | テストコードの構文エラー | ソースコードを修正 |
| - | タイムアウト | テスト実行時間超過 | テストの最適化またはタイムアウト設定の見直し |
| - | nextest未インストール | --fast使用時にcargo-nextestがない | cargo install cargo-nextest |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

テスト失敗が発生した場合、失敗したテストの出力を確認し、対応するソースコードまたはテストコードを修正して再度テストを実行します。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プロジェクト全体のテストケース |
| 目標処理時間 | 数分〜数十分（環境・テスト数依存） |
| メモリ使用量上限 | Cargoビルド・テスト実行に依存 |

## 排他制御

同一ディレクトリでの複数Cargo操作は競合する可能性があります。Cargo.lockによるファイルロックが使用されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | テスト開始時（check pr経由） | "running `toolkit test`" |
| 進捗ログ | 各テスト実行時 | テスト名と結果 |
| 終了ログ | テスト完了時 | 成功/失敗件数サマリー |
| エラーログ | テスト失敗時 | 失敗したテストの詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | CI/CDタイムアウト設定に依存 | CI/CDシステム |
| 失敗テスト数 | 1件以上でビルド失敗 | CI/CD通知 |

## 備考

- `--fast`オプションはcargo-nextestを使用し、並列実行によりテスト時間を短縮できます
- cargo-nextestは外部ツールであり、別途インストールが必要です（https://nexte.st/）
- `--workspace`と`--features`が両方指定された場合、`--workspace`が優先されます
