sputnikqa 0.0.3b1

Extensible test automation framework — built for QA engineers who value clean architecture and scalability.

🛰️ SputnikQA — Test Automation Framework

---

SputnikQA — это современный, типизированный и расширяемый фреймворк для написания автотестов на Python.

Идеально подходит для команд, которые хотят писать читаемые, надёжные и поддерживаемые автотесты.

Установка

# Основной пакет
pip install sputnikqa

# С интеграцией Allure
pip install sputnikqa[allure]

# С поддержкой httpx
pip install sputnikqa[httpx]

# С полной функциональностью (рекомендуется)
pip install sputnikqa[allure,httpx]

Основные возможности

• restapi booster

  • Типизированные модели ответов через Pydantic
  • Автоматическая валидация статуса и тела ответа
  • Декларативные секции API (BaseApiSection) — по аналогии с Page Object
  • Билдеры запросов — для удобного формирования тел и multipart-загрузок
  • Поддержка middleware — логирование, авторизация, retry и др.
  • Встроенная интеграция с Allure:
    • шаги с @allure.step
    • прикрепление cURL, статуса и тела ответа
  • Гибкий HTTP-клиент — поддержка httpx* и кастомных реализаций
  • Поддержка async/await через AsyncApiClient

  *Для использования httpx требуется установка дополнительной зависимости: pip install sputnikqa[httpx]

Пример использования

1. Определите модель ответа

from sputnikqa.boosters.restapi.response_models import JsonResponse

class Pet(JsonResponse):
    id: int | None = None
    name: str
    status: str

2. Создайте секцию API

from sputnikqa.boosters.restapi.sections.base import BaseApiSection

class PetSection(BaseApiSection):
    base_url = "https://petstore.swagger.io/v2"

    def get_pet_by_id(self, pet_id: int):
        response = self.client.get(self.url_join(f"/pet/{pet_id}"))
        return (
            self.validator(response)
            .validate_status(200)
            .validate_response_model({200: Pet})
        )

3. Напишите тест

def test_get_pet(pet_section):
    pet = pet_section.get_pet_by_id(1).get_validated_model()
    assert pet.name == "doggie"
    assert pet.status == "available"

Архитектура

sputnikqa/
├── boosters/
│   └── restapi/
│       ├── clients/          # HTTP-клиенты (httpx* и др.)
│       ├── middleware/       # Middleware (логирование, авторизация)
│       ├── request_builders/ # Билдеры (тело, файлы)
│       ├── response_models/  # Базовые модели ответов
│       ├── sections/         # Базовый класс секций
│       └── validators/       # Валидаторы ответов
└── integrations/
    └── allure/               # Интеграция с Allure

> *Клиент httpx доступен после установки: `pip install sputnikqa[httpx]`

Интеграции

Allure

Автоматически прикрепляет к отчёту:

• cURL-команду запроса
• HTTP-статус
• тело ответа

from sputnikqa.integrations.allure.client import ApiClientAllure
from sputnikqa.integrations.allure.middleware import AllureMiddleware
from sputnikqa.boosters.restapi.clients.httpx_client import HttpxClient

client = ApiClientAllure(HttpxClient(), middlewares=[AllureMiddleware()])

Требуется: pip install sputnikqa[allure,httpx]

Документация и примеры

Полный пример тестов для Petstore API доступен в репозитории:

• Пример: response_models.py
• Пример: sections/pet.py
• Пример: test_pet.py

Для разработчиков

Хотите расширить фреймворк?

• Реализуйте свой BaseHttpClient для кастомного HTTP-стека.
• Напишите middleware для авторизации, retry или трассировки.
• Используйте PrimitiveResponse для обёртки примитивов (str, int, dict).

Лицензия

Distributed under the MIT License. See LICENSE for more information.

---

SputnikQA — ваш надёжный спутник в мире автоматизации тестирования.

📌 PyPI: https://pypi.org/project/sputnikqa/
📌 GitVerse: https://gitverse.ru/crenom/SputnikQA