# バッチ設計書 37-make composetest

## 概要

本ドキュメントは、mrubyプロジェクトにおけるMakeターゲット `make composetest` のバッチ設計書である。docker-composeを使用してコンテナ環境内でmrubyのテストをビルド・実行するコマンドについて記述する。

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

`make composetest` は、Makefileで定義されたテスト用ターゲットであり、Docker Composeを利用してコンテナ化された環境内でmrubyの全テストをビルド・実行する。No.31 `rake composetest` のMake経由でのラッパーとして機能する。

**業務上の目的・背景**：開発者のローカル環境の差異（OS、コンパイラバージョン、依存ライブラリ等）によるテスト結果のばらつきを排除し、再現性のあるテスト環境を提供する。Makeコマンドに慣れた開発者がDocker環境でのテストを手軽に実行するために使用される。

**バッチの実行タイミング**：開発者が手動で任意のタイミングで実行する。CI環境と同等の条件でのテスト実行が必要な場合に使用される。

**主要な処理内容**：
1. docker-composeコマンドの存在チェック（check_docker_compose依存ターゲット）
2. `$(DOCKER_COMPOSE) -p mruby run test` の実行
3. コンテナ内で `rake deep_clean` を実行し、既存のビルド成果物を全て削除
4. コンテナ内で `rake -m test:run:serial` を実行し、全テストを逐次ビルド・実行

**前後の処理との関連**：本タスクは独立して実行可能である。No.31 `rake composetest` と同等の処理をMake経由で実行する。No.36 `make composecheck` と同じDockerインフラを共有する。

**影響範囲**：コンテナ内部のビルドディレクトリのみに影響し、ホスト環境のファイルシステムには影響しない。

## バッチ種別

テスト実行（Docker環境・Makeラッパー）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（開発者によるコマンド実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Docker | Dockerデーモンが起動していること |
| docker-compose | docker-composeコマンドが利用可能であること（check_docker_composeで検証） |
| Dockerfile | プロジェクトルートにDockerfileが存在すること |
| docker-compose.yml | プロジェクトルートにdocker-compose.ymlが存在すること |

### 実行可否判定

Makefileの `check_docker_compose` ターゲットが先に実行され、`command -v docker-compose` でdocker-composeコマンドの存在を確認する。存在しない場合はエラーメッセージを出力して終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| DOCKER_COMPOSE | Makefile変数 | No | docker-compose | 使用するdocker-composeコマンド |
| MRUBY_CONFIG | 環境変数 | No | ci/gcc-clang | mrubyビルド設定ファイルパス（docker-compose.yml内で設定） |
| CC | 環境変数 | No | gcc | Cコンパイラ（docker-compose.yml内で設定） |
| CXX | 環境変数 | No | g++ | C++コンパイラ（docker-compose.yml内で設定） |
| LD | 環境変数 | No | gcc | リンカ（docker-compose.yml内で設定） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Makefile | Make | ターゲット定義 |
| Dockerfile | Docker設定 | コンテナイメージのビルド定義 |
| docker-compose.yml | YAML | サービス構成定義（コマンドと環境変数） |
| mrubyソースコード一式 | C/Ruby | テスト対象のソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テストの実行結果（成功/失敗の詳細） |

### 出力ファイル仕様

コンテナ内で生成されるビルド成果物はコンテナのライフサイクルに依存する。

| 項目 | 内容 |
|-----|------|
| ファイル名 | N/A（標準出力のみ） |
| 出力先 | 標準出力 |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. check_docker_compose実行
   └─ docker-composeコマンドの存在確認
2. $(DOCKER_COMPOSE) -p mruby run test実行
   └─ docker-compose -p mruby run test を実行
3. Dockerイメージビルド（未ビルドの場合）
   └─ Dockerfileに基づきイメージを構築
4. コンテナ起動
   └─ 作業ディレクトリ /app でtestサービスを起動
5. deep_clean実行
   └─ コンテナ内で rake deep_clean を実行
6. テストビルド・実行
   └─ rake -m test:run:serial で全テストを逐次ビルド・実行
7. コンテナ停止
   └─ テスト完了後、コンテナを停止
```

### フローチャート

```mermaid
flowchart TD
    A[make composetest 開始] --> B[check_docker_compose: docker-compose存在確認]
    B --> C{docker-composeが存在?}
    C -->|なし| D[エラー出力・終了]
    C -->|あり| E[docker-compose -p mruby run test 実行]
    E --> F{Dockerイメージ存在?}
    F -->|なし| G[Dockerイメージビルド]
    F -->|あり| H[コンテナ起動]
    G --> H
    H --> I[rake deep_clean 実行]
    I --> J[rake -m test:run:serial 実行]
    J --> K{テスト結果}
    K -->|成功| L[正常終了・コンテナ停止]
    K -->|失敗| M[エラー出力・コンテナ停止]
    L --> N[バッチ終了]
    M --> N
```

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

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

本バッチではデータベース操作は行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | コマンド未検出 | docker-composeがPATHに存在しない | docker-composeをインストールする |
| 非0終了 | Docker未起動 | Dockerデーモンが起動していない | Dockerデーモンを起動する |
| 非0終了 | イメージビルド失敗 | Dockerfileのビルドに失敗 | Dockerfileやネットワーク接続を確認する |
| 非0終了 | テスト失敗 | テストケースの失敗 | テスト結果の出力を確認し、失敗原因を特定する |

### リトライ仕様

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

### 障害時対応

バッチ失敗時は、標準出力・標準エラー出力のログを確認する。残存コンテナは `docker-compose -p mruby down` で削除できる。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | mruby全テストスイート |
| 目標処理時間 | 環境依存（初回イメージビルド時は数分追加） |
| メモリ使用量上限 | Dockerコンテナのデフォルトメモリ制限に依存 |

## 排他制御

docker-composeのプロジェクト名 `mruby` で管理されるため、同一プロジェクト名で同時実行した場合はコンテナ名の競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | docker-compose起動時 | コンテナ起動メッセージ |
| 進捗ログ | テスト実行中 | 各テストケースの実行結果 |
| 終了ログ | テスト完了時 | テスト結果サマリー |
| エラーログ | エラー発生時 | エラー詳細メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 特に定めなし | 標準出力 |
| エラー件数 | 1件以上 | 標準エラー出力 |

## 備考

- Makefileでは `DOCKER_COMPOSE = docker-compose` と定義されている
- `composetestターゲットはcheck_docker_compose` のみに依存する（check_pre_commitには依存しない）
- docker-compose.ymlのtestサービスのデフォルトコマンド（`rake deep_clean && rake -m test:run:serial`）がそのまま実行される
- コンテナ内では `ci/gcc-clang` 設定ファイルを使用し、GCCでビルドを行う
- Rakefileにも同等の `rake composetest` タスクが定義されている
- Makefileのコメント `## build and run all mruby tests with docker-compose` がhelpターゲットで表示される
