# バッチ設計書 5-azure-pipelines.yml

## 概要

本ドキュメントは、Azure PipelinesのCI設定ファイル `azure-pipelines.yml` の設計仕様を定義するものである。

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

このバッチは、Azure Pipelinesを使用してNimコンパイラの継続的インテグレーション（CI）を実行する設定ファイルである。複数のプラットフォーム（Linux、macOS、Windows）でのビルド、テスト、パッケージ検証を自動的に実行する。

**業務上の目的・背景**：Nimコンパイラの品質を継続的に担保するため、コードの変更がリポジトリにプッシュされるたびに、複数のプラットフォームで自動的にビルドとテストを実行する必要がある。Azure Pipelinesを使用することで、Linux、macOS、Windowsの各環境での動作検証を自動化し、プラットフォーム固有の問題を早期に発見できる。

**バッチの実行タイミング**：
- `devel` ブランチへのプッシュ時
- `version-*` ブランチへのプッシュ時
- 全てのブランチへのプルリクエスト時

**主要な処理内容**：
1. `[skip ci]` コミットメッセージによるCIスキップ判定
2. Node.js 20.x のインストール
3. プラットフォーム固有の依存関係インストール（gcc、g++、各種ライブラリ）
4. csourcesからのNimコンパイラビルド
5. kochビルドとrunCI（テストスイート実行）

**前後の処理との関連**：このCIパイプラインは `ci/funs.sh` のユーティリティ関数に依存している。また、`config/build_config.txt` からcsourcesのバージョン情報を取得する。テスト実行には `koch runCI` コマンドを使用し、内部でtestamentテストフレームワークが実行される。

**影響範囲**：リポジトリへの全てのプッシュとプルリクエストに対してCIが実行される。テスト結果はAzure DevOpsのダッシュボードで確認可能。

## バッチ種別

CI/CD（継続的インテグレーション）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | コード変更時（プッシュ/PR時） |
| 実行時刻 | コード変更タイミング |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Git push / Pull Request |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Azure DevOps | Azure Pipelinesが有効化されていること |
| リポジトリ接続 | Azure DevOpsとGitHubリポジトリが連携されていること |
| エージェント | Microsoft提供のホステッドエージェントを使用 |

### 実行可否判定

- コミットメッセージに `[skip ci]` が含まれる場合、主要な処理がスキップされる
- `skipci` 変数で判定され、各ステップの `condition` で参照される

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| skipci | 変数 | No | false | CIスキップフラグ |
| vmImage | マトリクス | Yes | - | 使用するVMイメージ |
| CPU | マトリクス | Yes | - | ターゲットCPUアーキテクチャ |
| NIM_TESTAMENT_BATCH | マトリクス | No | - | テストバッチ番号（Windows用） |
| NIM_COMPILE_TO_CPP | マトリクス | No | - | C++コンパイルフラグ（OSX用） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/build_config.txt | テキスト | csourcesのバージョン情報 |
| ci/funs.sh | シェルスクリプト | ユーティリティ関数 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Azure DevOps | Webダッシュボード | ビルド/テスト結果 |
| ログ出力 | テキスト | 各ステップの実行ログ |

### 出力ファイル仕様

該当なし（CI結果はAzure DevOpsに出力）

## 処理フロー

### 処理シーケンス

```
1. 初期設定
   └─ Git autocrlf設定（Windows）
2. リポジトリチェックアウト
   └─ fetchDepth: 2
3. CIスキップ判定
   └─ nimIsCiSkip関数で判定
4. Node.jsインストール
   └─ Node.js 20.x
5. 依存関係インストール
   └─ プラットフォーム別のパッケージインストール
6. PATH設定
   └─ bin/ をPATHに追加
7. システム情報出力
   └─ nimCiSystemInfo関数
8. csourcesビルド
   └─ nimBuildCsourcesIfNeeded関数
9. kochビルドとCI実行
   └─ nimInternalBuildKochAndRunCI関数
```

### フローチャート

```mermaid
flowchart TD
    A[パイプライン開始] --> B{Windows?}
    B -->|Yes| C[Git autocrlf設定]
    B -->|No| D[リポジトリチェックアウト]
    C --> D
    D --> E[CIスキップ判定]
    E --> F{skipci?}
    F -->|Yes| G[パイプライン終了]
    F -->|No| H[Node.jsインストール]
    H --> I{Linux amd64?}
    I -->|Yes| J[Linux依存関係インストール]
    I -->|No| K{OSX?}
    K -->|Yes| L[OSX依存関係インストール]
    K -->|No| M{Windows?}
    M -->|Yes| N[Windows依存関係インストール]
    J --> O[PATH設定]
    L --> O
    N --> O
    O --> P[システム情報出力]
    P --> Q[csourcesビルド]
    Q --> R[koch, runCI実行]
    R --> G
```

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

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

該当なし（このバッチはデータベースを使用しない）

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ビルドエラー | コンパイル失敗 | ログを確認して修正 |
| 1 | テストエラー | テスト失敗 | ci_testresults.nimの出力を確認 |
| 1 | 依存関係エラー | パッケージインストール失敗 | CIを再実行 |
| タイムアウト | タイムアウト | 90分を超過 | 処理の最適化が必要 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Azure Pipelines設定に依存 |
| リトライ間隔 | 手動での再実行 |
| リトライ対象エラー | 一時的なネットワークエラー等 |

### 障害時対応

1. Azure DevOpsダッシュボードでログを確認
2. 失敗したステップを特定
3. `ci_testresults.nim` の出力を確認（テスト失敗の場合）
4. 必要に応じてローカルで再現テスト

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1パイプライン実行あたり複数ジョブ |
| 目標処理時間 | 90分以内（タイムアウト設定） |
| メモリ使用量上限 | Azure提供のホステッドエージェント依存 |

## 排他制御

- 各ジョブは独立して並列実行される
- ワークスペースはジョブ開始時にクリーンされる（`workspace: clean: all`）
- 同一PRに対する複数のパイプライン実行は独立して動作

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| システム情報 | パイプライン開始時 | nimCiSystemInfo（pwd, date, uname, git log, gcc -v, node -v, make -v） |
| コマンドログ | 各ステップ実行時 | echo_runによるコマンド出力 |
| テスト結果 | テスト完了時 | testament実行結果 |
| エラーログ | エラー発生時 | 失敗原因の詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ実行時間 | 90分 | パイプラインタイムアウト |
| ビルド成功率 | - | Azure DevOpsダッシュボード |

## 備考

### マトリクス構成

| プラットフォーム | vmImage | CPU | 備考 |
|-----------------|---------|-----|------|
| Linux amd64 | ubuntu-24.04 | amd64 | 標準Linux環境 |
| OSX arm64 | macos-15 | arm64 | Apple Silicon |
| OSX arm64 (C++) | macos-15 | arm64 | C++コンパイルテスト |
| Windows amd64 (batch 0/3) | windows-2025 | amd64 | テストバッチ0 |
| Windows amd64 (batch 1/3) | windows-2025 | amd64 | テストバッチ1 |
| Windows amd64 (batch 2/3) | windows-2025 | amd64 | テストバッチ2 |

### 依存関係一覧

| プラットフォーム | インストールパッケージ |
|-----------------|----------------------|
| Linux amd64 | gcc-14, g++-14, libpcre3, liblapack-dev, libcurl4-openssl-dev, libgc-dev, libsdl1.2-dev, libsfml-dev, valgrind, libc6-dbg |
| OSX | boehmgc, make, sfml |
| Windows | mingw64.7z, dlls.zip（nim-lang.org からダウンロード） |

### 注意事項

- Linux i386環境は現在無効化されている（bug #17325）
- `[skip ci]` はGitHub Actionsでは自動処理されるが、Azure Pipelinesでは明示的な判定が必要
- `SYSTEM_ACCESSTOKEN` が環境変数として設定される
