Тестирование HTTP API

## От ручного к автоматизированному тестированию API Если вы тестировали API через REST-клиент, вы знаете этот цикл: отправить запрос, просмотреть ответ, двигаться дальше. Автоматизированные тесты API делают ровно то же самое -- но повторяемо, за миллисекунды, и сигнализируют в момент, когда что-то регрессировало. С pytest и библиотекой `requests` API-тест выглядит почти идентично ручной проверке: ```python import requests def test_products_list(): resp = requests.get('https://apilearn.tukas.dev/api/products/') assert resp.status_code == 200 ``` Разница: это запускается автоматически при каждом пуше, без чьего-либо участия. ## Что проверять в API-тесте Проверяйте послойно -- каждый слой строится на предыдущем: 1. **Код статуса** -- сервер вообще отвечает, и с правильным кодом? 2. **Структура JSON** -- есть ли в ответе ожидаемые ключи? 3. **Значения** -- верны ли конкретные значения для этого входа? ```python def test_products_list(): resp = requests.get('https://apilearn.tukas.dev/api/products/') assert resp.status_code == 200 # слой 1: статус data = resp.json() assert 'results' in data # слой 2: структура assert 'count' in data assert isinstance(data['results'], list) # слой 2: тип assert len(data['results']) > 0 # слой 3: значение ``` Начинайте с кода статуса. Если он неверный, остальное -- шум: тело ответа может оказаться страницей ошибки, а не JSON вообще. ## BASE_URL: одно место для изменения Определите базовый URL API один раз и ссылайтесь на него везде. Это делает переключение между окружениями (staging, local, production) однострочным изменением: ```python BASE_URL = 'https://apilearn.tukas.dev' def test_products(): resp = requests.get(f'{BASE_URL}/api/products/') assert resp.status_code == 200 ``` Ещё лучше -- поместите в `conftest.py` как фикстуру: все тестовые файлы разделяют её, и можно переопределить для конкретной директории. ## Аутентификация: вынести в фикстуру Повторять логин в каждом тесте хрупко. Вынесите в фикстуру: ```python # conftest.py import pytest import requests BASE_URL = 'https://apilearn.tukas.dev' @pytest.fixture(scope='session') def auth_token(base_url): resp = requests.post(f'{base_url}/api/auth/token/', json={ 'username': 'testuser', 'password': 'TestUser2024!', }) resp.raise_for_status() return resp.json()['token'] @pytest.fixture def auth_headers(auth_token): return {'Authorization': f'Token {auth_token}'} ``` Любой тест, требующий аутентификации, принимает `auth_headers` как параметр -- pytest внедряет его: ```python def test_profile(base_url, auth_headers): resp = requests.get(f'{base_url}/api/users/profile/', headers=auth_headers) assert resp.status_code == 200 ``` Session scope для `auth_token` означает, что вызов логина происходит один раз за прогон тестов, а не один раз за тест. ## Проектирование изолированных, повторяемых тестов Хороший API-тест: - **Не зависит от порядка выполнения тестов** -- либо читает публичные/стабильные данные, либо настраивает собственное состояние - **Не оставляет побочных эффектов**, нарушающих другие тесты -- используйте yield-фикстуры для очистки созданного - **Проверяет конкретно** -- проверяйте конкретные значения, а не просто что ответ не пуст Для read-only эндпоинтов (GET) тесты естественно изолированы. Для операций записи очищайте через yield-фикстуру: ```python @pytest.fixture def created_cart_item(base_url, auth_headers): resp = requests.post( f'{base_url}/api/cart/items/', json={'product_id': 1, 'quantity': 1}, headers=auth_headers, ) item_id = resp.json()['id'] yield item_id requests.delete(f'{base_url}/api/cart/items/{item_id}/', headers=auth_headers) ``` ## requests.Response -- что получаете в ответе ```python resp = requests.get(url, headers={}, params={}) resp.status_code # int: 200, 201, 404, 500 и т.д. resp.json() # dict или list -- распарсенное тело JSON resp.text # str -- сырое тело ответа resp.headers # dict-подобный -- заголовки ответа (ключи без учёта регистра) resp.url # str -- финальный URL после редиректов resp.history # list -- промежуточные ответы в цепочке редиректов resp.raise_for_status() # выбрасывает requests.HTTPError если status_code >= 400 ```