# バッチ設計書 44-test:db

## 概要

本ドキュメントは、データベースをリセットしてからテストを実行するRakeタスク `test:db` の設計仕様を定義する。

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

`test:db` タスクは、テストデータベースを準備（リセット）してから、すべてのテストを実行する複合タスクである。データベーススキーマの変更後や、テスト環境のデータベースが不整合な状態になった場合に使用される。

**業務上の目的・背景**：開発中にデータベーススキーマが変更された場合、テストデータベースも同期する必要がある。本タスクは `db:test:prepare` を実行してテストデータベースのスキーマを最新化した後、テストスイートを実行することで、一貫したテスト環境を保証する。マイグレーション実行後やスキーマ変更後のテスト実行時に特に有用である。

**バッチの実行タイミング**：以下の場面で実行される。
- データベースマイグレーション後の初回テスト
- テストデータベースの状態が不整合な場合
- CI/CD環境での安全なテスト実行
- チーム内で「テストが失敗する」問題のトラブルシューティング時

**主要な処理内容**：
1. RAILS_ENVをtest環境に設定（未設定の場合）
2. システムコマンドとして `rake db:test:prepare test` を実行
3. db:test:prepare でテストデータベースのスキーマをロード
4. 続いて test タスクでテストを実行
5. 結果を標準出力に表示し、終了コードを返す

**前後の処理との関連**：本タスクは `db:test:prepare` と `test` タスクを順次実行する。`db:test:prepare` は内部で `db:test:load_schema` を呼び出し、テストデータベースのスキーマを再構築する。

**影響範囲**：テスト環境のデータベースに対して、スキーマの再ロードとテストデータの読み書きが行われる。テストデータベースの既存データは削除される可能性がある。

## バッチ種別

テスト実行 / データベース準備

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発時・CI/CD時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動・CI/CD（bin/rails test:db） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース設定 | config/database.ymlにtest環境が設定されていること |
| スキーマファイル | db/schema.rb または db/structure.sql が存在すること |
| テストファイル | test/ディレクトリ配下にテストファイルが存在すること |

### 実行可否判定

テスト環境のデータベース設定とスキーマファイルが存在すれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAILS_ENV | String | No | test | 実行環境（常にtestが使用される） |
| TEST | String | No | なし | 実行する特定のテストファイル |
| TESTOPTS | String | No | なし | Minitestに渡す追加オプション |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| db/schema.rb | Ruby | スキーマ定義ファイル |
| db/structure.sql | SQL | 構造定義ファイル（代替） |
| test/**/*_test.rb | Ruby | テストファイル群 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | データベース準備状況とテスト結果 |
| 終了コード | 整数 | 0:成功、非ゼロ:失敗 |

### 出力ファイル仕様

ファイル出力なし。標準出力へのテスト結果表示のみ。

## 処理フロー

### 処理シーケンス

```
1. RAILS_ENV の設定
   └─ ENV.fetch("RAILS_ENV", "test") で test 環境を設定
2. system() コマンドの実行
   └─ "rake db:test:prepare test" を子プロセスとして実行
3. db:test:prepare の実行
   └─ テストデータベースのスキーマをロード
4. test タスクの実行
   └─ 全テストを実行
5. 終了コードの判定
   └─ 失敗時は exit(false)
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[RAILS_ENV=test 設定]
    B --> C[system で rake 実行]
    C --> D[db:test:prepare]
    D --> E[テストDB purge]
    E --> F[スキーマロード]
    F --> G[test タスク実行]
    G --> H{テスト結果}
    H -->|成功| I[exit 0]
    H -->|失敗| J[exit 非ゼロ]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| purge | 全テーブル | DROP/CREATE | テストDB全体を再作成 |
| load_schema | 全テーブル | CREATE | スキーマに基づいてテーブル作成 |
| テスト実行 | 各テーブル | SELECT/INSERT/UPDATE/DELETE | テスト内容に依存 |

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

db:test:prepare の内部処理として、テストデータベースの全テーブルが削除され、スキーマファイルに基づいて再作成される。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非ゼロ終了 | スキーマロードエラー | スキーマファイルが不正 | schema.rbを確認・再生成 |
| 非ゼロ終了 | テスト失敗 | テストアサーションが失敗 | テストまたは本番コードを修正 |
| 接続エラー | データベースエラー | テストDBに接続できない | database.ymlを確認 |

### リトライ仕様

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

### 障害時対応

スキーマエラーの場合は `db:migrate` や `db:schema:dump` を実行してスキーマファイルを更新する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | db:test:prepare は DDL のため暗黙的コミット |
| コミットタイミング | 各DDL実行時 |
| ロールバック条件 | なし（DDL実行後は戻せない） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テーブル数 + テストケース数 |
| 目標処理時間 | プロジェクト規模に依存 |
| メモリ使用量上限 | プロジェクトにより異なる |

## 排他制御

テストデータベースに対してDDL操作を行うため、同一環境での並列実行は不可。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | スキーマロード時 | テーブル作成ログ（VERBOSE=true時） |
| 標準出力 | テスト実行時 | テスト進捗・結果 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト成功率 | 100% | CI/CD通知先 |

## 備考

- `db:test:prepare` は内部で `db:test:load_schema` を呼び出す
- マルチデータベース構成の場合、すべてのテストデータベースが準備される
- 通常の `test` タスクよりも実行時間が長くなる（DB準備分）
- 頻繁に実行する場合は `test` タスクのみの使用を推奨（スキーマが変更されていない場合）
