# バッチ設計書 36-make composecheck

## 概要

本ドキュメントは、mrubyプロジェクトにおけるMakeターゲット `make composecheck` のバッチ設計書である。docker-composeを使用してコンテナ環境内でprekフック（pre-commitフック）を全ファイルに対して実行するコマンドについて記述する。

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

`make composecheck` は、Makefileで定義された品質管理用ターゲットであり、Docker Composeを利用してコンテナ化された環境内でprekフックを全ファイルに対して実行する。ホスト環境に依存せず、統一された環境で品質チェックを実行できる。

**業務上の目的・背景**：開発者のローカル環境にprekやその依存ツール（shellcheck等）がインストールされていない場合でも、Docker環境を利用して一貫した品質チェックを実行可能にする。CI/CDパイプラインと同等の品質チェック環境をローカルで再現するために必要なターゲットである。

**バッチの実行タイミング**：開発者が手動で任意のタイミングで実行する。特に、ローカルにprekやその依存ツールがインストールされていない場合や、CI環境と同等の条件でのチェックが必要な場合に使用される。

**主要な処理内容**：
1. docker-composeコマンドの存在チェック（check_docker_compose依存ターゲット）
2. prekコマンドの存在チェック（check_pre_commit依存ターゲット）
3. `$(DOCKER_COMPOSE) -p mruby run test $(PRE_COMMIT) run --all-files` の実行
4. コンテナ内でprekフックを全ファイルに対して実行

**前後の処理との関連**：本タスクは独立して実行可能である。No.35 `make check` のDocker版バリエーションであり、No.30 `rake composecheck` と同等の処理をMake経由で実行する。No.37 `make composetest` と同じDockerインフラを共有する。

**影響範囲**：コンテナ内部でのみ処理が実行される。ホスト環境のファイルシステムには直接的な影響はない。チェック結果は標準出力に表示される。

## バッチ種別

品質管理（Docker環境でのコード検査）

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

Makefileの `check_docker_compose` および `check_pre_commit` ターゲットが先に実行され、それぞれのコマンドの存在を確認する。いずれかが存在しない場合はエラーメッセージを出力して終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| DOCKER_COMPOSE | Makefile変数 | No | docker-compose | 使用するdocker-composeコマンド |
| PRE_COMMIT | Makefile変数 | No | prek | 使用するpre-commitコマンド |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Makefile | Make | ターゲット定義 |
| Dockerfile | Docker設定 | コンテナイメージのビルド定義 |
| docker-compose.yml | YAML | サービス構成定義 |
| .pre-commit-config.yaml | YAML | pre-commitフックの設定 |
| リポジトリ内全ファイル | 各種 | チェック対象ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 各フックの実行結果（Passed/Failed） |

### 出力ファイル仕様

コンテナ内で実行されるため、ホスト側のファイルは変更されない。

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

## 処理フロー

### 処理シーケンス

```
1. check_docker_compose実行
   └─ docker-composeコマンドの存在確認
2. check_pre_commit実行
   └─ prekコマンドの存在確認
3. docker-compose -p mruby run test prek run --all-files実行
   └─ Dockerコンテナ内でprekフックを実行
4. 各フックの実行
   └─ .pre-commit-config.yamlで定義された全フックを順次実行
5. 結果出力
   └─ 各フックのPassed/Failed結果を標準出力に表示
```

### フローチャート

```mermaid
flowchart TD
    A[make composecheck 開始] --> B[check_docker_compose: docker-compose存在確認]
    B --> C{docker-composeが存在?}
    C -->|なし| D[エラー出力・終了]
    C -->|あり| E[check_pre_commit: prek存在確認]
    E --> F{prekが存在?}
    F -->|なし| D
    F -->|あり| G[docker-compose -p mruby run test prek run --all-files]
    G --> H{Dockerイメージ存在?}
    H -->|なし| I[Dockerイメージビルド]
    H -->|あり| J[コンテナ内でprekフック実行]
    I --> J
    J --> K{全フック成功?}
    K -->|はい| L[正常終了]
    K -->|いいえ| M[エラー出力・非0終了]
    L --> N[バッチ終了]
    M --> N
```

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

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

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

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

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | コマンド未検出 | docker-composeがPATHに存在しない | docker-composeをインストールする |
| 1 | コマンド未検出 | prekがPATHに存在しない | prekをインストールする |
| 非0終了 | Docker未起動 | Dockerデーモンが起動していない | Dockerデーモンを起動する |
| 非0終了 | フック失敗 | 1つ以上のフックが失敗 | 失敗フックの出力を確認し、コードを修正する |

### リトライ仕様

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

### 障害時対応

フック失敗時は、標準出力の結果を確認し、失敗フックを特定する。コンテナの状態は `docker-compose -p mruby ps` で確認可能。

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- Makefileでは `DOCKER_COMPOSE = docker-compose` および `PRE_COMMIT = prek` と定義されている
- docker-compose.ymlのtestサービスのデフォルトコマンドがprekコマンドでオーバーライドされる
- Rakefileにも同等の `rake composecheck` タスクが定義されている（`sh "docker-compose -p mruby run test prek run --all-files"`）
- Makefileのコメント `## run all prek hooks against all files with docker-compose` がhelpターゲットで表示される
