# バッチ設計書 9-test_virtualenv.nu

## 概要

本ドキュメントは、Python仮想環境とNushellの連携をテストするNushellスクリプト `test_virtualenv.nu` のバッチ設計書です。Nushell環境でPython virtualenvが正しく動作するかを検証するテストバッチとして設計されています。

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

このバッチは、PythonのvirtualenvとNushellの統合機能をテストします。仮想環境の作成、アクティベート、Pythonインタープリタの切り替え、環境変数の設定、デアクティベートの一連の流れが正しく動作することを検証します。多言語・特殊文字を含む環境名でのテストも行い、国際化対応を確認します。

**業務上の目的・背景**：NushellはPython virtualenvのactivate.nuスクリプトをサポートしています。Python開発者がNushell上で仮想環境を使用する際に、環境の切り替えが正しく動作することは重要です。本テストスクリプトは、この統合機能が正しく実装されていることを検証し、リグレッションを防止します。

**バッチの実行タイミング**：virtualenv関連の機能変更後、またはNushellのoverlay機能の変更後にテストとして実行します。CI/CDパイプラインでの統合テストとしても使用可能です。

**主要な処理内容**：
1. Windows環境の場合、Python出力のエンコーディングを設定
2. 特殊文字（Unicode、絵文字、中国語など）を含む名前で仮想環境を作成
3. アクティベート前のPythonインタープリタパスと環境変数を確認
4. overlay useでactivate.nuを読み込んでアクティベート
5. アクティベート後のPythonインタープリタパスと環境変数を確認
6. VIRTUAL_ENV_PROMPTの確認
7. deactivateで仮想環境を終了
8. デアクティベート後のPythonインタープリタパスと環境変数を確認
9. 期待値との比較と結果判定

**前後の処理との関連**：事前にPythonとvirtualenvがインストールされている必要があります。テスト用の一時ファイル（script.nu）が作成され、テスト後に削除されます。

**影響範囲**：カレントディレクトリに仮想環境ディレクトリと一時スクリプトファイルが作成されます。

## バッチ種別

テスト処理 / 統合テスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Nushell環境 | Nushellがインストールされていること |
| Python環境 | Pythonがインストールされていること |
| virtualenv | virtualenvコマンドが利用可能であること |
| 書き込み権限 | カレントディレクトリへの書き込み権限があること |

### 実行可否判定

- `nu` コマンドが実行可能であること
- `python` コマンドが実行可能であること
- `virtualenv` コマンドが実行可能であること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| $nu.os-info | システム情報 | OS種別の判定に使用 |
| $env.PWD | 環境変数 | カレントディレクトリパス |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト結果（成功時は出力なし） |
| 標準エラー | テキスト | テスト失敗時のエラーメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 一時ファイル | script.nu（テスト後削除） |
| 仮想環境 | e-$ ert...（テスト用、削除されない） |

## 処理フロー

### 処理シーケンス

```
1. 環境設定（Windows向け）
   └─ PYTHONIOENCODING, PYTHONLEGACYWINDOWSSTDIO を UTF-8 に設定
2. テスト環境名設定
   └─ Unicode、絵文字、中国語を含む名前 "e-$ ert..." を定義
3. OS別パス設定
   └─ Windows: Scripts/python.exe、その他: bin/python
4. テストコマンド準備
   └─ Pythonインタープリタ確認、VIRTUAL_ENV確認、overlay use、deactivate
5. 期待値設定
   └─ 各ステップでの期待されるPythonパス、環境変数値
6. virtualenv作成
   └─ virtualenv $env_name
7. テストスクリプト実行
   └─ script.nu として保存し nu で実行
8. 結果検証
   └─ 出力と期待値を比較、不一致ならエラー
9. クリーンアップ
   └─ script.nu を削除
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Windows?}
    B -->|Yes| C[エンコーディング設定]
    B -->|No| D[テスト環境名設定]
    C --> D
    D --> E[OS別パス設定]
    E --> F[テストコマンド準備]
    F --> G[期待値設定]
    G --> H[virtualenv作成]
    H --> I[テストスクリプト保存]
    I --> J[nuでスクリプト実行]
    J --> K{出力と期待値比較}
    K -->|一致| L[script.nu削除]
    K -->|不一致| M[エラー出力]
    L --> N[バッチ終了]
    M --> N
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | Python未インストール | pythonコマンドがない場合 | Pythonをインストール |
| 1 | virtualenv未インストール | virtualenvコマンドがない場合 | `pip install virtualenv` を実行 |
| 1 | テスト失敗 | 出力と期待値が不一致の場合 | エラーメッセージを確認して原因を調査 |
| 1 | 権限エラー | ディレクトリ書き込み権限がない場合 | 適切な権限で実行 |

### リトライ仕様

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

### 障害時対応

テスト失敗時は出力（OUTPUT）と期待値（EXPECTED）が両方表示されます。差分を確認し、virtualenv統合機能の不具合を調査してください。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回（単一テストケース） |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | 最小限 |

## 排他制御

同一ディレクトリでの並列実行は非推奨です。同名の仮想環境やscript.nuファイルの競合を避けてください。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 該当なし | 特になし |
| 進捗ログ | 該当なし | 特になし |
| 終了ログ | 該当なし | 成功時は出力なし |
| エラーログ | テスト失敗時 | "Output does not match the expected value" + 詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト結果 | 失敗 | 標準エラー出力 |
| 処理時間 | 1分以上 | 手動確認 |

## 備考

- テスト用環境名には国際化対応を検証するため、以下の特殊文字が含まれています：
  - ドル記号: `$`
  - キリル文字: `рт`
  - 絵文字: `...`（消防車、チェスの駒）
  - 中国語: `中片`
- Windowsでは `PYTHONIOENCODING` と `PYTHONLEGACYWINDOWSSTDIO` を設定してUTF-8出力を保証
- `overlay use` コマンドを使用してactivate.nuを読み込み
- `deactivate` コマンドで仮想環境を終了
- テスト後に仮想環境ディレクトリは削除されない（手動クリーンアップが必要）
- 7つのチェックポイントで出力を検証：
  1. アクティベート前のPythonパス
  2. アクティベート前のVIRTUAL_ENV
  3. アクティベート後のPythonパス
  4. アクティベート後のVIRTUAL_ENV
  5. VIRTUAL_ENV_PROMPT
  6. デアクティベート後のPythonパス
  7. デアクティベート後のVIRTUAL_ENV
