# バッチ設計書 11-ci_pre_xcodebuild

## 概要

本ドキュメントは、Xcode Cloud環境でのビルド前処理を実行するシェルスクリプト「ci_pre_xcodebuild」のバッチ設計書です。

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

このバッチはXcode Cloudの継続的インテグレーション（CI）環境において、Xcodeビルドが開始される前に必要な準備処理を自動的に実行します。主にBundle ID設定とテスト用ソースルートのコピー処理を担当し、CI/CD パイプラインの初期段階で確実にビルド環境を整えることで、後続のビルド・テスト処理の成功を支援します。

**業務上の目的・背景**：Wikipedia iOSアプリの開発において、Xcode Cloudを利用した自動ビルド・テスト環境を構築しています。しかし、オープンソースプロジェクトでは、各開発者が異なるApple Developer Team IDを持っているため、ビルド時に適切なBundle ID設定が必要です。また、テスト実行時にはソースルートのパス情報が必要となります。このバッチは、これらの環境依存の設定を自動化し、CI環境でのビルドを円滑に行うことを目的としています。

**バッチの実行タイミング**：Xcode Cloudワークフロー実行時、xcodebuildコマンド実行前に自動的にトリガーされます。

**主要な処理内容**：
1. Bundle ID設定スクリプト（setup_bundle_id）をCIモードで実行し、デフォルトのTeam IDを設定
2. 「Run Tests」ワークフローの場合、copy_sourceroot.shを実行してソースルートをコピー

**前後の処理との関連**：このバッチはXcode Cloudのビルドライフサイクルにおいて最初に実行されるスクリプトです。処理完了後、Xcodeによるビルド処理が開始され、ビルド完了後にci_post_xcodebuild.shが実行されます。

**影響範囲**：Configurations/OpenSourceDebug.xcconfig ファイル、およびテスト実行時の WikipediaUnitTests/Info.plist ファイルに影響します。

## バッチ種別

ビルドスクリプト / CI前処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（Xcode Cloud ワークフロー実行時） |
| 実行時刻 | 不定（CI トリガー時） |
| 実行曜日 | 不定 |
| 実行日 | 不定 |
| トリガー | Xcode Cloud ワークフロー開始イベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Xcode Cloud環境 | Xcode Cloud CI環境で実行されること |
| CI_WORKFLOW環境変数 | Xcode Cloudにより設定される環境変数が利用可能であること |
| scripts/setup_bundle_id | 上位ディレクトリにsetup_bundle_idスクリプトが存在すること |

### 実行可否判定

- CI_WORKFLOW が "Run Tests" の場合：Bundle ID設定後、copy_sourceroot.sh を実行
- その他のワークフローの場合：Bundle ID設定のみ実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| CI_WORKFLOW | 環境変数 | No | なし | Xcode Cloudが設定するワークフロー名 |
| CI_PRIMARY_REPOSITORY_PATH | 環境変数 | No | なし | リポジトリのルートパス（copy_sourceroot.shで使用） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 環境変数 | シェル環境変数 | Xcode Cloudが自動設定するCI環境変数 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Configurations/OpenSourceDebug.xcconfig | テキストファイル | Team ID設定ファイル |
| WikipediaUnitTests/Info.plist | plistファイル | テスト用ソースルート設定（Run Testsワークフロー時のみ） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | OpenSourceDebug.xcconfig |
| 出力先 | Configurations/ |
| 文字コード | UTF-8 |
| 区切り文字 | なし（xcconfig形式） |

## 処理フロー

### 処理シーケンス

```
1. スクリプト開始
   └─ set -e でエラー時停止を設定
2. Bundle ID設定
   └─ ../scripts/setup_bundle_id ci を実行
3. ワークフロー判定
   └─ CI_WORKFLOW が "Run Tests" かを確認
4. 条件分岐処理
   └─ Run Tests の場合: copy_sourceroot.sh を実行
   └─ その他の場合: 処理をスキップ
5. スクリプト終了
   └─ exit 0 で正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[set -e でエラー時停止設定]
    B --> C[setup_bundle_id ci 実行]
    C --> D{CI_WORKFLOW == Run Tests?}
    D -->|Yes| E[copy_sourceroot.sh 実行]
    D -->|No| F[スキップ]
    E --> G[正常終了 exit 0]
    F --> G
```

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

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

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

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

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | スクリプトエラー | setup_bundle_id失敗 | スクリプトの存在・実行権限を確認 |
| 非0 | スクリプトエラー | copy_sourceroot.sh失敗 | スクリプトの存在・実行権限を確認 |

### リトライ仕様

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

### 障害時対応

`set -e` によりエラー発生時は即座にスクリプトが停止します。Xcode Cloudのビルドログを確認し、失敗したコマンドを特定してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作のみ） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同一ワークフロー内で1回のみ実行されるため、排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | copy_sourceroot.sh実行時 | "Execute copy source root." |
| 進捗ログ | スキップ時 | なし（暗黙的にスキップ） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルドワークフロー失敗 | 1回 | Xcode Cloud通知設定による |

## 備考

- 本スクリプトはXcode Cloudの `ci_scripts` ディレクトリに配置される必要があります
- Xcode Cloudは `ci_pre_xcodebuild.sh` という命名規則に従ってスクリプトを自動検出・実行します
- デフォルトのTeam ID `AKK7J2GV64` はWikimedia Foundationの開発者チームIDです
