# 機能設計書 383-Test-DbaBuild

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるTest-DbaBuild機能の設計仕様を記載する。本機能は、SQL Serverのビルドバージョンをパッチコンプライアンス要件に対してテストし、準拠状態を判定する。

### 本機能の処理概要

本機能は、SQL Serverインスタンスまたは指定されたビルドバージョンを組織のパッチポリシーに対して評価し、コンプライアンス状態を返す。サービスパックレベル、累積更新プログラム、参照KB、サポート終了日などの詳細情報と共にコンプライアンスフラグを提供する。

**業務上の目的・背景**：データベース管理者は、セキュリティや安定性の観点から、SQL Server環境全体のパッチレベルが組織の基準を満たしているかを定期的に確認する必要がある。手動での確認は時間がかかり、見落としのリスクもある。本機能により、複数インスタンスのパッチコンプライアンスを自動的に監査し、最低限のセキュリティパッチレベルを下回るインスタンスを特定できる。

**機能の利用シーン**：
- 月次パッチコンプライアンスレポートの作成
- アップグレード前の現状評価
- 最新パッチへの更新必要性の判定
- 相対的なパッチポリシー（"1SP遅れまで許容"等）の適用

**主要な処理内容**：
1. 対象ビルドバージョンの取得（直接指定またはSQL Serverインスタンスから）
2. ビルドリファレンスインデックスの読み込み
3. コンプライアンス基準（MinimumBuild/MaxBehind/Latest）に基づく評価
4. コンプライアンス結果とビルド情報の出力

**関連システム・外部連携**：SQL Serverビルドリファレンスデータベース（dbatools-buildref-index.json）を使用。-Updateオプションでオンラインから最新データを取得可能。

**権限による制御**：SQL Serverインスタンスへの接続時は適切な認証が必要。ビルド番号の直接指定時は権限不要。

## 関連画面

本機能はCLIベースのPowerShellコマンドレットであり、GUI画面との直接的な関連はない。

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール | 主画面 | コマンド実行とコンプライアンス結果表示 |

## 機能種別

コンプライアンステスト / 判定処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Build | version[] | No | テスト対象のビルドバージョン番号（直接指定） | major.minor.build形式 |
| MinimumBuild | version | No | コンプライアンス基準となる最低ビルドバージョン | MaxBehind/Latestと排他 |
| MaxBehind | string | No | 許容される最大遅延（例: "1SP", "2CU", "1SP 1CU"） | MaxBehindValidatorで検証 |
| Latest | switch | No | 最新ビルドであることを要求 | MinimumBuild/MaxBehindと排他 |
| SqlInstance | DbaInstanceParameter[] | No | テスト対象のSQL Serverインスタンス | パイプライン入力可 |
| SqlCredential | PSCredential | No | SQL Server接続用認証情報 | - |
| Update | switch | No | ビルドリファレンスデータの更新 | - |
| Quiet | switch | No | Boolean結果のみ出力 | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- パイプライン入力：SqlInstanceパラメータがValueFromPipelineをサポート
- ビルドリファレンス：dbatools-buildref-index.jsonファイル
- SQL Serverインスタンス：Get-DbaBuildを介してビルド情報を取得

## 出力仕様

### 出力データ（-Quiet未指定時）

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Build | version | テスト対象のビルドバージョン |
| MatchType | string | マッチ方法（"Exact"または"Approximate"） |
| Compliant | bool | コンプライアンス結果（$true/$false） |
| MinimumBuild | version | 最低ビルド基準（-MinimumBuild使用時） |
| MaxBehind | string | 許容遅延指定（-MaxBehind使用時） |
| SPTarget | string | 目標サービスパックレベル |
| CUTarget | string | 目標累積更新レベル |
| BuildTarget | version | コンプライアンス閾値となるビルドバージョン |
| SqlInstance | string | SQL Serverインスタンス名（-SqlInstance使用時） |

### 出力データ（-Quiet指定時）

| 項目名 | 型 | 説明 |
|--------|-----|------|
| - | bool | コンプライアンス結果のみ（$true/$false） |

### 出力先

PowerShellパイプラインへPSCustomObject（または-Quiet時はboolean）として出力。

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ MinimumBuild、MaxBehind、Latestの排他チェック
   └─ 少なくとも1つのコンプライアンス基準が必要
2. MaxBehindパラメータの解析
   └─ "1SP", "2CU"等の形式をパース
3. ビルドバージョン取得
   └─ Build指定時: 直接使用
   └─ SqlInstance指定時: Get-DbaBuildで取得
4. ビルドリファレンスインデックス読み込み
   └─ -Update指定時: オンラインから更新
5. 各ビルドバージョンに対してコンプライアンス評価
   └─ MinimumBuild: ビルド番号の直接比較
   └─ MaxBehind: SP/CUレベルの相対評価
   └─ Latest: 最新ビルドとの比較
6. 結果オブジェクト生成・出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{MinimumBuild/MaxBehind/Latest排他チェック}
    B -->|複数指定| C[エラー: 排他パラメータ]
    B -->|0個指定| D[エラー: 基準指定なし]
    B -->|1個指定| E{MaxBehind指定?}
    E -->|Yes| F[MaxBehind形式を解析]
    E -->|No| G[ビルドバージョン取得]
    F --> G
    G --> H{Build指定?}
    H -->|Yes| I[Get-DbaBuild -Build]
    H -->|No| J[Get-DbaBuild -SqlInstance]
    I --> K[ビルドリファレンス読み込み]
    J --> K
    K --> L[各ビルドをループ]
    L --> M{MinimumBuild?}
    M -->|Yes| N[ビルド番号比較]
    M -->|No| O{MaxBehind/Latest?}
    O -->|Yes| P[SP/CUレベル計算]
    N --> Q[Compliant判定]
    P --> Q
    Q --> R{Quiet?}
    R -->|Yes| S[Boolean出力]
    R -->|No| T[詳細オブジェクト出力]
    S --> U{次のビルドあり?}
    T --> U
    U -->|Yes| L
    U -->|No| V[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | コンプライアンス基準排他 | MinimumBuild、MaxBehind、Latestは相互排他 | 常時 |
| BR-002 | 基準必須 | 少なくとも1つのコンプライアンス基準が必要 | 常時 |
| BR-003 | MaxBehind形式 | "nSP"、"nCU"、"nSP nCU"形式で指定 | MaxBehind使用時 |
| BR-004 | SPデフォルト | MaxBehindでSP指定がない場合は0SP（現在のSP）として扱う | MaxBehindでCUのみ指定時 |
| BR-005 | Approximate警告 | 認識されないビルドバージョンは警告出力 | MatchType="Approximate"時 |

### 計算ロジック

**MinimumBuildコンプライアンス判定**:
```powershell
$compliant = ($inputbuild -ge $MinimumBuild)
```

**MaxBehind/Latest目標ビルド計算**:
1. 対象ビルドのメジャーバージョンでインデックスをフィルタ
2. SPとCUの組み合わせを列挙
3. MaxBehindで指定された遅延分をロールバック
4. 目標ビルドと比較してCompliant判定

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

本機能はSQL Serverシステムビューを照会する（Get-DbaBuildを介して）。

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ビルド取得 | システムビュー | SELECT | SQL Serverバージョン情報の取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| InvalidArgument | パラメータエラー | MinimumBuild/MaxBehind/Latestの複数指定 | 1つのみ指定 |
| InvalidArgument | パラメータエラー | コンプライアンス基準の未指定 | 1つを指定 |
| InvalidArgument | パラメータエラー | MaxBehindの形式不正 | "nSP"または"nCU"形式で指定 |
| - | 接続エラー | SQL Serverインスタンスへの接続失敗 | 認証情報・接続性を確認 |

### リトライ仕様

リトライ機能は実装されていない。

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

読み取り専用操作のため、トランザクション管理は不要。

## パフォーマンス要件

- ビルドリファレンスインデックスはローカルJSONファイルから読み込み
- 複数インスタンスの評価は順次処理
- -Updateオプション使用時はネットワーク遅延が発生

## セキュリティ考慮事項

- SQL Serverインスタンスへの接続にはSqlCredentialを使用可能
- ビルドリファレンスの更新はHTTPS経由

## 備考

- 登録済みサーバーとの連携が可能（Get-DbaRegServer | Test-DbaBuild）
- MatchType="Approximate"の場合、ビルドは認識されているが完全一致ではない
- Retiredフラグが立っているCUは目標から除外される

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | 出力オブジェクト構造（.OUTPUTS 63-93行目） |

**読解のコツ**: 出力プロパティはコンプライアンス基準（MinimumBuild/MaxBehind/Latest）によって異なる。hiddenPropsで動的に除外。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | パラメータ定義（149-162行目） |
| 2-2 | Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | beginブロック（164-217行目） |

**主要処理フロー**:
1. **164-173行目**: ビルドリファレンスインデックス取得の内部関数
2. **175-187行目**: コンプライアンス基準の排他チェック
3. **188-216行目**: MaxBehindパラメータの解析

#### Step 3: コア処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | ビルド取得（229-233行目） |
| 3-2 | Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | MinimumBuild評価（251-255行目） |
| 3-3 | Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | MaxBehind/Latest評価（256-313行目） |
| 3-4 | Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | 結果出力（314-325行目） |

**主要処理フロー**:
- **229-233行目**: Get-DbaBuildでビルド情報取得
- **251-255行目**: MinimumBuildとの単純比較
- **257-309行目**: SP/CUレベルの計算と目標ビルド特定
- **314-319行目**: 結果プロパティの追加
- **320-324行目**: Quietモードまたは詳細出力

### プログラム呼び出し階層図

```
Test-DbaBuild
    │
    ├─ Get-DbaBuildReferenceIndex (内部関数)
    │      └─ dbatools-buildref-index.json読み込み
    │
    ├─ Get-DbaBuild
    │      └─ SQL Serverビルド情報取得
    │
    ├─ Stop-Function (内部関数)
    │      └─ エラー処理
    │
    └─ Select-DefaultView
           └─ 表示プロパティ制御
```

### データフロー図

```
[入力]                    [処理]                       [出力]

Build/SqlInstance ───▶ Get-DbaBuild ───┐
                                       │
MinimumBuild ───────────────────────────┼──▶ コンプライアンス ──▶ PSCustomObject
                                       │    評価ロジック         │
MaxBehind ──────────────────────────────┤                        ├─ Build
                                       │                        ├─ Compliant
Latest ────────────────────────────────┤                        ├─ MatchType
                                       │                        └─ その他
ビルドリファレンス ─────────────────────┘
(JSON)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Test-DbaBuild.ps1 | `public/Test-DbaBuild.ps1` | ソース | メイン機能実装 |
| Test-DbaBuild.Tests.ps1 | `tests/Test-DbaBuild.Tests.ps1` | テスト | 単体テスト |
| dbatools-buildref-index.json | `bin/dbatools-buildref-index.json` | データ | ビルドリファレンス |
| Get-DbaBuild.ps1 | `public/Get-DbaBuild.ps1` | 依存 | ビルド情報取得 |
