# バッチ設計書 24-CiAzureOSX

## 概要

本ドキュメントは、Avalonia UIフレームワークのNukeビルドシステムにおける「CiAzureOSX」ターゲットの設計を記述したものである。このターゲットは、Azure PipelinesのmacOS環境でのCI実行を担当し、パッケージ作成とZIP化を行う。

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

CiAzureOSXターゲットは、Azure PipelinesのmacOS環境で実行されるCI専用ターゲットである。パッケージ作成とZIPファイル生成を行い、macOS固有のネイティブライブラリ（Avalonia.Native）を含むパッケージを生成する重要な役割を担う。

**業務上の目的・背景**：Avalonia UIフレームワークのmacOS向けネイティブライブラリ（Avalonia.Native）はmacOS環境でのみビルド可能であり、CiAzureOSXターゲットはこのネイティブライブラリを含むNuGetパッケージを作成するために不可欠である。また、macOS環境でのクロスプラットフォーム互換性を検証する役割も担う。

**バッチの実行タイミング**：Azure Pipelinesでのプルリクエスト作成時、masterブランチへのマージ時、リリースブランチでのコミット時に自動実行される。

**主要な処理内容**：
1. Packageターゲットの実行
   - RunTests（全テストスイート実行）
   - CreateNugetPackages（NuGetパッケージ作成）
   - ValidateApiDiff（API差分検証）
2. ZipFilesターゲットの実行（成果物のZIP化）

**前後の処理との関連**：Compileターゲット、CompileNativeターゲット（macOS固有）に間接的に依存する。CiAzureLinux、CiAzureWindowsと並列に実行される。

**影響範囲**：NuGetパッケージがartifacts/nugetに、ZIPファイルがartifacts/zipに出力される。

## バッチ種別

CI/CD / パッケージ作成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CI/CD実行時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | Azure Pipelines（PR/マージ/コミット） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Azure Pipelines環境 | Azure Pipelinesのホステッドエージェント（macOS-latest等） |
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| Xcode | Avalonia.Nativeのビルドに必要 |
| ソースコード | リポジトリのクローンが完了していること |

### 実行可否判定

Azure PipelinesのmacOSジョブとして実行される場合にのみ使用される。CompileNativeターゲットはmacOS環境でのみ実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| configuration | string | No | Release | ビルド構成 |
| skip-tests | bool | No | false | trueの場合、テストをスキップする |
| force-nuget-version | string | No | SharedVersion.propsの値 | 強制的に指定するバージョン |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| dirs.proj | MSBuild | ソリューション定義 |
| native/Avalonia.Native | Xcode | macOS向けネイティブライブラリソース |
| src/Avalonia.Native/avn.idl | IDL | MicroCom インターフェース定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/nuget | .nupkg/.snupkg | NuGetパッケージ |
| artifacts/zip | .zip | ZIPアーカイブ |
| artifacts/test-results | TRX | テスト結果ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | Avalonia-NuGet-{version}.zip |
| 出力先 | artifacts/zip |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. Packageの実行
   └─ RunTests（テスト実行）
   └─ CreateNugetPackages（パッケージ作成）
      └─ CompileNative（macOSネイティブライブラリビルド）
   └─ ValidateApiDiff（API検証）
2. ZipFilesの実行
   └─ NuGetパッケージをZIPにアーカイブ
```

### フローチャート

```mermaid
flowchart TD
    A[CiAzureOSX開始] --> B[Package]
    B --> C[RunTests]
    C --> D[CreateNugetPackages]
    D --> E[CompileNative/Xcode]
    E --> F[ValidateApiDiff]
    F --> G[ZipFiles]
    G --> H[artifacts/zip出力]
    H --> I[CiAzureOSX完了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Xcodeビルド失敗 | Avalonia.Nativeのコンパイルエラー | ネイティブコードの修正 |
| - | テスト失敗 | テストケースがアサーションに失敗 | テストコードまたは対象コードの修正 |
| - | パッケージ作成失敗 | NuGet/numerge設定エラー | 設定ファイルの確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（Azure Pipelinesの設定に依存） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

失敗時はAzure Pipelinesのジョブが失敗となる。エラーメッセージを確認し、該当する問題（Xcodeビルド、テスト、パッケージ作成）を修正後、再度パイプラインを実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 複数のNuGetパッケージ |
| 目標処理時間 | 数十分 |
| メモリ使用量上限 | Azure Pipelinesホステッドエージェントの制限に依存 |

## 排他制御

Azure Pipelinesのジョブ管理により制御される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド初期化時 | バージョン情報、構成情報、プラットフォーム情報 |
| 進捗ログ | 各ターゲット実行時 | ターゲット名、処理状況 |
| Xcodeログ | ネイティブビルド時 | xcodebuildの出力 |
| 終了ログ | 完了時 | 成功/失敗ステータス |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルド失敗 | 発生時 | Azure Pipelines |
| ジョブタイムアウト | Azure Pipelinesの設定値 | Azure Pipelines |

## 備考

- CiAzureOSXはmacOS固有のネイティブライブラリ（Avalonia.Native）をビルドできる唯一のCIターゲット
- CompileNativeターゲットはXcodeを使用してAvalonia.Native.OSX.xcodeproj をビルド
- macOS環境ではRunLeakTestsはスキップされる（Windowsのみ）
- ZipFilesターゲットにより、NuGetパッケージがZIPアーカイブとして保存される
