【Pythonテスト効率化】 pytestフィクスチャで前後処理を共通化

# ファイル名: test_yield_fixture.py
import pytest

@pytest.fixture
def sample_resource():
    # 前処理: リソースを用意する
    print("setup: open resource")
    resource = {"answer": 42}
    # yieldの値がテスト側に渡される
    yield resource
    # 後処理: リソースを解放する
    print("teardown: close resource")

def test_use_resource(sample_resource):
    # フィクスチャの戻り値が引数で受け取れる
    assert sample_resource["answer"] == 42

# ファイル名: test_tmp_path.py
# 一時ファイルを作成し、内容を読み書きする例です。
def test_write_and_read(tmp_path):
    data_file = tmp_path / "hello.txt"
    # テキストを書き出す
    data_file.write_text("pytest makes testing easy")
    # ファイルが存在するか検証
    assert data_file.exists()
    # 内容の検証
    content = data_file.read_text()
    assert content == "pytest makes testing easy"

# ファイル名: test_composed_fixtures.py
import json
import pytest

@pytest.fixture
def data_dir(tmp_path):
    # tmp_pathにサンプルデータを配置する
    dir_ = tmp_path / "data"
    dir_.mkdir()
    (dir_ / "config.json").write_text(json.dumps({"mode": "dev", "retry": 2}))
    return dir_

@pytest.fixture
def load_config(data_dir):
    # data_dirに依存して設定ファイルを読み込む高レベルフィクスチャ
    cfg_path = data_dir / "config.json"
    with cfg_path.open() as f:
        return json.load(f)

def test_config_loaded(load_config):
    # 合成フィクスチャから最終的な値だけを受け取れる
    assert load_config["mode"] == "dev"
    assert load_config["retry"] == 2

# ファイル名: test_scope_demo.py
import pytest

@pytest.fixture(scope="session")
def session_res():
    print("session: setup")
    yield "S"
    print("session: teardown")

@pytest.fixture(scope="module")
def module_res():
    print("module: setup")
    yield "M"
    print("module: teardown")

@pytest.fixture(scope="function")
def function_res():
    print("function: setup")
    yield "F"
    print("function: teardown")

def test_one(session_res, module_res, function_res):
    assert session_res + module_res + function_res == "SMF"

def test_two(session_res, module_res, function_res):
    assert session_res == "S"

# ファイル名: test_autouse_seed.py
import random
import pytest

@pytest.fixture(autouse=True)
def fixed_seed():
    # 毎テストで疑似乱数のシードを固定
    random.seed(0)

def test_random_is_deterministic():
    # 固定シードにより最初の値は常に同じ
    assert random.random() == 0.8444218515250481

def test_random_next_is_also_deterministic():
    # 各テストでseed(0)されるので、再び同じ最初の値が得られる
    assert random.random() == 0.8444218515250481

project/
  tests/
    conftest.py
    test_a.py
    test_b.py

# ファイル名: tests/conftest.py
import pytest

@pytest.fixture
def app_config(tmp_path):
    # 共通の設定ディレクトリとファイルを用意
    cfg_dir = tmp_path / "config"
    cfg_dir.mkdir()
    cfg_file = cfg_dir / "app.ini"
    cfg_file.write_text("mode=dev\nretries=3\n")
    return {"dir": str(cfg_dir), "file": str(cfg_file)}

# ファイル名: tests/test_a.py
def test_a_uses_config(app_config):
    assert "mode" in open(app_config["file"]).read()

# ファイル名: tests/test_b.py
def test_b_sees_same_structure(app_config):
    # tmp_pathは各テストで別ディレクトリなので相互に汚染しません
    assert app_config["file"].endswith("app.ini")

# ファイル名: test_env_fixture.py
import os
import pytest

@pytest.fixture
def set_app_mode(monkeypatch):
    # 前処理: テスト用の環境変数をセット
    monkeypatch.setenv("APP_MODE", "test")
    yield
    # 後処理: APP_MODEを削除または元に戻す
    monkeypatch.delenv("APP_MODE", raising=False)

def get_mode():
    # 本番コード想定の小関数
    return os.getenv("APP_MODE", "prod")

def test_mode_is_test(set_app_mode):
    assert get_mode() == "test"

def test_mode_defaults_to_prod():
    # フィクスチャ未使用のテストでは既定値
    assert get_mode() == "prod"

# ファイル名: test_env_snapshot.py
import os
import pytest

@pytest.fixture
def env_snapshot():
    before = os.environ.copy()
    yield
    # 差分を反映して厳密に復元する
    os.environ.clear()
    os.environ.update(before)

def test_env_with_snapshot(env_snapshot):
    os.environ["X"] = "1"
    assert os.getenv("X") == "1"
# テスト終了時にXは確実に消えます

# ファイル名: test_logging_reset.py
import logging
import pytest

@pytest.fixture
def reset_logging():
    # 前処理: 現在の状態を保存し、INFOで初期化
    root = logging.getLogger()
    prev_level = root.level
    prev_handlers = root.handlers[:]
    for h in root.handlers[:]:
        root.removeHandler(h)
    logging.basicConfig(level=logging.INFO)
    yield
    # 後処理: ハンドラとレベルを復元
    root = logging.getLogger()
    for h in root.handlers[:]:
        root.removeHandler(h)
    for h in prev_handlers:
        root.addHandler(h)
    root.setLevel(prev_level)

def test_logging_output(reset_logging, caplog):
    # caplogでINFO以上を捕捉
    caplog.set_level(logging.INFO)
    logger = logging.getLogger("demo")
    logger.info("hello fixture")
    assert "hello fixture" in caplog.text

# 悪い例: 後処理がないためファイルが閉じられない
import pytest

@pytest.fixture
def bad_file(tmp_path):
    f = (tmp_path / "x.txt").open("w")
    f.write("x")
    return f  # 後処理なし

# 良い例: yieldの後で確実にクローズ
import pytest

@pytest.fixture
def good_file(tmp_path):
    f = (tmp_path / "x.txt").open("w")
    yield f
    f.close()

# addfinalizerの例
import pytest

@pytest.fixture
def resource(request):
    res = object()
    def cleanup():
        print("cleanup called")
    request.addfinalizer(cleanup)
    return res