# バッチ設計書 11-gh-actions-repl-1.ps1

## 概要

本ドキュメントは、GitHub Actions用のレプリケーションテストスクリプト（パート1）の設計内容を記載したバッチ設計書です。dbatoolsモジュールのSQL Serverレプリケーション機能に関する統合テストを自動実行するためのPesterテストスクリプトについて説明します。

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

このバッチは、dbatoolsモジュールのSQL Serverレプリケーション機能（Distributor、Publisher、Publication関連コマンド）の統合テストを実行します。

**業務上の目的・背景**：SQL Serverのレプリケーション機能は、データベース間のデータ同期において重要な役割を果たします。dbatoolsモジュールが提供するレプリケーション関連コマンド（Get-DbaReplServer、Enable-DbaReplDistributor、Get-DbaReplPublisher等）の品質を保証するため、継続的インテグレーション環境での自動テストが必要です。本バッチは、GitHub Actionsのワークフロー内でこれらのコマンドが正しく動作することを検証し、コード変更によるリグレッションを早期に検出することを目的としています。

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

**主要な処理内容**：
1. テスト環境のセットアップ（SQL Server認証情報の設定、dbatoolsモジュールのインポート）
2. テスト用データベース（ReplDb）とテーブル（ReplicateMe、ReplicateMeToo）の作成
3. Get-DbaReplServerコマンドのテスト実行（ReplicationObjectの取得確認）
4. Distributor関連コマンドのテスト（Get-DbaReplDistributor、Enable-DbaReplDistributor、Disable-DbaReplDistributor）
5. Publisher関連コマンドのテスト（Get-DbaReplPublisher、Enable-DbaReplPublishing、Disable-DbaReplPublishing）
6. Publication関連コマンドのテスト（Get-DbaReplPublication、New-DbaReplPublication、Remove-DbaReplPublication）

**前後の処理との関連**：本スクリプトはレプリケーションテストの3部構成のうちパート1です。パート2（gh-actions-repl-2.ps1）ではArticle関連コマンド、パート3（gh-actions-repl-3.ps1）ではSubscription関連コマンドのテストを実行します。

**影響範囲**：GitHub Actions CI/CD環境内のSQL Serverインスタンス（mssql1）に対してレプリケーション設定の有効化・無効化を行います。テスト完了後、環境は変更された状態で残る可能性があります。

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| SQL Serverインスタンス | mssql1という名前のSQL Serverインスタンスがアクセス可能であること |
| 認証情報 | sqladminユーザー（パスワード: dbatools.IO）でSQL Server認証が可能であること |
| 共有パス | /sharedディレクトリが存在し、アクセス可能であること |
| dbatoolsモジュール | ./dbatools.psd1が存在し、インポート可能であること |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| dbatools.psd1 | PowerShellモジュール | テスト対象のdbatoolsモジュールマニフェスト |
| SQL Server mssql1 | データベースサーバー | テスト対象の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. General commands: 基本コマンドテスト
   └─ Get-DbaReplServerの動作確認
   └─ ReplicationObjectの型検証
   └─ プロパティ値の検証（SqlInstance、DistributorInstalled等）

3. Publishing/Distribution commands: 配布/発行コマンドテスト
   └─ Get-DbaReplDistributorのテスト
   └─ Enable-DbaReplDistributorのテスト（デフォルト/指定DB名）
   └─ Disable-DbaReplDistributorのテスト
   └─ Get-DbaReplPublisherのテスト
   └─ Enable-DbaReplPublishingのテスト
   └─ Disable-DbaReplPublishingのテスト

4. Publication commands: パブリケーションコマンドテスト
   └─ Get-DbaReplPublicationのテスト
   └─ New-DbaReplPublicationのテスト（Transactional/Snapshot/Merge）
   └─ Remove-DbaReplPublicationのテスト
```

### フローチャート

```mermaid
flowchart TD
    A[テスト開始] --> B[BeforeAll: 環境セットアップ]
    B --> C[認証情報作成]
    C --> D[PSDefaultParameterValues設定]
    D --> E[dbatoolsモジュールインポート]
    E --> F[ReplDbデータベース作成]
    F --> G[テーブル作成]
    G --> H[General commandsテスト]
    H --> I[Get-DbaReplServerテスト]
    I --> J[Publishing/Distribution commandsテスト]
    J --> K[Distributorテスト]
    K --> L[Publisherテスト]
    L --> M[Publication commandsテスト]
    M --> N[Get-DbaReplPublicationテスト]
    N --> O[New-DbaReplPublicationテスト]
    O --> P[Remove-DbaReplPublicationテスト]
    P --> Q[テスト終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| BeforeAll | ReplDb（データベース） | CREATE DATABASE | テスト用データベースの作成 |
| BeforeAll | ReplicateMe | CREATE TABLE | レプリケーションテスト用テーブルの作成 |
| BeforeAll | ReplicateMeToo | CREATE TABLE | レプリケーションテスト用テーブルの作成 |
| Distributorテスト | distribution | CREATE/DROP DATABASE | ディストリビューションデータベースの作成・削除 |
| Publicationテスト | syspublications | INSERT/DELETE | パブリケーションメタデータの操作 |

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

#### 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インスタンスの起動状態を確認 |
| ModuleImportError | モジュールエラー | dbatoolsモジュールのインポートに失敗した場合 | モジュールのパスと依存関係を確認 |

### リトライ仕様

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

### 障害時対応

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

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- 本スクリプトはPester v5形式で記述されています
- テスト対象のSQL Serverインスタンス名はmssql1で固定されています
- 一部のテストケースは-Skipフラグにより無効化されています（開発中の機能）
- レプリケーションテストは3つのスクリプト（repl-1, repl-2, repl-3）に分割されており、本スクリプトはパート1です
