# バッチ設計書 48-SetupNugetSources.sh

## 概要

本ドキュメントは、NuGetソース設定スクリプト（SetupNugetSources.sh）の設計仕様を記載したものです。このスクリプトは、内部ビルドで必要なNuGetパッケージソースの追加と認証設定を自動化します。

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

このバッチは、NuGet.configファイルを解析して公開フィードの存在を確認し、対応する内部フィードを自動的に追加します。また、Maestro（darc-int-*）による無効化されたフィードを有効化し、必要に応じて認証情報を設定します。

**業務上の目的・背景**：.NETの内部ビルドでは、公開パッケージフィードに加えて内部限定のパッケージフィードからの依存関係取得が必要な場合があります。公開フィード（例：dotnet6）が存在する場合、対応する内部フィード（dotnet6-internal、dotnet6-internal-transport）を自動追加することで、ビルド構成を簡素化します。また、Maestro依存関係管理で生成されるdarc-int-*フィードの有効化も行います。

**バッチの実行タイミング**：CI/CDパイプラインの初期段階（NuGetAuthenticateタスクの前）で実行されます。

**主要な処理内容**：
1. NuGet.configの存在確認
2. darc-int-*（Maestro）フィードの有効化（disabledPackageSourcesセクションから削除）
3. dotnetX公開フィードに対応する内部フィードの追加
4. dotnet-eng、dotnet-toolsの内部フィードの追加
5. 認証情報の設定（CredTokenが指定された場合）

**前後の処理との関連**：tools.shに依存しています。このスクリプトの実行後にNuGetAuthenticateタスクを実行することで、追加されたフィードへの認証が完了します。

**影響範囲**：NuGet.configファイルの内容を変更します。バックアップファイル（.bak）が作成されます。

## バッチ種別

NuGet設定 / パッケージソース管理 / 認証設定

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | ビルド時に1回 |
| 実行時刻 | CI/CDパイプラインの初期段階 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Azure DevOpsパイプラインのBashタスクとして実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| NuGet.configの存在 | 第1引数で指定されたパスにNuGet.configが存在 |
| packageSourcesセクション | NuGet.config内にpackageSourcesセクションが存在 |
| sedコマンド | テキスト置換用（macOS/Linux両対応） |
| grepコマンド | パターン検索用 |

### 実行可否判定

- NuGet.configが存在しない場合はエラー終了
- packageSourcesセクションが存在しない場合はエラー終了

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $1 (ConfigFile) | string | Yes | なし | NuGet.configのパス |
| $2 (CredToken) | string | No | なし | 内部フィード認証用トークン |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| NuGet.config | XML | NuGetパッケージソース設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| NuGet.config | XML | 更新されたNuGet設定ファイル |
| NuGet.config.bak | XML | sedによるバックアップファイル |
| 標準出力 | テキスト | 処理進捗メッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | NuGet.config（入力と同じ） |
| 出力先 | 入力と同じパス |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. 引数の取得
   └─ ConfigFile、CredToken
2. NuGet.configの存在確認
   └─ 存在しない場合はエラー終了
3. packageSourcesセクションの確認
   └─ 存在しない場合はエラー終了
4. フィードサフィックスの設定
   └─ CredToken有無でv3/index.json または v2を選択
5. packageSourceCredentialsセクションの追加（CredToken指定時）
   └─ 存在しない場合は新規追加
6. darc-int-*フィードの有効化
   └─ disabledPackageSourcesから削除
7. dotnetXフィードの処理
   └─ dotnet5〜dotnet10の存在確認
   └─ 内部フィードの追加または有効化
8. dotnet-eng/dotnet-toolsフィードの処理
   └─ 内部フィードの追加または有効化
9. 認証情報の設定（CredToken指定時）
   └─ 各フィードに対してUsername/ClearTextPasswordを設定
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{NuGet.config存在?}
    B -->|なし| C[エラー終了]
    B -->|あり| D{packageSources存在?}
    D -->|なし| C
    D -->|あり| E{CredToken指定?}
    E -->|あり| F[FeedSuffix=v2]
    E -->|なし| G[FeedSuffix=v3/index.json]
    F --> H[packageSourceCredentials追加]
    G --> I[darc-int-*フィード有効化]
    H --> I
    I --> J[dotnet5-10フィード処理]
    J --> K[dotnet-eng/tools処理]
    K --> L{CredToken指定?}
    L -->|あり| M[認証情報設定]
    L -->|なし| N[正常終了]
    M --> N
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | - | - | このバッチはデータベース操作を行いません |

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

このバッチはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | NuGet.config not found | 指定パスにファイルが存在しない | 正しいパスを指定 |
| 1 | packageSources missing | NuGet.configにpackageSourcesがない | NuGet.configの形式を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. NuGet.configのパスと内容を確認
3. バックアップファイル（.bak）から復元可能

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | .bakファイルから手動復元 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十フィード |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | 特になし |

## 排他制御

NuGet.configファイルへの同時書き込みを避けてください。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | フィード有効化時 | "Enabling internal source '{name}'" |
| 情報ログ | フィード追加時 | "Adding package source {name}" |
| 情報ログ | フィード既存時 | "Package source {name} already present and enabled" |
| 情報ログ | 認証設定時 | "Inserting credential for feed: {name}" |
| 情報ログ | darc-int確認時 | "Checking for any darc-int disabled package sources..." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプラインの失敗通知 |

## 備考

- 対応するフィードのマッピング：
  - dotnet5 → dotnet5-internal, dotnet5-internal-transport
  - dotnet6 → dotnet6-internal, dotnet6-internal-transport
  - dotnet7 → dotnet7-internal, dotnet7-internal-transport
  - dotnet8 → dotnet8-internal, dotnet8-internal-transport
  - dotnet9 → dotnet9-internal, dotnet9-internal-transport
  - dotnet10 → dotnet10-internal, dotnet10-internal-transport
  - dotnet-eng → dotnet-eng-internal
  - dotnet-tools → dotnet-tools-internal
- 内部フィードのURL形式：https://pkgs.dev.azure.com/dnceng/internal/_packaging/{feed}/nuget/{suffix}
- macOSとLinuxで改行処理が異なるため、プラットフォーム検出を行っています
- NuGetAuthenticateタスクはこのスクリプトの後に実行する必要があります
- このスクリプトはenable-internal-sources.ymlテンプレートで抽象化されています
