FastAPI 애플리케이션을 어떻게 테스트합니까?

Question

Accepted Answer

FastAPI는 **`TestClient`**(Starlette/httpx 기반)와 의존성을 목으로 만드는 것을 손쉽게 하는 **dependency injection** 시스템 덕분에 테스트하기 매우 좋습니다. 테스트는 일반적으로 `pytest`와 `TestClient`를 사용해, 실행 중인 서버 없이 앱에 요청을 보냅니다.

## TestClient로 기본 엔드포인트 테스트

```python
from fastapi.testclient import TestClient
from main import app

client = TestClient(app)

def test_read_item():
    response = client.get("/items/5")            # 프로세스 내에서 앱에 요청 전송
    assert response.status_code == 200
    assert response.json() == {"item_id": 5}

def test_create_item():
    response = client.post("/items", json={"name": "Phone", "price": 999})
    assert response.status_code == 201
    assert response.json()["name"] == "Phone"

def test_validation_error():
    response = client.post("/items", json={"name": "Phone"})   # price 누락
    assert response.status_code == 422                          # FastAPI가 자동 검증
```

`TestClient`는 프로세스 내에서 앱에 실제 요청을 보내므로(서버 불필요), 전체 흐름—라우팅, validation, 직렬화—을 테스트하고 상태 코드와 JSON 응답을 검증할 수 있습니다.

## 의존성 재정의 (깔끔한 테스트의 핵심)

```python
# 의존성을 목/테스트 버전으로 재정의 — 실제 데이터베이스 불필요
def override_get_db():
    return test_db_session

app.dependency_overrides[get_db] = override_get_db   # 실제 의존성을 교체

def test_with_test_db():
    response = client.get("/users")
    # 재정의를 통해 테스트 데이터베이스 사용
    app.dependency_overrides.clear()                 # 이후 리셋
```

FastAPI의 `dependency_overrides`는 **모든 의존성**(데이터베이스 세션, 인증, 외부 서비스)을 테스트 더블(test double)로 **대체**할 수 있게 합니다. 빠르고 격리된 테스트의 기반이며, DI 설계 덕분에 손쉽습니다.

## 보호된 엔드포인트 테스트

```python
def test_protected():
    # 인증 의존성을 재정의하여 로그인된 사용자를 시뮬레이션
    app.dependency_overrides[get_current_user] = lambda: fake_user
    response = client.get("/me")
    assert response.status_code == 200
```

## 테스트 전략

```text
✓ 테스트 데이터베이스 사용 (별도, 또는 테스트마다 트랜잭션 롤백)
✓ 격리를 위해 의존성 재정의 (DB, 인증, 외부 API)
✓ 테스트 대상: 상태 코드, 응답 형태, validation(422), 인증/권한, 엣지 케이스
✓ async 특화 코드에는 httpx.AsyncClient / pytest-asyncio 사용
✓ 도구: pytest, 테스트 데이터용 factory 라이브러리, coverage.py
```

## 왜 중요한가

테스트는 신뢰할 수 있는 애플리케이션에 필수적이며, FastAPI는 눈에 띄게 테스트하기 좋습니다. 어떻게 테스트하는지 이해하는 것은 코드 품질을 위해서도, 그리고 프레임워크가 테스트 가능성을 위해 *설계되었기* 때문에도 중요합니다.

**`TestClient`**는 전체 요청/응답 흐름을 프로세스 내에서 쉽게 테스트하게 하여(서버 불필요), 클라이언트가 경험하는 것과 똑같이 라우팅, validation, 직렬화, 응답을 검증합니다.

두드러진 기능은 **의존성 재정의**입니다: FastAPI가 dependency injection을 사용하므로, `app.dependency_overrides`를 통해 모든 의존성—데이터베이스 세션, 인증, 외부 서비스—을 테스트 더블로 손쉽게 대체하여, 실제 인프라 없이 빠르고 격리된 테스트가 가능합니다(이 테스트 가능성은 DI 설계의 주요 이점입니다).

TestClient를 사용하고, 격리를 위해 의존성을 재정의하며(테스트 데이터베이스, 목 처리된 인증/서비스), 보호된 엔드포인트를 테스트하고, 합리적인 테스트 전략(상태 코드, 응답 형태, validation, 인증, 엣지 케이스)을 구성하는 방법을 아는 것은 견고한 FastAPI 애플리케이션을 구축하기 위한 중요한 시니어 수준 지식입니다.

잘 테스트된 API는 회귀를 잡고 자신 있는 리팩터링을 가능하게 하며, FastAPI의 테스트 도구는 철저한 테스트를 간단하게 만들어, 이를 자주 관련되고 전문적으로 중요한 주제로 만듭니다.