3. API preconditions

UI-сценарій має пройти довгий user journey лише для того, щоб дістатися стану, який перевіряє тест. Якщо створення або пошук проєкту не є предметом перевірки, його можна підготувати через backend API й одразу відкрити сторінку за project_id.

Спочатку треба дослідити Network, але server-side rendering може приховати окремі XHR-запити. Тоді джерелом контракту стає офіційна OpenAPI/Swagger документація backend, а не припущення за URL інтерфейсу.

OpenAPI JSON/YAML можна передати AI-агенту, але велика специфікація легко перевищує корисний контекст. Не варто просити згенерувати клієнт для всього API, якщо зараз потрібна одна операція.

Практичний процес: знайти в документації endpoint, його operationId (getProjects), спосіб авторизації, parameters і response schema; потім дати агенту лише цей контракт і конкретну задачу.

У Testomat.io API token не обов’язково є готовим bearer token для всіх запитів: його може бути потрібно обміняти на JWT через login endpoint. Урок демонструє, чому тип авторизації треба перевіряти за документацією та реальною відповіддю API.

Секрет зберігається в environment variable, а не в коді. Постійне використання email/password додає зайвий запит і ширший секрет; token flow варто обирати лише якщо backend справді його підтримує.

Клієнт містить лише потрібні операції: authentication і get_projects. У прикладі використано httpx, хоча для синхронного сценарію стандартний для проєкту HTTP-клієнт також достатній; не слід додавати dependency лише через згенерований AI-код.

Авторизований client надається через pytest fixture. JWT кешується всередині instance, щоб кілька endpoint calls одного тестового lifecycle не повторювали login. Спочатку окремі API-тести перевіряють успішну авторизацію та непорожній список проєктів.

Raw dict змушує пам’ятати рядкові ключі й не дає надійного autocomplete. Response перетворюється на невелику Project dataclass із фактично потрібними полями, насамперед id та attributes.

Десеріалізація має відповідати реальній response schema. Не потрібно моделювати всі поля API «про запас»: для поточного vertical slice достатньо тих, які читає тест, з явною помилкою при відсутньому обов’язковому значенні.

from dataclasses import dataclass

@dataclass(frozen=True)
class Project:
    id: str

def parse_projects(payload: list[dict[str, str]]) -> list[Project]:
    return [Project(id=item["id"]) for item in payload]

assert parse_projects([{"id": "p-1"}]) == [Project("p-1")]

Тест викликає api_client.get_projects(), обирає цільовий проєкт і передає його id у метод project_page.open_by_id(). Це прибирає створення проєкту та пошук його URL через UI.

Перші падіння спричинені не API, а неправильним типом fixture: замість авторизованої page повернувся context або вже закрита сторінка. Setup повинен передавати саме ту page, яку створив і авторизував, без другого new_page().

Перевірка «порожній проєкт» не підходить для довільного existing project. Новий is_loaded спирається на стабільний sidebar/navigation, який існує і для порожнього, і для заповненого проєкту.

Далі тест відкриває dropdown створення артефактів і додає suite. Пошук locator уточнюється через видимий текст та структуру модалки, а не через крихкі CSS-класи іконки.

Модалки для Test і Suite мають схожий заголовок та форму. Спільний helper параметризується artifact_type, але лише там, де це справді одна поведінка; різні postconditions залишаються окремими й читабельними.

Після Save suite перевіряється за її назвою у списку. Демонстрація кілька разів падає через переплутані helpers і case-sensitive текст Suite, що показує цінність короткого red/green циклу для кожного locator.

API package містить client і мінімальні response models, fixture повертає авторизований client, а UI-тест використовує тільки потрібний endpoint для setup. Login token не перевипускається перед кожною операцією instance.

Практична вправа — реалізувати аналогічний precondition через наявний у проєкті HTTP client (requests, httpx або Playwright APIRequest), перевірити authentication окремо й лише потім під’єднати результат до UI-сценарію.