# バッチ設計書 29-static-analysis.yml

## 概要

本ドキュメントは、Dear ImGuiプロジェクトに対してPVS-Studio静的コード解析を実行するGitHub Actionsワークフロー `static-analysis.yml` の設計書です。

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

このワークフローは、PVS-Studio静的コード解析ツールを使用して、Dear ImGuiのソースコードに対して自動的に静的解析を実行し、潜在的なバグやコード品質の問題を検出します。

**業務上の目的・背景**：静的コード解析は、コードを実行せずに潜在的なバグ、セキュリティ脆弱性、コーディング規約違反を検出する手法です。PVS-Studioは商用グレードの静的解析ツールで、C/C++コードの深い解析を提供します。このワークフローにより、コード変更がリポジトリにマージされる前に品質問題を自動的に検出できます。

**バッチの実行タイミング**：build.ymlワークフローが実行要求された時（workflow_run: requested）にトリガーされます。これにより、ビルドワークフローと並行して静的解析が実行されます。

**主要な処理内容**：
1. リポジトリのチェックアウト
2. PVS-Studioのインストールとライセンス設定
3. example_nullのビルドトレース取得
4. PVS-Studio解析の実行
5. 解析結果のレポート出力

**前後の処理との関連**：build.ymlワークフローの実行をトリガーとして実行されます。build.ymlのトリガー（push、pull_request、scheduled、manual）と同じタイミングで解析が行われます。

**影響範囲**：ImGuiコアライブラリのソースコードが解析対象です。サードパーティライブラリ（imstb_*）は解析対象から除外されます。

## バッチ種別

GitHub Actionsワークフロー（静的コード解析）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | buildワークフロー実行時 |
| 実行時刻 | buildワークフロー開始時 |
| 実行曜日 | 任意（イベント駆動） |
| 実行日 | 任意（イベント駆動） |
| トリガー | workflow_run (build: requested) |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHubリポジトリ | GitHub Actionsが有効なリポジトリであること |
| PVS_STUDIO_LICENSE | GitHubシークレットにPVS-Studioライセンスが設定されていること |
| buildワークフロー | build.ymlワークフローが存在し実行されること |

### 実行可否判定

buildワークフローが実行要求（requested）されると自動的にトリガーされます。PVS-Studioライセンスがない場合はスキップされます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| secrets.PVS_STUDIO_LICENSE | シークレット | Yes | - | PVS-Studioライセンス（"name_or_email key"形式） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| リポジトリコード | Git | ImGuiソースコード |
| PVS-Studioパッケージ | deb | PVS-Studio静的解析ツール |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| pvs-studio.log | ログファイル | 解析結果の生ログ |
| plog-converter出力 | errorfile形式 | 整形された解析結果 |
| GitHub Actionsログ | テキスト | ワークフロー実行ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | pvs-studio.log |
| 出力先 | examples/example_null/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. チェックアウト
   └─ actions/checkout@v6でリポジトリをクローン

2. 依存関係インストール
   ├─ PVS-Studio公開鍵の取得
   ├─ apt-sourcesリストの追加
   ├─ PVS-Studioのインストール
   └─ ライセンスファイルの生成

3. 静的解析実行
   ├─ example_nullディレクトリへ移動
   ├─ pvs-studio-analyzer trace（ビルドトレース）
   ├─ pvs-studio-analyzer analyze（解析実行）
   │   └─ imstb_*.hを除外
   └─ plog-converter（結果整形）
       └─ GA:1,2;OP:1レベルを出力
```

### フローチャート

```mermaid
flowchart TD
    A[ワークフロー開始] --> B{PVS_STUDIO_LICENSE存在?}
    B -->|なし| C[スキップ終了]
    B -->|あり| D[チェックアウト]
    D --> E[PVS-Studioインストール]
    E --> F[ライセンス設定]
    F --> G[example_nullディレクトリへ移動]
    G --> H[make実行 + トレース取得]
    H --> I[pvs-studio-analyzer analyze]
    I --> J[plog-converter結果整形]
    J --> K{エラー検出?}
    K -->|あり| L[エラー出力]
    K -->|なし| M[成功終了]
    L --> M
```

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

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

本ワークフローはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ライセンスなし | スキップ | PVS_STUDIO_LICENSEが未設定 | シークレットを設定 |
| 解析エラー | 警告 | コード品質問題を検出 | 検出された問題を修正 |
| インストールエラー | 失敗 | PVS-Studioのインストール失敗 | ネットワーク・リポジトリを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | GitHub Actions標準（手動再実行） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 一時的なネットワークエラー |

### 障害時対応

1. GitHub Actionsのログを確認
2. PVS-Studioライセンスの有効性を確認
3. PVS-Studioリポジトリの状態を確認
4. 必要に応じてワークフローを再実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の解析実行 |
| 目標処理時間 | 数分程度 |
| メモリ使用量上限 | GitHub Actionsランナー依存 |

## 排他制御

特になし。buildワークフローと並行して実行されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| インストールログ | 依存関係インストール時 | apt-get出力 |
| 解析ログ | 解析実行時 | PVS-Studio解析結果 |
| エラーログ | 問題検出時 | コード品質警告 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 解析警告 | GA:1,2レベル | GitHub Actionsログ |
| 解析エラー | OP:1レベル | GitHub Actionsログ |

## 備考

- PVS-Studioライセンスは「name_or_email key」形式で1行で設定する必要があります。
- 無料ライセンスの取得方法：https://www.viva64.com/en/b/0457/
- 解析対象から除外されるファイル：imstb_rectpack.h、imstb_textedit.h、imstb_truetype.h
- V1071警告は無効化されています（-d V1071）。
- plog-converterでGA:1,2（General Analysis Level 1,2）とOP:1（Optimization Level 1）の警告を出力します。
