Colin's Blog
FastAPI에서 유닛 테스트 자동화하기

FastAPI는 빠르고 간편한 웹 프레임워크로서 API 개발을 쉽게 할 수 있습니다. 하지만 개발한 API가 원활하게 동작하는지 확인하기 위해서는 유닛 테스트를 자동화하는 것이 중요합니다. 이번 글에서는 FastAPI에서 유닛 테스트를 자동화하는 방법에 대해 알아보겠습니다.

1. pytest 설치하기

FastAPI에서 유닛 테스트를 자동화하기 위해서는 pytest를 사용할 수 있습니다. pytest는 파이썬 테스트 프레임워크로서 다양한 유닛 테스트 기능을 제공합니다. 먼저 pytest를 설치해야 합니다. 아래의 명령어를 실행하여 pytest를 설치합니다.

pip install pytest

2. 유닛 테스트 작성하기

FastAPI에서 유닛 테스트를 작성하기 위해서는 다음과 같은 단계를 따릅니다.

  1. FastAPI 애플리케이션을 테스트하고 싶은 모듈로 가져옵니다.
  2. pytest.fixture를 사용하여 테스트 환경을 설정합니다.
  3. 테스트 함수를 작성합니다. 이 테스트 함수는 pytest.fixture에서 설정한 환경을 이용하여 FastAPI 애플리케이션을 실행하고 결과를 검증합니다.
from fastapi.testclient import TestClient
import pytest
from main import app

@pytest.fixture()
def client():
    client = TestClient(app)
    return client

def test_get_user(client):
    response = client.get("/user/1")
    assert response.status_code == 200
    assert response.json() == {"id": 1, "name": "John Doe"}

위의 예제에서는 /user/1 엔드포인트를 호출하여 결과를 검증하는 유닛 테스트를 작성했습니다.

3. 유닛 테스트 실행하기

이제 작성한 유닛 테스트를 실행해보겠습니다. 터미널에서 다음 명령어를 실행합니다.

pytest

위의 명령어를 실행하면 pytest가 현재 디렉토리와 그 하위 디렉토리에서 자동으로 유닛 테스트를 찾아 실행합니다. 실행 결과는 터미널에서 확인할 수 있습니다.

4. 추가적인 테스트 작성하기

위의 예제에서는 하나의 유닛 테스트만 작성했지만, 필요에 따라 더 많은 테스트를 작성할 수 있습니다. 여러 각도에서 API의 동작을 확인하는 것이 좋습니다. 예를 들어 다음과 같은 테스트를 작성할 수 있습니다.

def test_get_user_not_found(client):
    response = client.get("/user/100")
    assert response.status_code == 404
    assert response.json() == {"detail": "User not found"}

def test_create_user(client):
    data = {"name": "Alice"}
    response = client.post("/user", json=data)
    assert response.status_code == 201
    assert response.json() == {"id": 2, "name": "Alice"}

위의 예제에서는 유저가 존재하지 않는 경우와 새로운 유저를 생성하는 테스트를 추가했습니다. 이처럼 다양한 테스트 케이스를 작성하여 API의 예외 상황을 확인하는 것이 중요합니다.

결론

FastAPI에서 유닛 테스트를 자동화하는 방법에 대해 알아보았습니다. pytest를 사용하여 간편하고 효율적으로 유닛 테스트를 작성할 수 있습니다. 다양한 테스트 케이스를 작성하여 API의 동작을 확실히 확인하는 것이 좋습니다. 유닛 테스트를 통해 안정적이고 신뢰성 높은 API를 개발할 수 있습니다.

#FastAPI #유닛테스트

© 2018 Colin. All rights reserved.