FastAPI の自動テスト

FastAPI入門

Matt Eckerle

Software and Data Engineering Leader

自動テストとは？

ユニットテスト

焦点: 個別のコード
目的: 関数の正当性を検証
範囲: 関数／メソッド
環境: 分離された Python 環境

def test_main():
    response = main()
    assert response == {"msg": "Hello"}

システムテスト

焦点: システムの個別動作
目的: システム機能の検証
範囲: エンドポイント
環境: アプリ稼働中の Python 環境

def test_read_main():
    response = client.get("/")
    assert response.status_code == 200
    assert response.json() == {"msg": 
                               "Hello"}

TestClient の使い方

TestClient: pytest 用の HTTP クライアント

# TestClient とアプリをインポート
from fastapi.testclient import TestClient
from .main import app

# アプリのコンテキストでクライアント作成
client = TestClient(app)


def test_main():
    response = client.get("/")
    assert response.status_code == 200
    assert response.json() == {"msg": "Hello"}

エラー／失敗レスポンスのテスト

アプリ

app = FastAPI()

@app.delete("/items")
def delete_item(item: Item):
    if item.id not in item_ids:
        raise HTTPException(
            status_code=404, 
            detail="Item not found.")
    else:
        delete_item_in_database(item)
        return {}

テスト

def test_delete_nonexistent_item():
    response = client.delete(
        "/items",
        json={"id": -999})
    assert response.status_code == 404
    json = response.json()
    assert json == {"detail":
                    "Item not found."}

Let's practice!

FastAPI入門