# バッチ設計書 36-adminrunner.sh

## 概要

本ドキュメントは、Etherpadプロジェクトにおける管理画面のフロントエンドテストを実行するシェルスクリプト `adminrunner.sh` のバッチ設計書です。

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

このバッチは、Etherpadサーバーを起動し、Selenium WebDriverを使用してSauce Labs上で管理画面（Admin UI）のフロントエンドテストを実行するスクリプトです。

**業務上の目的・背景**：Etherpadの管理画面は、プラグイン管理、設定変更、ユーザー管理などの重要な機能を提供します。本バッチは、管理画面専用のテストスイートを実行することで、管理機能の品質を担保します。runner.shと同様にSauce Labsを使用しますが、テスト対象を管理画面に限定し、Chromeブラウザのみでテストを実行します。

**バッチの実行タイミング**：CI/CDパイプライン（GitHub Actions、Travis CI等）からプルリクエストやマージ時に自動実行されます。管理画面に変更があった場合に特に重要です。

**主要な処理内容**：
1. Etherpadベースディレクトリへ移動
2. 開発モードでEtherpadサーバーをバックグラウンド起動
3. サーバーが接続可能になるまで最大15秒待機
4. remote_runner.jsに `admin` 引数を渡して管理画面テストを実行
5. テスト完了後、Etherpadサーバーを終了

**前後の処理との関連**：`installDeps.sh` による依存関係インストールが事前に完了している必要があります。通常のフロントエンドテスト（runner.sh）とは別に実行されます。

**影響範囲**：Sauce Labsのテスト環境で管理画面のテストが実行されます。テスト結果はGitHubのステータスチェックに反映されます。

## バッチ種別

テスト実行処理（管理画面フロントエンドテスト）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | CI/CDトリガー |
| 実行時刻 | コミット・プルリクエスト時 |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | CI/CD / 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.jsがインストールされていること | サーバー起動・テスト実行に必要 |
| 依存関係がインストール済みであること | npm installが完了している必要 |
| curlがインストールされていること | サーバー接続確認に必要 |
| Sauce Labs認証情報 | SAUCE_USERNAME, SAUCE_ACCESS_KEYが設定されている必要 |

### 実行可否判定

依存関係がインストールされており、Sauce Labs認証情報が設定されている場合に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $@ | string | No | なし | npm run devに渡される追加引数 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 環境変数 | 文字列 | SAUCE_USERNAME, SAUCE_ACCESS_KEY等 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト実行ログ |
| Sauce Labs | テスト結果 | ブラウザのテスト結果 |
| 終了コード | 数値 | 0=成功、1=失敗 |

### 出力ファイル仕様

本バッチはファイル出力を行いません。

## 処理フロー

### 処理シーケンス

```
1. ユーティリティ関数の定義
   └─ pecho, log, error, fatal, try関数を定義
2. ディレクトリ移動
   └─ Etherpadベースディレクトリへ移動
3. Etherpadサーバー起動
   └─ npm run dev --experimental-worker をバックグラウンドで起動
   └─ プロセスIDを保存
4. 接続待機
   └─ 4.1. curl でlocalhost:9001への接続を試行
   └─ 4.2. 最大15秒間、1秒間隔でリトライ
   └─ 4.3. 接続失敗時はタイムアウトエラーで終了
5. 管理画面テスト実行
   └─ remote_runner.js admin を実行
6. クリーンアップ
   └─ Etherpadプロセスを終了
7. 終了
   └─ テスト結果の終了コードで終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[ディレクトリ移動]
    B --> C[npm run dev 起動]
    C --> D[接続待機開始]
    D --> E{15秒経過?}
    E -->|いいえ| F{接続成功?}
    F -->|いいえ| G[1秒待機]
    G --> E
    F -->|はい| H[remote_runner.js admin実行]
    E -->|はい| I[タイムアウトエラー]
    I --> J[fatal終了]
    H --> K[テスト完了]
    K --> L[Etherpadプロセス終了]
    L --> M[終了コード返却]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作は行いません |

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

本バッチはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 接続タイムアウト | 15秒以内にサーバーに接続できない | サーバーログ確認、依存関係確認 |
| 1 | テスト失敗 | remote_runner.jsでテスト失敗 | テスト結果を確認し問題を修正 |
| 1 | コマンド失敗 | try関数でラップされたコマンドの失敗 | エラーメッセージを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 接続確認のみ15回（15秒間） |
| リトライ間隔 | 1秒 |
| リトライ対象エラー | サーバー接続エラー |

### 障害時対応

1. 接続タイムアウト時はサーバーログを確認
2. テスト失敗時はSauce Labsのテスト結果を確認
3. 依存関係エラー時はinstallDeps.shを再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ブラウザ（Chrome）のみ |
| 目標処理時間 | 約15分（Sauce Labs制限） |
| メモリ使用量上限 | Node.jsプロセスに依存 |

## 排他制御

同一ポート（9001）での同時実行は避けてください。ポート競合が発生します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 処理開始時 | "Assuming src/bin/installDeps.sh has already been run" |
| 接続待機 | 待機中 | "Waiting for Etherpad to accept connections..." |
| 接続成功 | 接続成功時 | "Successfully connected to Etherpad on http://localhost:9001" |
| テスト開始 | テスト開始時 | "Starting the remote runner..." |
| 完了ログ | 処理完了時 | "Done." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| テスト実行時間 | 14.5分（Sauce Labs制限） | Sauce Labs |
| テスト失敗 | 1件以上 | CI/CDパイプライン |

## 備考

- runner.shとほぼ同一の構造ですが、remote_runner.jsに `admin` 引数を渡す点が異なります
- admin引数により、remote_runner.jsはChromeブラウザのみでテストを実行します（isAdminRunner判定）
- Safari、Firefox、Edgeでのテストはスキップされます
- 管理画面固有の機能（プラグイン管理等）のテストに特化しています
- 環境変数 SAUCE_USERNAME、SAUCE_ACCESS_KEY、GIT_HASH、TRAVIS_JOB_NUMBER が使用されます
