Кодогенератор для автотестов API на Python: как выбрать и настроить

При разработке автотестов для веб-проекта с микросервисами и частыми изменениями API важно выбрать правильный инструмент для генерации клиента. От этого зависит скорость написания тестов, их читаемость и удобство поддержки. В этой статье разберём популярные генераторы - openapi-python-client и openapi-generator - и покажем, как решить типовые проблемы.

Почему стоит использовать кодогенератор для тестов API?

Ручное написание клиента для каждого эндпоинта - трудоёмкий процесс, особенно когда OpenAPI-спецификации часто меняются. Генератор автоматически создаёт классы для работы с API, что ускоряет разработку и снижает количество ошибок. Для тестировщика, который только входит в автоматизацию, это особенно важно: готовый клиент позволяет сосредоточиться на логике тестов, а не на деталях HTTP-запросов.

Сравнение популярных кодогенераторов

openapi-python-client

Этот генератор создаёт асинхронный клиент на базе httpx. Он прост в настройке: достаточно установить пакет и выполнить команду генерации. Однако у него есть особенности, которые могут усложнить написание тестов:

• Клиент не возвращает готовый объект ответа - требуется дополнительное преобразование, что увеличивает объём тестового кода.
• Каждый эндпоинт генерируется как отдельный модуль, что приводит к неудобным импортам.
• Сложно вынести фасад с авторизацией: приходится создавать клиента внутри каждого теста.

Эти проблемы можно решить, если написать небольшую обёртку над сгенерированным клиентом, но это требует дополнительного времени.

openapi-generator

Более гибкий инструмент, поддерживающий множество языков. Для Python он генерирует клиент, где все эндпоинты объединены в один модуль, что упрощает импорты. Эндпоинты вызываются как методы одного объекта, что делает код тестов компактнее. Однако openapi-generator может быть сложнее в настройке и требует больше ресурсов для генерации.

Как решить типовые проблемы при работе с кодогенератором

1. Преобразование ответа

Если клиент возвращает сырой ответ (например, httpx.Response), напишите небольшую утилиту-парсер. Например, можно создать метод, который сразу возвращает JSON или объект Pydantic. Это избавит от дублирования кода в каждом тесте.

2. Вынос фасада с авторизацией

Создайте класс-фасад, который инициализирует клиента с нужными заголовками (токенами). Этот фасад можно вызывать в фикстурах pytest. Пример:

import pytest
from my_client import AuthenticatedClient

@pytest.fixture
def api_client():
    client = AuthenticatedClient(base_url='https://api.example.com', token='my_token')
    yield client
    client.close()

3. Инициализация клиента в фикстурах

Фикстуры pytest - идеальное место для создания клиента. Вы можете определить фикстуру один раз и использовать её во всех тестах. Это сокращает дублирование и упрощает поддержку, особенно если параметры подключения меняются.

4. Удобные импорты

Если генератор создаёт много модулей, создайте файл __init__.py, который реэкспортирует все нужные классы. Тогда в тестах можно писать from my_client import Client, ModelX, ModelY вместо длинных путей.

Лучшие практики для проекта с микросервисами

Если у вас несколько OpenAPI-спецификаций (монолит + микросервисы), рассмотрите следующие подходы:

• Используйте единую конфигурацию: храните все спецификации в одной папке и генерируйте клиенты для каждого сервиса отдельно.
• Автоматизируйте генерацию: добавьте скрипт, который перегенерирует клиенты при каждом обновлении спецификаций (например, через CI/CD).
• Версионируйте сгенерированный код: коммитьте его в репозиторий, чтобы избежать неожиданных изменений при перегенерации.

Вывод

Для старта с автотестами API на Python openapi-python-client подойдёт, если вы готовы написать небольшую обёртку для удобства. Если же вам важна компактность кода и удобные импорты, присмотритесь к openapi-generator. В любом случае, используйте фикстуры pytest для инициализации клиента и автоматизируйте генерацию при изменении спецификаций.