# バッチ設計書 7-gh-actions.ps1

## 概要

本ドキュメントは、GitHub Actions用のLinux統合テストスクリプト「gh-actions.ps1」の設計仕様を記載したものである。

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

本スクリプトは、GitHub ActionsのCI/CDパイプラインでLinux環境上のdbatoolsモジュールの統合テストを実行するPesterテストスクリプトである。Docker上で動作するSQL Serverインスタンスに対して、データベースマイグレーション、DAC Package公開、ミラーリング設定、Azure接続など、様々なdbatools機能の統合テストを実行する。

**業務上の目的・背景**：dbatoolsモジュールはクロスプラットフォーム対応を目指しており、Linux環境でも正常に動作することを保証する必要がある。本スクリプトは、GitHub ActionsのCI/CDパイプラインの一部として自動実行され、プルリクエストやコミット時にLinux環境での動作を検証する。マイグレーション、DAC Package、ミラーリング、Azure接続など、dbatoolsの主要機能がLinux上で正常に動作することを確認し、リグレッションを防止する。

**バッチの実行タイミング**：GitHub Actionsワークフローにより、プルリクエスト時やmainブランチへのプッシュ時に自動実行される。

**主要な処理内容**：
1. テスト環境のセットアップ（認証情報、デフォルトパラメータの設定）
2. Start-DbaMigrationによるデータベースマイグレーションテスト
3. Publish-DbaDacPackageによるDAC Packageデプロイテスト
4. Invoke-DbaDbMirroringによるミラーリング設定テスト
5. Get-DbaUserPermissionによるユーザー権限取得テスト
6. ConvertTo-DbaXESessionによるXEセッション変換テスト
7. Azure SQL Database接続テスト（Connect-DbaInstance）
8. Azure Blob Storageへのログシッピングテスト
9. その他各種dbatoolsコマンドのテスト

**前後の処理との関連**：GitHub Actionsワークフローにより、Dockerコンテナ上のSQL Serverインスタンスが事前に起動される。本スクリプトはそのSQL Serverインスタンスに接続してテストを実行する。

**影響範囲**：CI/CDパイプラインの品質保証に影響する。テスト失敗時はプルリクエストのマージがブロックされる。

## バッチ種別

CI/CD / 統合テスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動（PR/プッシュ時） |
| 実行時刻 | 該当なし |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | GitHub Actions（pull_request, push） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actions環境 | Linux runnerで実行 |
| Docker | SQL Serverコンテナが起動済み |
| dbatoolsモジュール | インストール済み |
| 環境変数 | CLIENTID, CLIENTSECRET, TENANTID等が設定済み |

### 実行可否判定

GitHub Actionsワークフローの条件に従う。テスト対象のタグ（IntegrationTests）で制御可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 環境変数からパラメータを取得 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 環境変数 CLIENTID | 文字列 | Azure Service Principal Client ID |
| 環境変数 CLIENTSECRET | 文字列 | Azure Service Principal Client Secret |
| 環境変数 TENANTID | 文字列 | Azure Tenant ID |
| 環境変数 azurepasswd | 文字列 | Azure Blob Storage SASトークン |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Pesterテスト結果 | コンソール出力 | テスト成功/失敗の詳細 |
| GitHub Actions | ステータス | ワークフローの成功/失敗 |

### 出力ファイル仕様

本スクリプトは直接ファイル出力を行わない（Pesterフレームワークによるレポート出力は別途設定可能）。

## 処理フロー

### 処理シーケンス

```
1. BeforeAll: テスト環境セットアップ
   ├─ 認証情報の作成（sqladmin/dbatools.IO）
   ├─ PSDefaultParameterValuesの設定
   ├─ SharedPathの設定（/shared）
   └─ dbatoolsモジュールのインポート
2. It "migrates": マイグレーションテスト
   ├─ 証明書作成
   ├─ Start-DbaMigration実行
   └─ 結果検証（Northwindデータベース、証明書）
3. It "publishes a package": DAC Packageテスト
   ├─ テストデータベース作成
   ├─ テーブル・データ作成
   ├─ Export-DbaDacPackage実行
   ├─ Publish-DbaDacPackage実行
   └─ 結果検証
4. It "sets up a mirror": ミラーリングテスト
   ├─ データベース作成
   ├─ Invoke-DbaDbMirroring実行
   └─ 結果検証
5. It "gets some permissions": 権限取得テスト
6. It "converts to an XE Session": XEセッション変換テスト
7. It "connects to Azure": Azure接続テスト
8. It "gets a database from Azure": Azureデータベース取得テスト
9. It "sets up log shipping to Azure blob storage": ログシッピングテスト（オプション）
10. その他各種テスト
```

### フローチャート

```mermaid
flowchart TD
    A[テスト開始] --> B[BeforeAll: 環境セットアップ]
    B --> C[マイグレーションテスト]
    C --> D[DAC Packageテスト]
    D --> E[ミラーリングテスト]
    E --> F[権限取得テスト]
    F --> G[XEセッション変換テスト]
    G --> H[Azure接続テスト]
    H --> I[ログシッピングテスト]
    I --> J[その他テスト]
    J --> K[テスト終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| マイグレーションテスト | 複数 | INSERT/UPDATE/DELETE | Start-DbaMigrationによるオブジェクト移行 |
| DAC Packageテスト | dbo.example | INSERT | テストデータ挿入 |
| ミラーリングテスト | - | CREATE DATABASE | テストデータベース作成 |
| 権限テスト | - | CREATE USER/ROLE | テストユーザー・ロール作成 |
| XEセッションテスト | sp_trace_* | EXEC | トレース作成・変換 |

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

#### dbo.example（DAC Packageテスト用）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| CREATE TABLE | id | int PRIMARY KEY | テストテーブル |
| INSERT | id | top 100 object_id | sys.objectsから取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | テスト失敗 | Should条件を満たさない | Pesterがテスト失敗を報告 |
| - | 接続エラー | SQL Serverに接続できない | テスト失敗、ワークフロー失敗 |
| - | Azure接続エラー | 認証情報が無効 | テスト失敗 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（ワークフローレベルで再実行可能） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

テスト失敗時はGitHub Actionsワークフローが失敗ステータスになり、プルリクエストのマージがブロックされる。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | テスト個別（各テスト独立） |
| コミットタイミング | 各テスト終了時 |
| ロールバック条件 | テスト失敗時も明示的なロールバックなし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約20テストケース |
| 目標処理時間 | 10分以内 |
| メモリ使用量上限 | GitHub Actions runner制限内 |

## 排他制御

GitHub Actionsにより、同一PRに対する複数の同時実行は通常制限される。テスト間で使用するデータベース名は動的に生成され、競合を回避する。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| Pester出力 | テスト実行時 | テスト名、結果、所要時間 |
| デバッグ出力 | エラー発生時 | 詳細エラー情報（ログシッピングテスト等） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト失敗 | 1件以上 | GitHub PR/コミットステータス |
| ワークフロー時間 | タイムアウト設定 | GitHub Actions |

## 備考

- 本スクリプトは.github/scripts/配下に配置されている
- Pester Describeブロック形式のテストスクリプト
- Docker上のSQL Serverインスタンス（localhost, localhost:14333）を使用
- Azure接続テストには環境変数（CLIENTID, CLIENTSECRET, TENANTID）が必要
- ログシッピングテストは環境変数azurepasswdが設定されている場合のみ実行
- 一部テストはアーキテクチャ（arm64等）により-Skip指定

### テスト一覧

| テスト名 | 対象機能 | 備考 |
|---------|---------|------|
| migrates | Start-DbaMigration | データベースオブジェクト移行 |
| publishes a package | Export/Publish-DbaDacPackage | DAC Package操作 |
| sets up a mirror | Invoke-DbaDbMirroring | ミラーリング設定 |
| gets some permissions | Get-DbaUserPermission | ユーザー権限取得 |
| attempts to balance | Invoke-DbaBalanceDataFiles | データファイルバランシング |
| converts to an XE Session | ConvertTo-DbaXESession | トレース→XEセッション変換 |
| installs darling data | Install-DbaDarlingData | サードパーティスクリプトインストール |
| tests the instance name | Test-DbaInstanceName | インスタンス名検証 |
| creates a new database user | New-DbaDbUser | データベースユーザー作成 |
| returns some permission | Get-DbaPermission | 権限取得 |
| stops an xe session | Stop-DbaXESession | XEセッション停止 |
| tests tempdb configs | Test-DbaTempDbConfig | tempdb構成テスト |
| creates a snapshot | New-DbaDbSnapshot | スナップショット作成 |
| gets an XE template on Linux | Get-DbaXESessionTemplate | XEテンプレート取得 |
| copies a certificate | Copy-DbaDbCertificate | 証明書コピー |
| connects to Azure | Connect-DbaInstance | Azure SQL Database接続 |
| gets a database from Azure | Get-DbaDatabase | Azure上のデータベース取得 |
| sets up log shipping to Azure blob storage | Invoke-DbaDbLogShipping | Azureログシッピング |
| tests Get-DbaLastGoodCheckDb against Azure | Get-DbaLastGoodCheckDb | Azure上でのCHECKDB確認 |
