# バッチ設計書 13-gh-actions-repl-3.ps1

## 概要

本ドキュメントは、GitHub Actions用のレプリケーションテストスクリプト（パート3）の設計内容を記載したバッチ設計書です。dbatoolsモジュールのSQL ServerレプリケーションにおけるSubscription（サブスクリプション）関連コマンドおよびパイプライン処理の統合テストを自動実行するためのPesterテストスクリプトについて説明します。

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

このバッチは、dbatoolsモジュールのSQL ServerレプリケーションにおけるSubscription関連コマンド（New-DbaReplSubscription、Get-DbaReplSubscription、Remove-DbaReplSubscription）およびパイプライン処理の統合テストを実行します。

**業務上の目的・背景**：SQL Serverレプリケーションでは、サブスクリプションによりパブリッシャーからサブスクライバーへのデータ配信を管理します。Push型・Pull型のサブスクリプション作成・取得・削除は、レプリケーション構成において不可欠な操作です。また、dbatoolsのコマンドはパイプライン処理をサポートしており、複数のコマンドを連携させた効率的な操作が可能です。本バッチは、これらの機能の品質を継続的に検証し、コード変更によるリグレッションを防止することを目的としています。

**バッチの実行タイミング**：GitHub Actionsワークフローの一部として、プルリクエスト作成時、mainブランチへのプッシュ時、または手動トリガー時に実行されます。

**主要な処理内容**：
1. テスト環境のセットアップ（SQL Server認証情報の設定、dbatoolsモジュールのインポート）
2. テスト用データベース（ReplDb）とテーブル（ReplicateMe、ReplicateMeToo）の作成
3. New-DbaReplSubscriptionコマンドのテスト（Push/Pullサブスクリプションの作成）
4. Get-DbaReplSubscriptionコマンドのテスト（各種条件でのサブスクリプション取得）
5. Remove-DbaReplSubscriptionコマンドのテスト（Push/Pullサブスクリプションの削除）
6. パイプライン処理のテスト（Connect-DbaInstance経由での各コマンド実行）

**前後の処理との関連**：本スクリプトはレプリケーションテストの3部構成のうちパート3（最終パート）です。パート1（gh-actions-repl-1.ps1）ではDistributor/Publisher/Publication関連コマンド、パート2（gh-actions-repl-2.ps1）ではArticle関連コマンドのテストを実行します。パート1およびパート2で作成されたレプリケーション環境を前提として動作します。

**影響範囲**：GitHub Actions CI/CD環境内のSQL Serverインスタンス（mssql1およびmssql2）に対して、サブスクリプションの作成・削除を行います。

## バッチ種別

統合テスト / CI/CDスクリプト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動 |
| 実行時刻 | N/A（イベント発生時） |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | GitHub Actions（プルリクエスト、プッシュ、手動実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| SQL Serverインスタンス（パブリッシャー） | mssql1という名前のSQL Serverインスタンスがアクセス可能であること |
| SQL Serverインスタンス（サブスクライバー） | mssql2という名前のSQL Serverインスタンスがアクセス可能であること |
| 認証情報 | sqladminユーザー（パスワード: dbatools.IO）でSQL Server認証が可能であること |
| 共有パス | /sharedディレクトリが存在し、アクセス可能であること |
| dbatoolsモジュール | ./dbatools.psd1が存在し、インポート可能であること |
| レプリケーション環境 | Distributor、Publisher、Publicationが設定済みであること |

### 実行可否判定

GitHub Actionsワークフローの設定に基づき、対象ブランチへのプッシュまたはプルリクエスト作成時に自動的に実行されます。手動実行も可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本スクリプトはパラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| dbatools.psd1 | PowerShellモジュール | テスト対象のdbatoolsモジュールマニフェスト |
| SQL Server mssql1 | データベースサーバー | パブリッシャーとして使用するSQL Serverインスタンス |
| SQL Server mssql2 | データベースサーバー | サブスクライバーとして使用するSQL Serverインスタンス |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | Pesterテスト結果（Pass/Fail/Skip） |
| GitHub Actions | テスト結果 | CI/CDパイプラインのテスト結果レポート |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | N/A（ファイル出力なし） |
| 出力先 | 標準出力のみ |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. BeforeAll: 環境セットアップ
   └─ SQL Server認証情報の作成（sqladmin/dbatools.IO）
   └─ PSDefaultParameterValuesの設定（SqlInstance、SqlCredential等）
   └─ dbatoolsモジュールのインポート
   └─ ReplDbデータベースの作成
   └─ テスト用テーブル（ReplicateMe、ReplicateMeToo）の作成

2. Subscription commands: サブスクリプションコマンドテスト
   └─ New-DbaReplSubscriptionテスト（Push/Pullサブスクリプション作成）
   └─ Get-DbaReplSubscriptionテスト（各種条件での取得）
   └─ Remove-DbaReplSubscriptionテスト（サブスクリプション削除）

3. Piping: パイプライン処理テスト
   └─ Connect-DbaInstance | Get-DbaReplPublisher テスト
   └─ Connect-DbaInstance | Get-DbaReplPublication テスト
   └─ Connect-DbaInstance | Get-DbaReplDistributor テスト
   └─ Connect-DbaInstance | Get-DbaReplArticle テスト
   └─ パイプライン経由でのRemove-DbaReplArticle テスト
   └─ パイプライン経由でのRemove-DbaReplPublication テスト
```

### フローチャート

```mermaid
flowchart TD
    A[テスト開始] --> B[BeforeAll: 環境セットアップ]
    B --> C[認証情報・モジュール準備]
    C --> D[ReplDb・テーブル作成]
    D --> E[Subscription commandsテスト]
    E --> F{New-DbaReplSubscriptionテスト}
    F -->|Skip| G[Get-DbaReplSubscriptionテスト]
    F -->|実行時| G
    G --> H[サブスクリプション取得確認]
    H --> I{Remove-DbaReplSubscriptionテスト}
    I -->|Skip| J[Pipingテスト]
    I -->|実行時| J
    J --> K[Connect-DbaInstance パイプテスト]
    K --> L[各コマンドのパイプ処理確認]
    L --> M[パイプ経由の削除テスト]
    M --> N[テスト終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| BeforeAll | ReplDb（データベース） | CREATE DATABASE | テスト用データベースの作成 |
| BeforeAll | ReplicateMe | CREATE TABLE | レプリケーションテスト用テーブルの作成 |
| BeforeAll | ReplicateMeToo | CREATE TABLE | レプリケーションテスト用テーブルの作成 |
| New-DbaReplSubscription | MSsubscriptions | INSERT | サブスクリプションメタデータの追加 |
| Remove-DbaReplSubscription | MSsubscriptions | DELETE | サブスクリプションメタデータの削除 |
| サブスクライバー側 | ReplDb, ReplDbTrans | CREATE DATABASE | サブスクリプション用データベースの作成 |

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

#### ReplDb.dbo.ReplicateMe

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| CREATE | id | int identity (1,1) PRIMARY KEY | 自動採番主キー |
| CREATE | col1 | varchar(10) | テスト用カラム |

#### ReplDb.dbo.ReplicateMeToo

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| CREATE | id | int identity (1,1) PRIMARY KEY | 自動採番主キー |
| CREATE | col1 | varchar(10) | テスト用カラム |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| PesterFailure | テスト失敗 | アサーションが失敗した場合 | テスト結果を確認し、対象コマンドを修正 |
| ConnectionError | 接続エラー | SQL Serverに接続できない場合 | SQL Serverインスタンスの起動状態を確認 |
| SubscriptionExistsError | 重複エラー | 同名サブスクリプションが既に存在する場合 | 既存サブスクリプションを削除してから実行 |
| NoArticlesError | アーティクルなしエラー | パブリケーションにアーティクルが存在しない場合 | アーティクルを追加してから実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | GitHub Actionsのジョブ設定に依存 |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A（Pesterテスト内でのリトライは行わない） |

### 障害時対応

テスト失敗時はGitHub Actionsのログを確認し、失敗したテストケースを特定します。個別のテストケースを手動で再実行し、問題の原因を調査します。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各テストケース単位（Pester BeforeAll/AfterAll） |
| コミットタイミング | 各dbatools コマンド実行後に自動コミット |
| ロールバック条件 | 明示的なロールバックは行わない（テスト後のクリーンアップで対応） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約25テストケース |
| 目標処理時間 | 5分以内 |
| メモリ使用量上限 | GitHub Actionsランナーのデフォルト制限に準拠 |

## 排他制御

GitHub Actionsのジョブレベルで排他制御されます。同一のSQL Serverインスタンスに対して複数のテストジョブが同時実行されないよう、ワークフローで制御されています。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | Describe開始時 | テストスイート名 |
| 進捗ログ | 各It実行時 | テストケース名と結果 |
| 終了ログ | Describe終了時 | テスト結果サマリー（Pass/Fail/Skip件数） |
| エラーログ | テスト失敗時 | 失敗したアサーションの詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト失敗 | 1件以上 | GitHub Actionsの通知設定に依存 |
| 処理時間 | 10分超過 | GitHub Actionsのタイムアウト設定 |

## 備考

- 本スクリプトはPester v5形式で記述されています
- テスト対象のSQL Serverインスタンスはmssql1（パブリッシャー）およびmssql2（サブスクライバー）で固定されています
- New-DbaReplSubscriptionおよびRemove-DbaReplSubscriptionのテストは-Skipフラグにより無効化されています（開発中の機能）
- Pull型サブスクリプションのテストにはTODOコメントが含まれており、修正が必要な状態です
- パイプライン処理のテストでは、PSDefaultParameterValuesをnullに設定してパイプラインの純粋な動作を検証しています
- レプリケーションテストは3つのスクリプト（repl-1, repl-2, repl-3）に分割されており、本スクリプトはパート3（最終パート）です
