# バッチ設計書 26-test_docker.nu

## 概要

本ドキュメントは、Nushellプロジェクトにおけるtest_docker.nuスクリプトの設計仕様を定義したものである。このバッチはDockerコンテナ内でNushellの動作テストを実行し、Dockerイメージの品質を検証する。

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

test_docker.nuは、NushellのDockerイメージが正しく構成されていることを検証するテストスクリプトである。コンテナ内でNushellが正常に動作し、ユーザー設定、プラグイン、シェル登録などが期待通りに構成されていることを確認する。

**業務上の目的・背景**：Nushellは公式Dockerイメージを提供しており、そのイメージが本番環境で問題なく動作することを保証する必要がある。コンテナ環境特有の問題（PID 1でのシグナル処理、非root実行、一時ファイルのクリーンアップなど）を検証し、ユーザーに信頼性の高いDockerイメージを提供する。CI/CDパイプラインでDockerイメージのビルド後に自動実行され、品質ゲートとして機能する。

**バッチの実行タイミング**：Dockerイメージのビルド後、CI/CDパイプライン内で自動実行される。ローカル開発環境でも手動実行可能。

**主要な処理内容**：
1. テスト対象の関数を動的に検出（"test "で始まる関数）
2. 各テストを並列実行（par-each）
3. テスト結果を集計し、PASS/FAILを表示
4. 1つでも失敗があれば終了コード1で終了

**前後の処理との関連**：docker buildでDockerイメージをビルドした後に実行される。docker/Dockerfileおよびdocker/debian.Dockerfileで定義されたイメージを検証対象とする。

**影響範囲**：Dockerコンテナ内の環境を検証するのみ。ホストシステムには影響を与えない。

## バッチ種別

テスト / Docker環境検証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（Dockerイメージビルド後） |
| 実行時刻 | CI/CDトリガー時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | CI/CD / 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Docker環境 | Dockerがインストールされ、Nushellイメージがビルド済みであること |
| コンテナ実行 | Dockerコンテナ内で実行されること |
| Nushell | コンテナ内にNushellがインストールされていること |

### 実行可否判定

Dockerコンテナ内でNushellが実行可能な場合に実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータは受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| scope commands | Nushell内部 | 利用可能なコマンド一覧（テスト関数の検出用） |
| /etc/shells | テキスト | シェル登録の確認 |
| /etc/os-release | テキスト | OS種別の確認 |
| ~/.config/nushell/ | ディレクトリ | Nushell設定ファイルの確認 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト/マークダウン | テスト結果テーブルとサマリー |
| 終了コード | 数値 | 0: 全テスト成功、1: 1つ以上失敗 |

### 出力ファイル仕様

ファイル出力なし。

## 処理フロー

### 処理シーケンス

```
1. テスト関数の検出
   └─ scope commandsで"test "で始まるカスタム関数を列挙
   └─ "ignore"で始まる説明を持つ関数は除外
2. 実行プランの生成
   └─ 各テスト関数をクロージャとしてラップ
3. テストの並列実行
   └─ par-eachで全テストを並列実行
4. 結果の収集
   └─ 各テストのPASS/FAIL状態とエラーメッセージを収集
5. 結果の表示
   └─ GitHub Actions環境ではMarkdown形式、それ以外はテーブル形式
6. サマリーの表示
   └─ 成功数/失敗数を表示
7. 終了コードの設定
   └─ 失敗があればexit 1
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[テスト関数検出]
    B --> C[実行プラン生成]
    C --> D[テスト並列実行]
    D --> E[結果収集]
    E --> F{GITHUB_ACTIONS?}
    F -->|Yes| G[Markdown形式で出力]
    F -->|No| H[テーブル形式で出力]
    G --> I[サマリー表示]
    H --> I
    I --> J{失敗あり?}
    J -->|Yes| K[exit 1]
    J -->|No| L[正常終了]
```

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

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

データベース操作なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | テスト失敗 | 1つ以上のテストが失敗 | 失敗したテストの内容を確認し、Dockerイメージを修正 |
| - | アサーションエラー | assert関数で期待値と一致しない | テスト対象の機能を修正 |

### リトライ仕様

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

### 障害時対応

失敗したテストのエラーメッセージを確認し、Dockerfileまたはコンテナ設定を修正する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8テスト（現在の実装） |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | 無視可能 |

## 排他制御

排他制御なし。テストは読み取り専用で実行される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 結果テーブル | テスト完了時 | テスト名とPASS/FAIL状態 |
| サマリー | 全テスト完了時 | "Testing completed: X of Y were successful/failed" |

## 監視・アラート

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

## 備考

- 実行コマンド例: `docker run -it --rm -v "$(pwd):/work" nushell:alpine /work/test_docker.nu`
- 実装されているテストケース:
  1. **test nu is pid 1**: NushellがPID 1で実行されていることを確認（シグナル処理のため重要）
  2. **test user is nushell**: 実行ユーザーがnushellであることを確認
  3. **test user is not root**: root権限でないことを確認（uid=1000, gid=1000）
  4. **test nu is added as a shell**: /etc/shellsにNushellが登録されていることを確認
  5. **test temp directory is cleared**: /tmpディレクトリがクリーンであることを確認
  6. **test apt install cache is cleared**: Debian/Ubuntu系でaptキャッシュがクリアされていることを確認
  7. **test main plugins are installed**: 主要プラグイン（formats, gstat, inc, polars, query）がインストールされていることを確認
  8. **test config initialised**: env.nuとconfig.nuが適切なサイズで存在することを確認
- GitHub Actions環境（GITHUB_ACTIONS環境変数が存在）ではMarkdownテーブル形式で出力される
- テストは`par-each`で並列実行されるため、高速に完了する
