# バッチ設計書 9-gh-macactions.ps1

## 概要

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

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

本スクリプトは、GitHub ActionsのCI/CDパイプラインでmacOS環境上のdbatoolsモジュールの統合テストを実行するPesterテストスクリプトである。macOS上ではSQL Serverのローカルインスタンスが利用できないため、主にAzure SQL Databaseへの接続テストと、SQL Server非依存の機能テストを実行する最小限のテストセットとなっている。

**業務上の目的・背景**：dbatoolsモジュールはクロスプラットフォーム対応を目指しており、macOS環境でも正常に動作することを保証する必要がある。macOSではSQL Serverのローカルインスタンスを実行できないため、Azure SQL Databaseへの接続テストとオフライン機能（DAC Options作成など）のテストに限定される。本スクリプトは、macOS固有の問題（.NET Core互換性、ライブラリパス等）を検出し、クロスプラットフォーム品質を確保する。

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

**主要な処理内容**：
1. dbatoolsモジュールのインポート
2. New-DbaDacOptionによるDACオプションオブジェクト作成テスト
3. Azure SQL Database接続テスト（Service Principal認証、接続文字列認証）
4. Get-DbaDatabase によるAzureデータベース取得テスト

**前後の処理との関連**：GitHub Actionsワークフローにより、macOS runnerが準備される。SQL Serverのローカルインスタンスは使用しない。

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

## バッチ種別

CI/CD / 統合テスト（最小セット）

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actions環境 | macOS runnerで実行 |
| PowerShell Core | PowerShell 7.x以上 |
| 環境変数 | CLIENTID, CLIENTSECRET, TENANTID等が設定済み |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

本スクリプトは直接ファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. BeforeAll: テスト環境セットアップ
   └─ dbatoolsモジュールのインポート
2. It "creates a dac object": DACオプションテスト
   ├─ New-DbaDacOption -Action Export
   ├─ ExtractAllTableData = $true設定
   └─ 結果検証（オブジェクト存在確認）
3. It "connects to Azure": Azure接続テスト
   ├─ Service Principal認証
   └─ 接続文字列認証
4. It "gets a database from Azure": Azureデータベース取得テスト
   └─ Get-DbaDatabase実行
```

### フローチャート

```mermaid
flowchart TD
    A[テスト開始] --> B[BeforeAll: dbatoolsインポート]
    B --> C[DACオプション作成テスト]
    C --> D[Azure接続テスト]
    D --> E[Azureデータベース取得テスト]
    E --> F[テスト終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| Azure接続テスト | - | 接続のみ | 接続確立の確認 |
| データベース取得テスト | - | SELECT | sys.databasesへの問い合わせ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | テスト失敗 | Should条件を満たさない | Pesterがテスト失敗を報告 |
| - | モジュールロードエラー | dbatools/dbatools.libraryがない | テスト失敗 |
| - | Azure接続エラー | 認証情報が無効 | テスト失敗 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

テスト失敗時はGitHub Actionsワークフローが失敗ステータスになる。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（読み取り専用） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

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

## 排他制御

GitHub Actionsにより同一PRへの同時実行は制限される。Azure SQL Databaseへの接続は読み取り専用のため、競合は発生しない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| Pester出力 | テスト実行時 | テスト名、結果、所要時間 |
| Warning | モジュールインポート時 | ソースからのインポート警告 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト失敗 | 1件以上 | GitHub PR/コミットステータス |

## 備考

- 本スクリプトは.github/scripts/配下に配置されている
- macOSではSQL Serverのローカルインスタンスが利用できないため、最小限のテストセット
- DACオプション作成テストはSQL Server非依存で実行可能
- Azure接続テストでdbatoolsのネットワーク機能を検証
- dbatools.libraryとdbatoolsの両方をインポート

### テスト一覧

| テスト名 | 対象機能 | SQL Server必要 | 備考 |
|---------|---------|---------------|------|
| creates a dac object | New-DbaDacOption | No | オフライン機能テスト |
| connects to Azure | Connect-DbaInstance | No (Azure) | Service Principal + 接続文字列 |
| gets a database from Azure | Get-DbaDatabase | No (Azure) | Azureデータベース取得 |

### Linux/Windows統合テストとの比較

| 項目 | macOS | Linux | Windows |
|------|-------|-------|---------|
| ローカルSQL Server | 不可 | Docker | LocalDB/フル |
| テストケース数 | 3 | 約20 | 4 |
| マイグレーションテスト | 不可 | 可 | 不可 |
| ミラーリングテスト | 不可 | 可 | 不可 |
| Azure接続テスト | 可 | 可 | 可 |
