Как тестировать FastAPI: пошаговая инструкция с нуля

Современная веб-разработка требует не только быстрого создания API, но и обеспечения их надежности. FastAPI, благодаря своей скорости и простоте, стал одним из фаворитов для построения API на Python. Однако без качественного тестирования даже самый элегантный код может стать источником проблем. Тестирование — это не роскошь, а необходимость, которая экономит время на отладке и повышает уверенность в развертывании. Данная инструкция проведет вас от основ настройки тестового окружения до продвинутых техник тестирования вашего FastAPI-приложения.

Первым шагом является настройка среды. Убедитесь, что у вас установлен Python (рекомендуется версия 3.7+). Создайте виртуальное окружение, чтобы изолировать зависимости проекта. Активируйте его и установите необходимые пакеты: `pip install fastapi uvicorn pytest httpx pytest-asyncio`. Pytest будет нашим основным фреймворком для тестирования, а httpx — асинхронным HTTP-клиентом для отправки запросов к нашему приложению в тестах.

Рассмотрим простое приложение для примера. Создайте файл `main.py`. В нем определим базовое API для управления списком задач (To-Do). Импортируйте FastAPI, создайте экземпляр приложения и определите несколько эндпоинтов: для получения списка задач и добавления новой. Не забудьте использовать Pydantic модели для валидации данных запроса и ответа.

Теперь создайте структуру для тестов. Рекомендуется создать директорию `tests` на одном уровне с `main.py`. Внутри создайте файл `test_main.py`. Первое, что нужно протестировать — это сами Pydantic модели. Напишите тест, который проверяет валидацию данных: как корректные данные создают экземпляр модели, так и некорректные — вызывают ожидаемые ошибки. Это основа для надежности вашего API.

Следующий уровень — тестирование отдельных функций (юнит-тесты). Если в вашем приложении есть сложная бизнес-логика, вынесенная в отдельные функции, например, функция форматирования данных или вычислений, протестируйте их изолированно. Импортируйте функцию напрямую и проверьте ее выходные данные для различных входных. Это быстрые и надежные тесты.

Самое важное — интеграционное тестирование эндпоинтов. Для этого мы будем использовать `TestClient` из `fastapi.testclient`. Импортируйте ваше приложение (`app`) из `main.py` и создайте клиент: `client = TestClient(app)`. Напишите тест для GET-запроса к корневому эндпоинту или эндпоинту `/tasks`. Проверьте статус-код ответа (должен быть 200 OK) и структуру возвращаемых данных.

Для тестирования POST-запросов используйте метод `client.post()`. Передайте JSON-данные и проверьте, что статус-код ответа соответствует ожидаемому (например, 201 Created), а в ответе содержатся отправленные данные, возможно, с добавленным идентификатором. Также обязательно протестируйте обработку ошибок. Отправьте некорректные данные (например, строку вместо числа в поле) и убедитесь, что API возвращает статус 422 Unprocessable Entity с деталями ошибки.

FastAPI часто используется для асинхронных эндпоинтов. Для их тестирования с `httpx` потребуется немного другой подход. Создайте асинхронную фикстуру в Pytest, которая будет запускать ваше приложение в фоне, и используйте асинхронный клиент `AsyncClient`. Это позволяет тестировать асинхронные зависимости и фоновые задачи более точно.

Не забывайте про тестирование зависимостей (Dependencies). Если ваши эндпоинты используют `Depends()` для внедрения, например, проверки JWT-токена или получения объекта базы данных, вам нужно уметь их мокать (подменять) в тестах. Используйте `app.dependency_overrides` для временной подмены зависимости на упрощенную тестовую версию. Это мощный инструмент для изоляции тестов.

Тестирование базы данных — отдельная важная задача. Используйте тестовую базу данных, например, SQLite в памяти, или инструменты вроде `pytest-postgresql` для создания временных инстансов. В фикстурах Pytest настраивайте соединение с тестовой БД, создавайте таблицы перед каждым тестом и очищайте их после. Это гарантирует, что тесты не влияют друг на друга и выполняются в изолированном состоянии.

Наконец, настройте непрерывную интеграцию (CI). Добавьте файл `.github/workflows/test.yml`, если используете GitHub, который будет запускать вашу тестовую suite при каждом пуше в репозиторий. Это автоматизирует проверку и предотвратит слияние кода с broken тестами.

В заключение, помните, что хорошее покрытие тестами — это баланс между скоростью разработки и надежностью. Начните с критических путей (основные эндпоинты, валидация), затем добавляйте тесты для edge cases. Используйте `pytest-cov` для отслеживания покрытия кода. Постепенно выстроив культуру тестирования, вы сделаете процесс разработки на FastAPI предсказуемым и профессиональным.