# バッチ設計書 22-koch.nim（xz）

## 概要

本ドキュメントは、Nimコンパイラのインストール用tar.xzパッケージを生成するバッチ処理「koch xz」の設計書です。kochコマンドのxzサブコマンドとして実行され、Unix/Linux/macOS向けの配布パッケージを作成します。

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

**業務上の目的・背景**：Nimコンパイラをユーザーに配布するためには、ソースコードベースのインストールパッケージが必要です。Unix系OSでは、tar.xz形式が標準的な配布形式として広く使用されています。本バッチは、Cソースコードを含むパッケージを作成し、ユーザーが任意の環境でNimコンパイラをビルド・インストールできるようにします。これにより、様々なUnix系OS（Linux、macOS、FreeBSD等）でNimを利用できます。

**バッチの実行タイミング**：リリース作業時（新バージョンの公開前）に手動で実行します。koch csource（Cソースコード生成）が完了した後に実行する必要があります。

**主要な処理内容**：
1. Gitリポジトリのクリーン状態確認（ensureCleanGit）
2. niminstによるスクリプト生成（build.sh, install.sh, makefile等）
3. Cソースコードとビルドスクリプトの収集
4. tar.xz形式でのアーカイブ作成

**前後の処理との関連**：
- 前提バッチ：koch csource（Cソースコード生成）が完了していること
- 後続バッチ：testinstall（パッケージのインストールテスト）、配布サーバへのアップロード

**影響範囲**：buildディレクトリ配下にtar.xzファイルが生成されます。Gitリポジトリの状態チェックにより、未コミットの変更がある場合は処理が中断されます。

## バッチ種別

パッケージ生成 / リリース処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（リリース時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Cソースコード | build/配下にCソースコードが生成済み（koch csource実行済み） |
| Gitクリーン状態 | git diffが空であること（未コミットの変更がないこと） |
| tar/gtar | tarまたはgtarコマンドが利用可能であること |
| xz | xzコマンドが利用可能であること |

### 実行可否判定

ensureCleanGit関数により、Gitリポジトリの状態をチェックします。`git diff`の出力が空でない場合、または`git diff`がエラーを返す場合は処理を中断します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --latest | フラグ | No | false | 最新版の依存パッケージを使用する場合に指定（xzでは未使用） |
| --stable | フラグ | No | true | 安定版の依存パッケージを使用（デフォルト）（xzでは未使用） |
| args | string | No | "" | niminstに渡す追加引数 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| compiler/installer.ini | INIファイル | インストーラ設定ファイル、パッケージに含めるファイル一覧を定義 |
| build/build.sh | シェルスクリプト | Cソースからのビルドスクリプト（csourceで生成） |
| build/c_code/ | ディレクトリ | プラットフォーム別Cソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build/nim-{version}.tar.xz | tar.xzアーカイブ | Nimコンパイラのインストール用ソースパッケージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nim-{version}.tar.xz（例：nim-2.0.0.tar.xz） |
| 出力先 | build/ |
| 文字コード | バイナリ |
| 圧縮形式 | tar.xz（LZMA2圧縮） |

## 処理フロー

### 処理シーケンス

```
1. ensureCleanGit()
   └─ git diffを実行し、出力が空であることを確認
   └─ 空でない場合はエラー終了

2. niminstスクリプト生成
   └─ nimexec("cc -r niminst scripts compiler/installer.ini")
   └─ compiler/installer.iniに基づきinstall.sh等を生成

3. niminst xz生成
   └─ exec("niminst xz compiler/installer.ini")
   └─ xzDistが呼び出される

4. xzDist処理（niminst内部）
   └─ 一時ディレクトリ(build/)に必要ファイルをコピー
   └─ build.sh, build.bat, makefile, install.sh, deinstall.shをコピー
   └─ c_code/配下のCソースファイルをコピー
   └─ 設定ファイル、ドキュメント、ライブラリをコピー
   └─ .nimbleファイルをコピー
   └─ gtar(またはtar)でtarアーカイブ作成
   └─ xz -9f でLZMA2圧縮
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Gitクリーン状態?}
    B -->|No| C[エラー終了]
    B -->|Yes| D[niminstスクリプト生成]
    D --> E[ファイル収集]
    E --> F[tarアーカイブ作成]
    F --> G[xz圧縮]
    G --> H[バッチ終了]
```

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

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

本バッチはデータベースを使用しません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Gitダーティ状態 | git diffで差分がある | 変更をコミットまたはstash |
| - | Cソース未生成 | build/build.shが存在しない | koch csource -d:danger を実行 |
| - | tar実行エラー | tarコマンドが失敗 | tarまたはgtarのインストールを確認 |
| - | xz実行エラー | xzコマンドが失敗 | xzのインストールを確認 |

### リトライ仕様

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

### 障害時対応

1. Gitダーティ状態の場合：変更をコミットするか`git stash`で退避
2. Cソース未生成の場合：`koch csource -d:danger`を先に実行
3. 外部ツールエラーの場合：tar、xzのインストール状態を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作のみ） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし（エラー時は中断、手動で再実行） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のリリースで1回実行 |
| 目標処理時間 | 数分（xz -9fの圧縮に時間がかかる） |
| メモリ使用量上限 | 特に制限なし（xz圧縮時にメモリを使用） |

## 排他制御

同時実行は想定していません。同一ディレクトリで複数のkoch xzを並列実行すると、build/配下のファイルが競合する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各処理実行時 | 実行中のコマンド（echo出力） |
| エラーログ | エラー発生時 | エラーメッセージ（quit呼び出し） |
| 警告ログ | 外部コマンド失敗時 | "External program failed" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | 手動実行のため自動監視なし |

## 備考

- Unix/Linux/macOS向けのソースベースパッケージ生成を目的としている
- パッケージにはCソースコードが含まれ、ユーザー側でビルドが必要
- xz -9fオプションにより最高圧縮率で圧縮される
- gtarがない場合は通常のtarにフォールバックする（--excludeオプションが使えない可能性あり）
- testinstallコマンドで生成パッケージのインストールテストが可能
- ensureCleanGitによりリリースビルドの再現性を確保
