Skip to main content

Persona DSL - Framework for implementing Screenplay pattern in Python tests

Project description

persona-dsl: Фреймворк для автотестов на Python

persona-dsl — это современная библиотека для написания E2E и API автотестов, реализующая паттерн Screenplay. Она предоставляет выразительный язык для описания сценариев, управляет браузером (через Playwright) и автоматически генерирует детальные отчеты Allure.

📦 Установка

pip install persona-dsl
python -m playwright install --with-deps

🚀 Быстрый старт

1. Описание страницы (Page Object)

В persona-dsl используется Универсальная Архитектура Элементов. Основной класс Page сам является элементом-контейнером. Вложенные элементы добавляются через add_element.

# pages/login_page.py
from persona_dsl.pages import Page
from persona_dsl.pages.elements import Input, Button

class LoginPage(Page):
    def __init__(self):
        super().__init__()
        # Имя атрибута (self.username) будет использовано как имя элемента в отчетах
        self.username = self.add_element(Input(xpath="//input[@id='user']", name="Логин"))
        self.password = self.add_element(Input(xpath="//input[@id='pass']", name="Пароль"))
        self.submit   = self.add_element(Button(xpath="//button[@type='submit']", name="Вход"))

2. Написание теста

Тесты пишутся в стиле "Persona делает действия":

# tests/test_login.py
import pytest
from persona_dsl.ops.web import NavigateTo, Fill, Click
from persona_dsl.facts.web import CurrentPath
from persona_dsl.expectations.web import IsEqualTo
from pages.login_page import LoginPage

def test_login_flow(persona):
    login_page = LoginPage()

    # 1. Действия (Actions)
    persona.make(
        NavigateTo("/login"),
        Fill(login_page.username, "admin"),
        Fill(login_page.password, "secret"),
        Click(login_page.submit)
    )

    # 2. Проверка (Verification)
    # Получаем Факт (CurrentPath) и проверяем Ожидание (IsEqualTo)
    current_path = persona.get(CurrentPath())
    persona.check(current_path, IsEqualTo("/dashboard"))

🏗 Архитектура

1. Ключевые компоненты (Persona Core)

Компонент Назначение Пример
Persona Исполнитель. Хранит состояние и навыки. persona.make(...)
Skill "Навык". Дает доступ к инструментам. UseBrowser, UseAPI, UseDB
Ops Атомарная операция. Работает со Skill. Click, HttpRequest, ExecuteSQL
Step Бизнес-шаг. Группирует Ops. LoginStep, CreateOrder
Fact Запрос состояния (без изменений). CurrentPath, ElementText
Expectation Проверка значения. IsEqualTo, ContainsText

2. Универсальные Элементы (New!)

Больше нет разделения на Element и ElementContainer. Любой элемент может содержать другие элементы.

  • element.add_element(...): Регистрирует дочерний элемент.
  • Иерархия: Page -> Container -> Element.
  • Локаторы: Строятся автоматически по цепочке родителей.

3. Генераторный подход

Все шаги (Step, CombinedStep) — это генераторы, которые "выдают" (yield) операции для исполнения Персоной. Это позволяет persona-dsl перехватывать каждый шаг, логировать его в Allure и обрабатывать ошибки.


🛠 Инструменты и Утилиты

Генерация Page Objects

Не пишите селекторы вручную. Используйте генератор:

# Снять ARIA-снапшот и сгенерировать класс страницы
persona-page-gen --url http://localhost:8080 --output pages/home.py

Генерация API клиентов

# Генерация из OpenAPI/Swagger
persona-api-gen --url http://api.example.com/openapi.json --output skills/my_api.py

Запуск тестов

Тесты запускаются стандартной командой pytest:

pytest --env=dev tests/

⚙️ Конфигурация

conftest.py

Декларативное описание навыков и ролей:

PERSONA_SKILLS = [BaseSkill.BROWSER, BaseSkill.API]

config/{env}.yaml

Параметры окружения (dev, test, prod). Выбирается через --env=test.

base_url: "https://my-app.test"
browser:
  headless: true
  viewport: { width: 1920, height: 1080 }
reporting:
  screenshot_on_fail: true

📊 Отчетность (Allure + TaaS)

Фреймворк автоматически:

  1. Создает вложенные Allure Steps для каждого действия.
  2. Прикрепляет Скриншоты и Page Source при падении.
  3. Логирует HTTP запросы/ответы (если включено).
  4. Интегрируется с платформой TaaS (Test as a Service) для аналитики.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

persona_dsl-26.1.21.30.tar.gz (98.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

persona_dsl-26.1.21.30-py3-none-any.whl (130.8 kB view details)

Uploaded Python 3

File details

Details for the file persona_dsl-26.1.21.30.tar.gz.

File metadata

  • Download URL: persona_dsl-26.1.21.30.tar.gz
  • Upload date:
  • Size: 98.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for persona_dsl-26.1.21.30.tar.gz
Algorithm Hash digest
SHA256 2042cc19ab6e74df332a21bd1dc0e54e5543413feacb2e2cbfa8bc66104ade93
MD5 4b8573ce22c67af57eedb89b1c5afa45
BLAKE2b-256 f9122dd38b71f9b134462072caa8b874c2611869c5d6291fba391eee45c960bb

See more details on using hashes here.

File details

Details for the file persona_dsl-26.1.21.30-py3-none-any.whl.

File metadata

File hashes

Hashes for persona_dsl-26.1.21.30-py3-none-any.whl
Algorithm Hash digest
SHA256 323b3f55688bed28a88424a03b7fa360959bb06b209deace6d7515e6a5ea6c84
MD5 65a229fffb0666d4ac6adca4a38579b2
BLAKE2b-256 a32262e7184d1a29d1978d53ed5732550cd8b17c98a6bb32f32f256f27b75402

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page