読み方のヒント

矢印ボタン(または ← → キー)でページを移動できます。

第3節 テストと段階的な変更

3.1 APIのテストを先に書く

受け入れ条件A-1、A-2、A-4を、APIのテストにします。tests/test_status_filter.py です。

def test_without_status_returns_all_as_before():
    response = client.get("/reservations", headers=login("takahashi"))
    assert [r["id"] for r in response.json()] == ["R-0003"]


@pytest.mark.parametrize(("status", "expected"), [("cancelled", ["R-0003"]), ("reserved", [])])
def test_filter_by_status(status, expected):
    response = client.get("/reservations", params={"status": status}, headers=login("takahashi"))
    assert response.status_code == 200
    assert [r["id"] for r in response.json()] == expected


def test_unknown_status_is_422():
    response = client.get("/reservations", params={"status": "done"}, headers=login("takahashi"))
    assert response.status_code == 422
    assert response.json()["detail"][0]["loc"] == ["query", "status"]

APIを変える前に実行すると、絞り込みのテストと 422 のテストが失敗します。status のクエリが、まだ無視されているためです。

APIの list_my_reservations を変えます。

@router.get("/reservations", response_model=list[ReservationDetail])
def list_my_reservations(
    session: SessionDep,
    user: CurrentUser,
    status: Literal["reserved", "picked_up", "cancelled"] | None = None,
):
    statement = select(Reservation).where(Reservation.user_id == user.id).order_by(Reservation.pickup_at)
    if status is not None:
        statement = statement.where(Reservation.status == status)
    return [service.to_detail(r) for r in session.scalars(statement).all()]

Literal["reserved", "picked_up", "cancelled"] は、この3つの文字のどれかだけを受け付ける型です。それ以外の値は、FastAPIが 422 で断ります(Input should be 'reserved', 'picked_up' or 'cancelled')。

........................                                                 [100%]
24 passed in 1.49s

前からあった20個のテストと、加えた4個のテストが、すべて通りました。

10 / 20