Тестування 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 ``` Оголошення `auth_token` session-scoped означає, що виклик входу відбувається один раз за запуск тестів, а не один раз за тест. ## Проектування ізольованих, відтворюваних тестів Хороший 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 ```