# バッチ設計書 6-test-coverage

## 概要

本ドキュメントは、GitHub Actionsを使用してcovrパッケージによるテストカバレッジを測定し、Codecovにレポートをアップロードするワークフローの設計書である。

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

このバッチは、GitHubへのpushまたはPull Request作成時に自動的にトリガーされ、dplyrパッケージのテストカバレッジ（コードのうちテストでカバーされている割合）を測定し、Codecovサービスにレポートする処理を行う。

**業務上の目的・背景**：テストカバレッジは、ソフトウェアの品質を測定する重要な指標の一つである。dplyrのような広く利用されるパッケージでは、高いテストカバレッジを維持することで、リグレッションバグの早期発見やコードの信頼性向上に貢献する。Codecovを使用することで、カバレッジの推移を可視化し、PRごとのカバレッジ変化を追跡できる。

**バッチの実行タイミング**：mainまたはmasterブランチへのpush時、およびPull Request作成・更新時に自動実行される。

**主要な処理内容**：
1. リポジトリのチェックアウト
2. Rのセットアップ
3. パッケージ依存関係のインストール（covr含む）
4. covr::package_coverage()によるカバレッジ測定
5. Cobertura形式でのレポート生成
6. Codecovへのレポートアップロード
7. testthat出力の表示（デバッグ用）
8. テスト失敗時の成果物アップロード

**前後の処理との関連**：R-CMD-checkワークフローと並行して実行される。カバレッジ結果はPRのステータスチェックとして表示される。

**影響範囲**：Codecovダッシュボード上のカバレッジレポートが更新される。PRのマージ判断の参考情報として利用される。

## バッチ種別

CI/CD（テストカバレッジ測定）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動 |
| 実行時刻 | N/A（イベント発生時） |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | push（main/master）、pull_request |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actionsの有効化 | リポジトリでGitHub Actionsが有効であること |
| GITHUB_TOKEN | シークレットとしてGITHUB_TOKENが利用可能であること |
| CODECOV_TOKEN | シークレットとしてCODECOV_TOKENが設定されていること（オプション） |

### 実行可否判定

GitHubイベント（push/pull_request）により自動的に実行判定される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチはGitHubイベントにより自動実行 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| リポジトリコード | Git | チェックアウトされたソースコード |
| tests/ | R/testthat | テストファイル |
| R/ | Rソース | 対象ソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| cobertura.xml | XML | Cobertura形式カバレッジレポート |
| Codecov | Web | カバレッジレポート（外部サービス） |
| coverage-test-failures | アーティファクト | テスト失敗時のパッケージディレクトリ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | cobertura.xml |
| 出力先 | ワークフロー実行ディレクトリ |
| 文字コード | UTF-8 |
| 区切り文字 | N/A（XML形式） |

## 処理フロー

### 処理シーケンス

```
1. ワークフロートリガー
   └─ push（main/master）またはpull_requestイベントで起動
2. リポジトリチェックアウト
   └─ actions/checkout@v4でソースコード取得
3. Rセットアップ
   └─ r-lib/actions/setup-r@v2でRをインストール
4. 依存関係インストール
   └─ r-lib/actions/setup-r-dependencies@v2でcovr, xml2含む依存パッケージをインストール
5. テストカバレッジ測定
   └─ covr::package_coverage()でカバレッジを計測
6. Cobertura形式変換
   └─ covr::to_cobertura()でXML形式に変換
7. Codecovアップロード
   └─ codecov/codecov-action@v5でレポートをアップロード
8. testthat出力表示
   └─ テスト結果ファイルを表示（常に実行）
9. テスト失敗時の成果物アップロード
   └─ 失敗時のみパッケージディレクトリをアップロード
```

### フローチャート

```mermaid
flowchart TD
    A[イベント発生] --> B{トリガー判定}
    B -->|push/PR| C[チェックアウト]
    C --> D[Rセットアップ]
    D --> E[依存関係インストール]
    E --> F[カバレッジ測定]
    F --> G[Cobertura形式変換]
    G --> H[Codecovアップロード]
    H --> I[testthat出力表示]
    I --> J{テスト失敗?}
    J -->|Yes| K[成果物アップロード]
    J -->|No| L[ジョブ完了]
    K --> L
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | 本バッチはデータベースを使用しない |

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

本バッチはデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | テスト失敗 | testthatテストが失敗 | テストコードまたは実装を修正 |
| - | カバレッジ測定エラー | covrの実行に失敗 | パッケージの依存関係を確認 |
| - | Codecovアップロード失敗 | トークンエラーまたはネットワークエラー | CODECOV_TOKENを確認、非PRでは失敗時にCIも失敗 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 手動で再実行可能 |
| リトライ間隔 | N/A |
| リトライ対象エラー | 一時的なネットワークエラー等 |

### 障害時対応

エラー発生時は、GitHub Actions UIでログを確認し、エラー原因を特定して修正。テスト失敗時はアップロードされた成果物（coverage-test-failures）を確認して詳細を調査可能。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 全テストケース実行 |
| 目標処理時間 | 10-30分 |
| メモリ使用量上限 | GitHub Actions標準 |

## 排他制御

並列実行を許可。複数のPRが同時にカバレッジ測定を実行しても問題ない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| カバレッジログ | 測定完了時 | カバレッジ率（print(cov)） |
| testthatログ | 常時（if: always()） | testthat.Rout*ファイルの内容 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー失敗 | 1件以上 | GitHub通知、PRステータス |
| カバレッジ低下 | Codecov設定による | Codecov通知、PRコメント |

## 備考

- permissions: read-allにより、最小限の権限で実行
- fail_ci_if_errorは、PR以外またはCODECOV_TOKENが設定されている場合にtrueとなる
- plugins: noopとdisable_search: trueにより、Codecovの自動検出を無効化し、明示的にcobertura.xmlを指定
- install_pathにRUNNER_TEMPを使用することで、一時ディレクトリにパッケージをインストール
- if: always()により、テスト失敗時もtestthat出力を表示
- if: failure()により、テスト失敗時のみ成果物をアップロード
