自動テストの組み込み

静的解析の次は、CIに自動テストを組み込みます。静的解析ではコードのスタイルや構文上の問題を検出できますが、アプリケーションが期待どおりに動作するかどうかは確認できません。自動テストを組み込むことで、コードの振る舞いが正しいことを自動的に検証できるようになります。

1. 自動テストの流れ

今回は、pytestを使ったテストをGitHub Actionsのワークフローに組み込みます。先ほどと同じく、mainブランチへのPull Requestが作成された際にワークフローが実行されるように設定します。

処理の流れは以下のとおりです。

  • GitHubリポジトリからコードをチェックアウトする
  • Pythonのランタイムをセットアップする
  • テストツール(pytest)をインストールする
  • pytestでテストを実行する

これらの流れを、先ほど作成したcode-check.ymlにジョブとして追加します。別のワークフローファイルを新しく作るのではなく、同じファイル内にジョブを追加する形にする理由は、「Pull Request作成時に静的解析と自動テストの両方を同時に走らせる」という要件を最もシンプルに実現できるためです。

1つのワークフローファイルに複数のジョブを定義すると、指定がない限りそれらのジョブは並列実行されます。並列で動かすことで、直列で順番に動かすよりもフィードバックを早く得られます。

pytestの基本的な書き方や使い方については、Pythonで自動テストをしよう で詳しく解説しています。

2. テストコードの作成

自動テストをCIで実行するためには、テスト対象のコードに加えて、テストコードがリポジトリに存在している必要があります。ここでは、calculator.pyの関数をテストするコードを作成します。

リポジトリ直下にtest_calculator.pyというファイルを作成します。

devopscamp-ci-handson/
├── .github/
│   └── workflows/
│       └── code-check.yml
├── calculator.py
└── test_calculator.py  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

from calculator import add, subtract


def test_add():
    assert add(1, 2) == 3
    assert add(-1, 1) == 0


def test_subtract():
    assert subtract(5, 3) == 2
    assert subtract(0, 0) == 0

このファイルには、calculator.pyで定義したaddとsubtractの2つの関数をpytestで検証するテストコードを記述しています。それぞれの関数に対して、正の数・負の数・ゼロなどのパターンで期待どおりの結果が返ることを確認しています。

⚠️ ファイルの末尾に改行が入らない場合
コードをコピーして貼り付けた場合、ファイルの末尾に改行が入らないことがあります。その場合は、test_calculator.pyの最終行(assert subtract(0, 0) == 0)の行末でEnterキーを1回押して改行を入れてから保存してください。

pytestの基本的な書き方については、Pythonで自動テストをしよう で詳しく解説しています。

3. ジョブの追加

それでは、code-check.ymlにテスト用のジョブを追加します。Visual Studio Codeでcode-check.ymlを開き、既存のpython-lintジョブの下に以下のpython-testジョブを追記してください。

name: Python Code Check

on:
  pull_request:
    branches:
      - main

jobs:
  python-lint:
    name: Run python-lint
    runs-on: ubuntu-latest

    steps:
      # ソースコードのチェックアウト
      - name: Checkout code
        uses: actions/checkout@v5

      # Python環境をセットアップ
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.11'

      # 静的解析ツールをインストール
      - name: Install flake8
        run: pip install flake8

      # flake8で静的解析を実行
      - name: Run flake8
        run: flake8 .

  python-test:
    name: Run python-test
    runs-on: ubuntu-latest

    steps:
      # ソースコードのチェックアウト
      - name: Checkout code
        uses: actions/checkout@v5

      # Python環境をセットアップ
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.11'

      # テストツールをインストール
      - name: Install pytest
        run: pip install pytest

      # pytestでテストを実行
      - name: Run pytest
        run: pytest -v

4. ジョブの説明

追加したジョブを解説します。

python-test:
  name: Run python-test
  runs-on: ubuntu-latest

ジョブとして、python-testというジョブを定義しています。名前にRun python-test、ランナーとしてubuntu-latestを指定しているため、Ubuntuの最新のランナー環境で動作します。

また、python-lintジョブとpython-testジョブの間には前後関係を指定していないため、これらのジョブは並列で実行されます。

4.1 ステップ1:コードのチェックアウト

- name: Checkout code
  uses: actions/checkout@v5

静的解析のジョブと同様に、Pull Requestの仮のマージコミットをチェックアウトします。

4.2 ステップ2:Pythonのセットアップ

- name: Set up Python
  uses: actions/setup-python@v6
  with:
    python-version: '3.11'

pytestコマンドを実行するにはCI環境にPythonランタイムがインストールされている必要があります。actions/setup-pythonアクションで、バージョン3.11のPythonランタイムをインストールしています。

4.3 ステップ3:テストツールのインストール

- name: Install pytest
  run: pip install pytest

pip install pytestで、テストフレームワークのpytestをインストールします。

4.4 ステップ4:テストの実行

- name: Run pytest
  run: pytest -v

pytest -vコマンドで、カレントディレクトリ配下のすべてのテストファイルを実行します。pytestはtest_で始まるファイル名とtest_で始まる関数名を自動で探し出して実行してくれるため、特にファイル指定は不要です。-vオプションを付けることで、詳細なテスト結果が出力されます。

💡 ポイント
python-lintジョブとpython-testジョブは、それぞれ独立したランナー(実行環境)で動作します。そのため、python-lintでインストールしたflake8はpython-testでは利用できません。ジョブをまたいで環境を共有したい場合は、別の仕組み(アーティファクトなど)が必要ですが、今回のようにそれぞれが独立してツールをインストールする構成が最もシンプルです。

5. 動作確認(正常ケース)

ジョブの追加ができたので、再びGitHubにPushして動作を確認します。すでにPull Requestを作成済みなので、Pushするだけで先ほどのワークフローが再実行され、追加した自動テストのジョブも一緒に動きます。

5.1 GitHubへのPush

Visual Studio Codeのターミナルで、以下のコマンドを1つずつ実行します。

git add .
git commit -m "add pytest job"
git push origin feature/add-ci-workflow

5.2 ワークフローの実行確認

既にPull Requestが作成されているため、Pushするとワークフローが再実行されます。

Pull Requestの画面を開くと、Python Code Check / Run python-lintとPython Code Check / Run python-testの2つのジョブが並列に実行されていることが確認できます。

しばらく待つと、両方のジョブが正常終了します。

python-testの実行結果を開き、Run pytestのステップ部分を展開すると、test_addとtest_subtractの2つのテストがパスしていることが読み取れます。

Pull Requestの画面に戻ると、両方のジョブに緑のチェックマークが付いています。これが「静的解析と自動テストの両方をパスした」状態です。ここまでの操作が完了です。

6. 動作確認(エラー発生時)

静的解析のときと同様、「テストが失敗したときにワークフローがちゃんと失敗扱いになる」ことも確認しておきます。テストが失敗してもワークフローが通ってしまうと、バグ入りのコードがマージされてしまうため、このチェックは重要です。

6.1 コードの修正

Visual Studio Codeでtest_calculator.pyを開き、test_add関数のアサーションを以下のように変更します。

def test_add():
    assert add(1, 2) == 4  # ← 期待値をわざと間違える
    assert add(-1, 1) == 0

add(1, 2)は本来3を返しますが、期待値を4に変更することで、実際の値と一致しなくなり、テストが失敗します。

6.2 GitHubへのPush

ファイルを保存したら、再びGitHubにPushします。

git add .
git commit -m "break test for error check"
git push origin feature/add-ci-workflow

6.3 ワークフローの実行確認

Pull Requestの画面を開くと、ワークフローが再実行されています。しばらくすると、python-testのジョブがエラーになり、赤いバツマークが表示されます。

エラーとなっているRun pytestのステップを開くと、アサーションエラーのメッセージが表示されています。実際の値は3ですが、期待値として4を指定したため、テストが失敗しています。pytestの実行が失敗するとGitHub Actionsのワークフローも失敗するため、これは正常な動作です。

一方で、python-lintのジョブは引き続き緑のチェックのままです。これは「静的解析ではテスト期待値のミスを検知できない(テストの期待値は文法的には正しいため)」ことを示しており、静的解析と自動テストはそれぞれ異なる役割を持つ相補的な仕組みであることが実感できます。

テストの失敗を確認できたので、ここまでの操作は完了です。

💡 ポイント
実際には、テストのエラーを修正してCIが正常終了した後にPull Requestをマージするのが一般的な流れです。本章ではマージの手順は省略しています。また、現状ではCIが失敗していてもPull Requestをマージできてしまいますが、GitHubのブランチ保護ルールを設定することで、CIが通らない限りマージを禁止することもできます。ブランチ保護ルールについては GitHubで保護ブランチを設定しよう で解説します。