# バッチ設計書 25-test-cli

## 概要

本ドキュメントは、clojure-lspプロジェクトにおけるcliモジュールのユニットテスト実行バッチ（test-cli）の設計を記載したものである。

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

本バッチは、clojure-lspのCLIモジュール（cliディレクトリ）に含まれるユニットテストを実行する処理である。Kaochaテストランナーを使用してテストを実行し、CLI固有の機能（コマンドライン引数解析、サーバー起動処理等）の動作を検証する。

**業務上の目的・背景**：clojure-lspのCLIモジュールは、コマンドライン引数の解析、LSPサーバーの起動・管理、外部システムとの連携などを担当している。これらの機能はユーザーインターフェースの重要な部分であり、libモジュールとは独立してテストすることで、CLI固有の問題を効率的に検出・修正できる。

**バッチの実行タイミング**：開発中に頻繁に実行される。また、CI/CDパイプラインでプルリクエストやコミット時に自動実行される。testバッチの一部としても実行される。

**主要な処理内容**：
1. cliディレクトリへの移動
2. Kaocha テストランナーの起動（-M:test エイリアス）
3. cli/test配下のすべてのテストファイルの実行
4. テスト結果の出力とステータスコードの返却

**前後の処理との関連**：testバッチから依存されており、test-reflectionおよびtest-libと合わせて実行される。単独で実行することも可能。

**影響範囲**：ファイルシステムへの永続的な変更は行わない。テスト実行結果が標準出力に出力される。

## バッチ種別

テスト処理 / ユニットテスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発時）/ コミット毎（CI/CD） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bb test-cli）またはCI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| JDK | Java Development Kit がインストールされていること |
| Babashka | bb コマンドが利用可能であること |
| Clojure CLI | clojure コマンドが利用可能であること |
| 依存関係 | cli/deps.edn に定義された依存関係が解決可能であること |

### 実行可否判定

特別な実行可否判定は行わない。前提条件が満たされていれば実行可能である。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドラインパラメータは不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| cli/test/**/*.clj | Clojureテストコード | テストファイル |
| cli/src/**/*.clj | Clojureソースコード | テスト対象コード |
| lib/src/**/*.clj | Clojureソースコード | 依存するlibモジュールコード |
| cli/deps.edn | EDN | 依存関係定義（:test エイリアス含む） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト実行結果 |
| 終了コード | 整数 | 0=成功、1以上=失敗 |

### 出力ファイル仕様

ファイル出力は行わない。

## 処理フロー

### 処理シーケンス

```
1. テスト開始ログ出力
   └─ ":running-unit-tests... cli" を出力

2. Clojure CLI起動
   └─ cliディレクトリで clojure -M:test を実行
   └─ Kaocha テストランナーが起動

3. テスト実行
   └─ cli/test配下の全テストファイルをスキャン
   └─ 各テスト名前空間をロード
   └─ テストケースを実行

4. 結果出力
   └─ 各テストの成功/失敗を出力
   └─ サマリーを出力

5. 空行出力
   └─ 視認性のための空行

6. 終了
   └─ テスト失敗があれば非ゼロ終了コード
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[開始ログ出力]
    B --> C[clojure -M:test 実行]
    C --> D[Kaochaテストランナー起動]
    D --> E[テストファイルスキャン]
    E --> F[テストケース実行]
    F --> G{全テスト成功?}
    G -->|Yes| H[成功サマリー出力]
    G -->|No| I[失敗サマリー出力]
    H --> J[終了コード0で終了]
    I --> K[非ゼロ終了コードで終了]
```

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

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

本バッチはデータベースを使用しない。

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

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1+ | テスト失敗 | テストケースがfailまたはerror | テストコードまたは実装を修正 |
| - | 依存関係エラー | 必要なライブラリが見つからない | deps.edn を確認し依存関係を解決 |
| - | コンパイルエラー | テストコードに構文エラー | テストコードを修正 |

### リトライ仕様

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

### 障害時対応

1. 失敗したテストケースを特定
2. テストログから失敗原因を分析
3. 対象コードまたはテストコードを修正
4. 再度テストを実行して確認

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 2ファイル、数十テストケース |
| 目標処理時間 | 2分以内 |
| メモリ使用量上限 | JVMデフォルト |

## 排他制御

同一プロジェクトディレクトリでの同時実行は可能だが、テスト間で共有リソースがある場合は競合の可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | ":running-unit-tests... cli" |
| 進捗ログ | テスト実行中 | 各テストケースの結果 |
| 終了ログ | バッチ終了時 | テストサマリー（passed/failed/error） |
| エラーログ | テスト失敗時 | 失敗したテストの詳細とスタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDシステム |
| 処理時間 | 5分 | CI/CDシステム |

## 備考

- テスト対象の主要モジュール：
  - clojure-lsp.main_test - CLIエントリーポイントのテスト（コマンドライン引数解析）
  - clojure-lsp.server_test - LSPサーバー機能のテスト
- テストフレームワーク依存関係：
  - lambdaisland/kaocha - テストランナー
  - nubank/matcher-combinators - マッチャーライブラリ
  - clojure-lsp/test-helper - テストヘルパーユーティリティ
- CLIテストはlibモジュールに依存するため、libモジュールのコードも間接的にテストされる
- test-libよりもテストファイル数が少ないため、実行時間は短い
