# バッチ設計書 4-before_install.sh

## 概要

本ドキュメントは、CI環境の事前セットアップスクリプト `ci/before_install.sh` の設計仕様を記載する。

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

このバッチは、CI（継続的インテグレーション）パイプラインの実行前に必要なツールと依存関係をインストールするためのシェルスクリプトである。Ubuntu環境において、コードの静的解析ツール（shellcheck、vim-vint）とPython 3.6環境をセットアップする。

**業務上の目的・背景**：space-vimプロジェクトの品質を維持するため、CI環境でコードの静的解析を実行する必要がある。このスクリプトは、CIジョブが正常に実行されるために必要なすべてのツールを事前にインストールし、テスト実行環境を準備する。シェルスクリプトの検証（shellcheck）とVim scriptの検証（vint）を行うためのツールチェーンを構築する。

**バッチの実行タイミング**：CIパイプラインのbefore_installステージで自動実行される。Travis CIやGitHub Actionsなどのプラットフォームで、テストスクリプト実行前に呼び出される。

**主要な処理内容**：
1. deadsnakes PPAリポジトリの追加（Python 3.6用）
2. apt-getの更新
3. shellcheckとPython 3.6のインストール
4. vim-vintおよび関連Pythonパッケージのインストール

**前後の処理との関連**：このスクリプトはCI/CDパイプラインの最初のステップとして実行される。後続のci/script.shがこのスクリプトでインストールされたツールを使用してテストを実行する。

**影響範囲**：CI実行環境のシステムパッケージとPythonパッケージに影響を与える。ローカル開発環境では通常実行しない。

## バッチ種別

CI/CD / 環境セットアップ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | CIパイプライン実行時 |
| 実行時刻 | コードプッシュ/PR時 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | CI/CDプラットフォームによる自動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ubuntu環境 | apt-getが使用可能なDebian系Linuxであること |
| sudo権限 | パッケージインストールのためsudo権限が必要 |
| インターネット接続 | PPAリポジトリとpypiへのアクセスが必要 |

### 実行可否判定

特別な実行可否判定はない。前提条件を満たさない環境では、各コマンドがエラーとなる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本スクリプトはコマンドライン引数を受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| deadsnakes PPA | apt repository | Python 3.6パッケージ提供元 |
| pypi | pip packages | vim-vint等のPythonパッケージ |
| Ubuntu公式リポジトリ | apt packages | shellcheckパッケージ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| システムパッケージ | バイナリ | shellcheck, python3.6 |
| Pythonパッケージ | pip | vim-vint, pathlib, typing, enum34 |

### 出力ファイル仕様

本バッチはシステムにパッケージをインストールし、特定のファイルを出力しない。

## 処理フロー

### 処理シーケンス

```
1. PPAリポジトリの追加
   └─ sudo add-apt-repository ppa:deadsnakes/ppa -y
2. パッケージリストの更新
   └─ sudo apt-get update
3. システムパッケージのインストール
   └─ sudo apt-get install shellcheck python3.6 -y
4. Pythonパッケージのインストール
   └─ sudo pip install vim-vint pathlib typing enum34
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[deadsnakes PPAを追加]
    B --> C[apt-get update]
    C --> D[shellcheck, python3.6をインストール]
    D --> E[vim-vint等Pythonパッケージをインストール]
    E --> F[バッチ終了]
```

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

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

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

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

N/A - データベース操作なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 権限エラー | sudo権限がない | CI環境の設定を確認する |
| - | ネットワークエラー | PPA/pypiへの接続失敗 | ネットワーク接続を確認、リトライを検討 |
| - | パッケージエラー | パッケージが見つからない | リポジトリが最新か確認、パッケージ名を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（CIプラットフォームのリトライ機能に依存） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

- パッケージインストール失敗時はCIジョブが失敗する
- PPAが利用できない場合は代替のPythonインストール方法を検討する
- ネットワークエラー時はCIジョブを再実行する

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A（パッケージインストールは個別に実行） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回/CIジョブ |
| 目標処理時間 | 1-3分（ネットワーク速度依存） |
| メモリ使用量上限 | パッケージインストール時の一時使用量 |

## 排他制御

CI環境では各ジョブが独立したコンテナ/VM上で実行されるため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 各コマンド実行時 | apt-get/pipの進捗メッセージ |
| 標準エラー | エラー発生時 | エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| CI ジョブ失敗 | 1回 | GitHub通知（PR作成者） |

## 備考

- -yオプションにより、インタラクティブな確認なしで自動実行される
- deadsnakes PPAはUbuntuで最新のPythonバージョンを提供する非公式リポジトリ
- vim-vintはVim scriptの静的解析ツール
- pathlib, typing, enum34はvim-vintの依存パッケージ
- このスクリプトは主にTravis CI向けに設計されているが、GitHub Actionsでは直接ci.yml内でパッケージインストールを行う構成になっている
