Pytest Marks

pytest マーク体系設計・実装スキル

pytestのカスタムマークを用いて、実行環境・所要時間・外部依存に応じてテスト実行を制御するパターンを設計・実装する。

仕組みの概要

テスト実行環境          除外すべきテスト           コマンド
─────────────   →   ─────────────────   →   ─────────────────────────
GitHub Actions CI      docker, slow        -m "not docker and not slow"
ローカル開発            (任意)              -m "not slow" など
Docker コンテナ内        docker + skipif     自動除外（skipif が動作）
ローカルDocker実行       （全て実行）        make test  # MakefileでDocker切り替え時

Step 1: マーク名の設計

テストを付与するマークは実行環境・制約の種類で命名する。unit / integration のような実装段階そのものの分類名をそのまま付けるのではなく、「このテストが動く／動かない条件」「何を必要とするか」を名前にする。

マーク設計表（参考）

命名原則: 「このテストが何を必要とするか」を名前にする。integration を使う場合も「結合テストだから」ではなく「外部依存があるため制御したい」という制約ベースの意味に限定する。test_ メソッド名と重複させない。

Step 2: pyproject.toml への登録

markers へ追加しないと --strict-markers 設定下でエラーになる。

[tool.pytest.ini_options]
addopts = [
    "--strict-markers",   # 未登録マーク使用をエラーにする（必須）
    "--strict-config",
    # ...
]
markers = [
    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
    "integration: marks tests as integration tests",
    "docker: marks tests as docker-related (deselect with '-m \"not docker\"')",
    # 追加する場合はここへ
    # "network: marks tests requiring outbound network access",
    # "browser: marks tests requiring a browser (Playwright etc.)",
]

登録書式:

"<マーク名>: <説明文>"

説明文は英語・日本語どちらでも可だが、英語が一般的。

Step 3: テストコードへのマーク付与

3-A: クラスレベルマーク（推奨）

同一クラスのテスト全体に同じマークを付ける場合は、クラス宣言へデコレートする。

import pytest
from pathlib import Path

@pytest.mark.docker
@pytest.mark.skipif(
    Path("/.dockerenv").exists(),
    reason="Dockerコンテナ内ではDockerコマンドが利用できないためスキップ",
)
class TestDockerBuild:
    """DockerビルドのテストはDockerホスト上でのみ実行する。"""
    ...

3-B: メソッドレベルマーク

一部のテストのみに付ける場合はメソッドへデコレートする。

class TestReportGenerator:

    def test_正常系_HTMLレポートを生成する(self) -> None:
        ...  # マーク不要な軽量テスト

    @pytest.mark.slow
    def test_正常系_大量データでレポートを生成する(self) -> None:
        ...  # 重いテストのみ slow マーク

3-C: skipif パターン（環境依存スキップ）

テストを除外する方法は2つある。使い分けを間違えないこと。

Docker コンテナ内での自動スキップ:

@pytest.mark.docker
@pytest.mark.skipif(
    Path("/.dockerenv").exists(),   # /.dockerenv はDockerコンテナ内に存在するファイル
    reason="Dockerコンテナ内ではDockerコマンドが利用できないためスキップ",
)
class TestDockerBuild:
    ...

他のskipif条件の例:

import os
import sys
import shutil

# OS依存
@pytest.mark.skipif(sys.platform != "linux", reason="Linuxのみ対応")

# コマンド依存
@pytest.mark.skipif(shutil.which("docker") is None, reason="docker コマンドが見つからない")

# 環境変数依存
@pytest.mark.skipif(
    os.environ.get("SLACK_WEBHOOK_URL") is None,
    reason="SLACK_WEBHOOK_URL が未設定",
)

Step 4: CI（GitHub Actions）での活用

4-A: 基本パターン（重いテスト・環境依存テストを除外）

- name: Run tests
  run: |
    uv run pytest tests/ \
      --ignore=tests/poc \
      -m "not docker and not slow" \
      -v

4-B: 複数ジョブで役割分担する

jobs:
  test-unit:
    name: Unit Tests
    steps:
      - run: uv run pytest tests/ -m "not docker and not slow and not network"

  test-integration:
    name: Integration Tests
    if: github.ref == 'refs/heads/main'   # mainブランチのみ
    steps:
      - run: uv run pytest tests/ -m "integration and not docker"

  test-docker:
    name: Docker Tests
    if: github.ref == 'refs/heads/main'
    steps:
      - run: uv run pytest tests/ -m "docker"

4-C: スケジュール実行で重いテストだけ実行

on:
  schedule:
    - cron: "0 0 * * 1"   # 毎週月曜

jobs:
  test-slow:
    name: Slow Tests (Weekly)
    steps:
      - run: uv run pytest tests/ -m "slow"

Step 5: ローカル開発でのコマンド例

# 全テスト（ローカル通常実行）
uv run pytest tests/

# docker・slow を除いて実行（CI相当）
uv run pytest tests/ -m "not docker and not slow"

# docker テストだけ実行
uv run pytest tests/ -m "docker"

# slow テストだけ実行（週次レビュー等）
uv run pytest tests/ -m "slow"

# Docker コンテナ内でテスト実行（docker マーク付きは skipif で自動除外）
make test  # MakefileでDocker実行に切り替え後

チェックリスト

新しいマークを追加するとき:

• pyproject.toml の markers に登録した（--strict-markers でエラーにならないか確認）
• マーク名が「何を必要とするか」を示している（実装内容ではなく制約）
• skipif が必要な場合は条件式が正しい（Path("/.dockerenv").exists() 等）
• CI workflow で適切に除外または含めている
• ローカル開発用コマンド（Makefile 等）を更新した

アンチパターン

Source: studiogadget/skills — distributed by TomeVault.