# バッチ設計書 6-test.sh

## 概要

本ドキュメントは、F#コンパイラプロジェクトのLinux/macOS環境向けテスト実行スクリプト「test.sh」の設計仕様を記載する。

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

test.shは、F#コンパイラプロジェクトのユニットテストを実行するためのLinux/macOS向けエントリーポイントスクリプトである。シンボリックリンクを正しく解決した上で、eng/build.shを--testオプションで呼び出すことで、プロジェクトのテストスイートを実行する。

**業務上の目的・背景**：F#コンパイラはクロスプラットフォーム対応のプロジェクトであり、Linux/macOS環境でも品質保証のためのテストが実行可能である必要がある。本スクリプトは、Windows環境のTest.cmdに対応するUnix系プラットフォーム向けのエントリーポイントを提供する。CI/CDパイプライン（GitHub Actions、Azure DevOps等）でのLinux/macOSビルドエージェントでの自動テスト、コンテナ環境でのテスト実行など、様々なシナリオで使用される。

**バッチの実行タイミング**：開発者がコード変更後にテストを実行する際、プルリクエスト作成前の検証時、CI/CDパイプラインでの自動テスト時に随時実行される。ビルド完了後の品質検証フェーズで使用される。

**主要な処理内容**：
1. BASH_SOURCEからスクリプトパスを取得する
2. シンボリックリンクを解決し、実際のスクリプト位置を特定する
3. スクリプトルートディレクトリを特定する
4. eng/build.shを--testオプションで呼び出す
5. テスト結果をXML形式で出力する

**前後の処理との関連**：このバッチはビルド完了後に実行される。事前にbuild.shでビルドが完了している必要がある。テスト結果はCI/CDシステムやテストレポートツールで解析される。

**影響範囲**：artifacts/TestResultsディレクトリにテスト結果が出力される。テスト実行中は一時ファイルが作成される場合がある。

## バッチ種別

テスト処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動/CI |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ビルド完了 | build.shでビルドが成功していること |
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| Bash | Bashシェルが利用可能であること |
| 実行権限 | スクリプトに実行権限があること（chmod +x） |

### 実行可否判定

特別な実行可否判定ロジックはない。前提条件が満たされていれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $@ | string | No | - | eng/build.shに渡される追加のコマンドライン引数 |
| --configuration | string | No | Debug | ビルド構成（Debug/Release） |
| --testcoreclr | switch | No | false | .NET Core向けテストを実行 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ビルド成果物 | DLL | コンパイル済みテストアセンブリ |
| テストプロジェクト | .fsproj | テストプロジェクトファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/TestResults | XML | xUnit形式のテスト結果 |
| artifacts/log | .binlog | バイナリログファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | {ProjectName}_{Framework}.xml |
| 出力先 | artifacts/TestResults/{Configuration} |
| 文字コード | UTF-8 |
| 区切り文字 | N/A（XML形式） |

## 処理フロー

### 処理シーケンス

```
1. BASH_SOURCEからスクリプトパスを取得
   └─ 現在のスクリプトファイルのパスを特定
2. シンボリックリンクの解決
   └─ -hオプションでシンボリックリンクかどうか判定
   └─ readlinkコマンドで実際のパスを取得
3. スクリプトルートディレクトリの特定
   └─ cd -P と dirname で絶対パスを取得
4. eng/build.shの呼び出し
   └─ --test オプションと追加引数を渡す
5. テスト結果の出力
   └─ xUnit形式でテスト結果をXML出力
```

### フローチャート

```mermaid
flowchart TD
    A[test.sh開始] --> B[BASH_SOURCE取得]
    B --> C{シンボリックリンク?}
    C -->|Yes| D[readlinkで解決]
    D --> C
    C -->|No| E[scriptrootを特定]
    E --> F[eng/build.sh呼び出し]
    F --> G[テスト実行]
    G --> H{テスト成功?}
    H -->|Yes| I[正常終了]
    H -->|No| J[エラー終了]
```

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

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

本バッチはデータベース操作を行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | テスト失敗 | テストケースが失敗した場合 | テスト結果を確認しコードを修正 |
| 1 | ビルド未完了 | テスト対象のDLLが存在しない | build.shでビルドを実行 |
| 1 | 環境エラー | .NET SDK未インストール時 | 適切なSDKをインストール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. テスト結果XMLを確認し、失敗したテストを特定する
2. 必要に応じてビルドを再実行する
3. テストログ（.binlog）を確認する
4. 問題が解決しない場合は個別のテストプロジェクトを手動で実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のテストセッション |
| 目標処理時間 | 環境依存（通常5-30分） |
| メモリ使用量上限 | 環境依存 |

## 排他制御

同一ディレクトリでの同時実行は推奨されない。テスト実行中のファイルロックが発生する可能性がある。テストは5分間のハングタイムアウトが設定されている。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | テスト開始時 | テストプロジェクト名、構成情報 |
| 進捗ログ | テスト中 | テストケース実行状況 |
| 終了ログ | テスト終了時 | 成功/失敗件数、所要時間 |
| エラーログ | エラー発生時 | 失敗したテストケース、エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | N/A（ローカル実行） | N/A |
| テスト失敗件数 | 0 | コンソール出力 |

## 備考

- このスクリプトはプロジェクトルートから実行することを想定している
- Windows環境では代わりにTest.cmdを使用する
- シンボリックリンクを通じて呼び出された場合も正しく動作する
- テストはblame-hang-timeout 5minutesで実行される
- 追加オプションについてはeng/build.shの--helpを参照
