# 機能設計書 289-Test-DbaEndpoint

## 概要

本ドキュメントは、SQL Server エンドポイントのネットワーク接続性をテストする Test-DbaEndpoint コマンドの機能設計書です。

### 本機能の処理概要

Test-DbaEndpoint は、SQL Server エンドポイントの TCP リスナーポートへの直接ソケット接続を試行し、ネットワークレベルでの到達性を検証する PowerShell コマンドです。

**業務上の目的・背景**：Database Mirroring、Service Broker、Availability Groups などの機能は、エンドポイントのポートへの TCP 接続が可能でなければ動作しません。本機能は、ファイアウォールルールの検証、ネットワーク設定の確認、高可用性セットアップ前の事前チェック、接続性問題のトラブルシューティングに不可欠な情報を提供します。TCP ポートと SSL ポートの両方をテストし、接続の成功または失敗を明確に報告します。

**機能の利用シーン**：
- Always On AG セットアップ前のネットワーク検証
- Database Mirroring の接続問題診断
- ファイアウォールルール適用後の接続確認
- エンドポイント構成変更後の疎通テスト
- 定期的な接続性監視

**主要な処理内容**：
1. テスト対象エンドポイントの特定（名前指定、パイプライン入力）
2. TCP リスナーポートの有無確認
3. TCP ソケット接続の試行
4. SSL ポート接続の試行（設定されている場合）
5. 接続結果のパイプライン出力

**関連システム・外部連携**：SQL Server からエンドポイント情報を取得し、System.Net.Sockets.TcpClient を使用して直接ソケット接続をテストします。

**権限による制御**：エンドポイント情報の取得には VIEW ANY DEFINITION 権限または sysadmin 権限が必要です。ネットワーク接続テスト自体には特別な権限は不要ですが、ネットワークアクセスが必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | SSMS Server Objects > Endpoints | 参照画面 | エンドポイント確認 |
| - | PowerShell Console | 主画面 | コマンド実行 |

## 機能種別

接続性テスト・診断操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象 SQL Server インスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Endpoint | string[] | No | テストするエンドポイント名 | - |
| InputObject | Microsoft.SqlServer.Management.Smo.Endpoint[] | No | パイプライン入力されたエンドポイントオブジェクト | - |
| EnableException | switch | No | 例外スロー有効化 | - |

### 入力データソース

- PowerShell コマンドライン引数
- Get-DbaEndpoint からのパイプライン入力
- SQL Server インスタンスのエンドポイントメタデータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Server ホスト名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| Endpoint | string | エンドポイント名 |
| Port | int | テストしたTCPポート番号 |
| Connection | string/Exception | TCP接続結果（"Success" または例外オブジェクト） |
| SslConnection | string/Exception | SSL接続結果（"Success", "None", または例外オブジェクト） |

### 出力先

PowerShell パイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. SqlInstance からエンドポイントを取得
   └─ Get-DbaEndpoint で対象を特定し InputObject に追加
2. 各エンドポイントに対してテスト処理
   ├─ TCP ListenerPort の有無確認
   │   └─ なし → スキップ（Verbose メッセージ出力）
   ├─ TCP 接続テスト
   │   ├─ TcpClient.Connect() 実行
   │   └─ 結果を Connection プロパティに設定
   ├─ SSL 接続テスト（SslPort が設定されている場合）
   │   ├─ TcpClient.Connect() 実行
   │   └─ 結果を SslConnection プロパティに設定
   └─ 結果オブジェクト出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SqlInstance ループ]
    B --> C[Get-DbaEndpoint で取得]
    C --> D[InputObject ループ開始]
    D --> E{TCP ListenerPort<br/>存在?}
    E -->|No| F[Verbose: ポートなし]
    E -->|Yes| G[TcpClient.Connect to TCP Port]
    G --> H{接続成功?}
    H -->|Yes| I[Connection = Success]
    H -->|No| J[Connection = Exception]
    I --> K{SslPort 存在?}
    J --> K
    K -->|Yes| L[TcpClient.Connect to SSL Port]
    K -->|No| M[SslConnection = None]
    L --> N{接続成功?}
    N -->|Yes| O[SslConnection = Success]
    N -->|No| P[SslConnection = Exception]
    O --> Q[結果オブジェクト出力]
    P --> Q
    M --> Q
    F --> D
    Q --> D
    D -->|完了| R[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | TCPポート必須 | ListenerPort がないエンドポイントはスキップ | 常時 |
| BR-002 | SSL オプショナル | SslPort が設定されていない場合は "None" を返す | 常時 |
| BR-003 | リソース解放 | TcpClient は使用後に Close() と Dispose() を呼び出し | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| エンドポイント情報取得 | sys.endpoints | SELECT | エンドポイント構成の参照 |

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

#### sys.endpoints

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name, protocol, port 等 | 全エンドポイント | SMO経由で取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続タイムアウト | ネットワーク到達不可 | ファイアウォール設定を確認 |
| - | 接続拒否 | ポートが閉じている | エンドポイントの状態を確認 |
| - | TCPポートなし | HTTP エンドポイント等 | TCP エンドポイントのみテスト可能 |

### リトライ仕様

リトライは実装されていません。接続失敗時は例外オブジェクトを Connection/SslConnection に設定します。

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

読み取り専用の診断操作のため、トランザクションは不要です。

## パフォーマンス要件

特に定義されていません。ネットワーク遅延と接続タイムアウトに依存します。

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

- エンドポイント情報の取得には VIEW ANY DEFINITION 権限が必要
- ネットワークテスト自体はソケット接続のみで、認証は行わない
- テスト結果に機密情報は含まれない

## 備考

- TCP リスナーポートがないエンドポイント（HTTP等）はスキップされる
- Verbose 出力でスキップ理由を確認可能
- TcpClient はテスト後に適切に破棄される

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Test-DbaEndpoint.ps1 | `public/Test-DbaEndpoint.ps1` | 136-144行目: 出力オブジェクトの構造 |

**読解のコツ**: PSCustomObject で ComputerName, InstanceName, SqlInstance, Endpoint, Port, Connection, SslConnection を出力していることを確認します。

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

パラメータ定義を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Test-DbaEndpoint.ps1 | `public/Test-DbaEndpoint.ps1` | パラメータ定義 |

**主要処理フロー**:
1. **91-99行目**: パラメータ定義（SqlInstance, Endpoint, InputObject 等）

#### Step 3: 接続テスト処理の実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Test-DbaEndpoint.ps1 | `public/Test-DbaEndpoint.ps1` | process ブロックのメインロジック |

**主要処理フロー**:
- **101-103行目**: Get-DbaEndpoint でエンドポイント取得
- **106-107行目**: TCP ListenerPort の存在確認
- **111-119行目**: TCP 接続テスト
- **121-134行目**: SSL 接続テスト

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

```
Test-DbaEndpoint
    │
    ├─ [SqlInstance] Get-DbaEndpoint
    │      └─ 対象エンドポイント取得
    │
    └─ foreach Endpoint
           │
           ├─ Check TCP ListenerPort
           │      └─ [なし] Write-Message (Verbose)
           │
           ├─ [TCP Test]
           │      ├─ New-Object TcpClient
           │      ├─ tcp.Connect(ComputerName, Port)
           │      ├─ tcp.Close()
           │      └─ tcp.Dispose()
           │
           ├─ [SSL Test] (if SslPort exists)
           │      ├─ New-Object TcpClient
           │      ├─ tcp.Connect(ComputerName, SslPort)
           │      ├─ tcp.Close()
           │      └─ tcp.Dispose()
           │
           └─ PSCustomObject 出力
```

### データフロー図

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

SqlInstance ────────┐
                    │
SqlCredential ──────┼──▶ Get-DbaEndpoint ──▶ InputObject
                    │           │
Endpoint ───────────┤           │
                    │           ▼
InputObject ────────┴──▶ foreach Endpoint
                                │
                                ├──▶ TCP ListenerPort 確認
                                │
                                ├──▶ TcpClient.Connect (TCP)
                                │         │
                                │         ▼
                                │    Success / Exception
                                │
                                ├──▶ TcpClient.Connect (SSL)
                                │         │
                                │         ▼
                                │    Success / None / Exception
                                │
                                └──▶ PSCustomObject ──▶ パイプライン出力
                                     (ComputerName, InstanceName,
                                      SqlInstance, Endpoint, Port,
                                      Connection, SslConnection)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Test-DbaEndpoint.ps1 | `public/Test-DbaEndpoint.ps1` | ソース | メイン関数実装 |
| Test-DbaEndpoint.Tests.ps1 | `tests/Test-DbaEndpoint.Tests.ps1` | テスト | ユニット・統合テスト |
| Get-DbaEndpoint.ps1 | `public/Get-DbaEndpoint.ps1` | ソース | エンドポイント取得（依存） |
| New-DbaEndpoint.ps1 | `public/New-DbaEndpoint.ps1` | ソース | エンドポイント作成（関連） |
| Start-DbaEndpoint.ps1 | `public/Start-DbaEndpoint.ps1` | ソース | エンドポイント開始（関連） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server 接続（依存） |
