테스트

Starlette 덕분에 FastAPI 애플리케이션을 쉽고 즐겁게 테스트할 수 있습니다. .

요청을 기반으로 하므로 매우 친숙하고 직관적입니다.

이를 통해 FastAPI와 함께 pytest를 직접 사용할 수 있습니다.

TestClient 사용

TestClient를 가져옵니다.

FastAPI 애플리케이션에 전달하는 TestClient를 생성합니다.

test_로 시작하는 이름으로 함수를 생성합니다 (표준 pytest 규칙).

requests와 동일한 방식으로 TestClient 객체를 사용합니다.

확인해야 하는 표준 Python 표현식으로 간단한 assert 문을 작성합니다(표준 pytest 규칙).

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()


@app.get("/")
async def read_main():
    return {"msg": "Hello World"}


client = TestClient(app)


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

팁

테스트 함수는 async def가 아닌 일반 def입니다.

그리고 클라이언트에 대한 호출도 await를 사용하지 않는 일반 호출입니다.

이렇게 하면 복잡함 없이 pytest를 직접 사용할 수 있습니다.

기술적 세부 사항

from starlette.testclient import TestClient를 통해 사용할 수 있습니다.

FastAPI는 개발자 여러분의 편의를 위해 fastapi.testclient와 동일한 starlette.testclient를 제공합니다. 그러나 그것은 Starlette에서 직접 제공됩니다.

팁

FastAPI 애플리케이션(예: 비동기 데이터베이스 함수)에 요청을 보내는 것과 별도로 테스트에서 async 함수를 호출하려면 고급 자습서의 Async Tests 를 살펴보십시오.

테스트 분리

실제 애플리케이션에서는 테스트가 다른 파일에 있을 수 있습니다.

그리고 FastAPI 애플리케이션은 여러 파일/모듈 등으로 구성될 수도 있습니다.

FastAPI 앱 파일

FastAPI 앱에 main.py 파일이 있다고 가정해 보겠습니다.

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def read_main():
    return {"msg": "Hello World"}

테스트 파일

그런 다음 테스트와 함께 test_main.py 파일을 만들고 main 모듈(main.py)에서 app을 가져올 수 있습니다.

from fastapi.testclient import TestClient

from .main import app

client = TestClient(app)


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

테스트: 확장된 예제

이제 이 예제를 확장하고 세부 사항을 추가하여 다른 부분을 테스트하는 방법을 살펴보겠습니다.

확장된 FastAPI 앱 파일

FastAPI 앱에 main_b.py 파일이 있다고 가정해 보겠습니다.

오류를 반환할 수 있는 GET 작업이 있습니다.

여러 오류를 반환할 수 있는 POST 작업이 있습니다.

두 경로 작업 모두 X-Token 헤더가 필요합니다.

Python 3.6 이상 버전Python 3.10 이상 버전

from typing import Union

from fastapi import FastAPI, Header, HTTPException
from pydantic import BaseModel

fake_secret_token = "coneofsilence"

fake_db = {
    "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
    "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
}

app = FastAPI()


class Item(BaseModel):
    id: str
    title: str
    description: Union[str, None] = None


@app.get("/items/{item_id}", response_model=Item)
async def read_main(item_id: str, x_token: str = Header()):
    if x_token != fake_secret_token:
        raise HTTPException(status_code=400, detail="Invalid X-Token header")
    if item_id not in fake_db:
        raise HTTPException(status_code=404, detail="Item not found")
    return fake_db[item_id]


@app.post("/items/", response_model=Item)
async def create_item(item: Item, x_token: str = Header()):
    if x_token != fake_secret_token:
        raise HTTPException(status_code=400, detail="Invalid X-Token header")
    if item.id in fake_db:
        raise HTTPException(status_code=400, detail="Item already exists")
    fake_db[item.id] = item
    return item

from fastapi import FastAPI, Header, HTTPException
from pydantic import BaseModel

fake_secret_token = "coneofsilence"

fake_db = {
    "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
    "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
}

app = FastAPI()


class Item(BaseModel):
    id: str
    title: str
    description: str | None = None


@app.get("/items/{item_id}", response_model=Item)
async def read_main(item_id: str, x_token: str = Header()):
    if x_token != fake_secret_token:
        raise HTTPException(status_code=400, detail="Invalid X-Token header")
    if item_id not in fake_db:
        raise HTTPException(status_code=404, detail="Item not found")
    return fake_db[item_id]


@app.post("/items/", response_model=Item)
async def create_item(item: Item, x_token: str = Header()):
    if x_token != fake_secret_token:
        raise HTTPException(status_code=400, detail="Invalid X-Token header")
    if item.id in fake_db:
        raise HTTPException(status_code=400, detail="Item already exists")
    fake_db[item.id] = item
    return item

확장 테스트 파일

다음으로 확장 테스트를 통해 이전과 동일한 test_main_b.py를 가질 수 있습니다.

from fastapi.testclient import TestClient

from .main import app

client = TestClient(app)


def test_read_item():
    response = client.get("/items/foo", headers={"X-Token": "coneofsilence"})
    assert response.status_code == 200
    assert response.json() == {
        "id": "foo",
        "title": "Foo",
        "description": "There goes my hero",
    }


def test_read_item_bad_token():
    response = client.get("/items/foo", headers={"X-Token": "hailhydra"})
    assert response.status_code == 400
    assert response.json() == {"detail": "Invalid X-Token header"}


def test_read_inexistent_item():
    response = client.get("/items/baz", headers={"X-Token": "coneofsilence"})
    assert response.status_code == 404
    assert response.json() == {"detail": "Item not found"}


def test_create_item():
    response = client.post(
        "/items/",
        headers={"X-Token": "coneofsilence"},
        json={"id": "foobar", "title": "Foo Bar", "description": "The Foo Barters"},
    )
    assert response.status_code == 200
    assert response.json() == {
        "id": "foobar",
        "title": "Foo Bar",
        "description": "The Foo Barters",
    }


def test_create_item_bad_token():
    response = client.post(
        "/items/",
        headers={"X-Token": "hailhydra"},
        json={"id": "bazz", "title": "Bazz", "description": "Drop the bazz"},
    )
    assert response.status_code == 400
    assert response.json() == {"detail": "Invalid X-Token header"}


def test_create_existing_item():
    response = client.post(
        "/items/",
        headers={"X-Token": "coneofsilence"},
        json={
            "id": "foo",
            "title": "The Foo ID Stealers",
            "description": "There goes my stealer",
        },
    )
    assert response.status_code == 400
    assert response.json() == {"detail": "Item already exists"}

클라이언트가 요청에 정보를 전달해야 하는데 방법을 모를 때마다 '요청'에서 방법을 검색할 수 있습니다(Google).

그런 다음 테스트에서 동일한 작업을 수행합니다.

예:

• 경로 혹은 쿼리 매개변수를 전달하려면 URL 자체에 추가하십시오.
• JSON 본문을 전달하려면 파이썬 객체(예: dict)를 매개변수 json에 전달합니다.
• JSON 대신 데이터에서 보내야 한다면 data 매개변수를 대신 사용하십시오.
• headers를 전달하려면 headers 매개변수에 dict를 사용하십시오.
• cookies의 경우 cookies 매개변수의 dict.

데이터를 백엔드에 전달하는 방법(requests 또는 TestClient 사용)에 대한 자세한 내용은 문서 요청을 확인하십시오.

정보

TestClient는 Pydantic 모델이 아닌 JSON으로 변환할 수 있는 데이터를 수신합니다.

테스트에 Pydantic 모델이 있고 테스트 중에 해당 데이터를 애플리케이션으로 보내려면 JSON 호환 인코더에 설명된 jsonable_encoder를 사용할 수 있습니다. .

실행

그런 다음 pytest를 설치하기만 하면 됩니다.

$ pip install pytest

---> 100%

파일과 테스트를 자동으로 감지하고 실행하여 결과를 다시 보고합니다.

다음을 사용하여 테스트를 실행합니다.

$ pytest

================ test session starts ================
platform linux -- Python 3.6.9, pytest-5.3.5, py-1.8.1, pluggy-0.13.1
rootdir: /home/user/code/superawesome-cli/app
plugins: forked-1.1.3, xdist-1.31.0, cov-2.8.1
collected 6 items

---> 100%

test_main.py <span style="color: green; white-space: pre;">......                            [100%]</span>

<span style="color: green;">================= 1 passed in 0.03s =================</span>