playwright-flakyzavr

playwright-flakyzavr

Playwright-репортер, который автоматически создает тикеты в Jira при падении тестов. Вдохновлен Python-плагином flakyzavr.

Возможности

• Автоматическое создание Jira-тикетов при падении тестов
• Поиск существующих тикетов (дедупликация) — если тикет уже есть, добавляет комментарий
• Фильтрация ошибок по regex-паттернам (не создавать тикеты для определенных ошибок)
• Dry-run режим — логирование без создания тикетов
• Шаблоны сообщений на русском и английском
• Token-based аутентификация в Jira
• Интеграция с CI/CD — ссылка на джоб в тикете
• skipOnError — пометка тестов как skipped вместо failed при определенных ошибках

Установка

npm install playwright-flakyzavr

Использование

Репортер

Добавь репортер в playwright.config.ts:

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['list'],
    ['playwright-flakyzavr', {
      jiraServer: 'https://jira.example.com',
      jiraToken: process.env.JIRA_TOKEN,
      jiraProject: 'QA',
      jiraLabels: ['flaky', 'autotest'],
      jiraComponents: ['UI'],
      jobPath: 'https://ci.example.com/jobs/{job_id}',
      reportingLang: 'ru',
    }],
  ],
});

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

Параметр	Обязательный	По умолчанию	Описание
jiraServer	да	—	URL Jira-сервера
jiraToken	да	—	API-токен для аутентификации (PAT для Server/DC, API token для Cloud)
jiraProject	да	—	Ключ проекта в Jira (например QA)
jiraAuthType	нет	'server'	Тип авторизации: 'cloud' (Basic email:token) или 'server' (Bearer PAT)
jiraEmail	при cloud	—	Email аккаунта Jira, обязателен при jiraAuthType: 'cloud'
jiraLabels	нет	['flaky']	Метки для создаваемых тикетов
jiraComponents	нет	—	Компоненты Jira
jiraIssueTypeId	нет	'Bug'	Тип тикета
jiraSearchStatuses	нет	['Open', 'In Progress', 'Reopened']	Статусы для поиска существующих тикетов
jiraAdditionalData	нет	—	Дополнительные поля Jira
reportEnabled	нет	true	Включить/выключить репортер
dryRun	нет	false	Режим без создания тикетов (только логи)
reportProjectName	нет	jiraProject	Имя проекта в отчетах
jobPath	нет	—	Шаблон URL джоба CI/CD. Плейсхолдер {job_id} подставляется из CI_JOB_ID, BUILD_ID или GITHUB_RUN_ID
exceptions	нет	—	Regex-паттерны ошибок, для которых НЕ создавать тикеты
reportingLang	нет	'en'	Язык шаблонов: 'en' или 'ru'

Пример для Jira Cloud

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['playwright-flakyzavr', {
      jiraServer: 'https://myorg.atlassian.net',
      jiraAuthType: 'cloud',
      jiraEmail: '[e-mail]',
      jiraToken: process.env.JIRA_API_TOKEN,
      jiraProject: 'QA',
    }],
  ],
});

Совместимость с Jira Server / DC

Под капотом используется jira.js, которая официально поддерживает только Jira Cloud. На практике базовые операции репортера (поиск / создание тикета / комментарий) работают и Jira Server/DC через REST API v2 с Bearer PAT (jiraAuthType: 'server'), но 100% совместимость не гарантируется — в отдельных эндпоинтах возможны Cloud-специфичные поля. Если столкнёшься с проблемой — заведи issue.

skipOnError

Три способа пометить тест как skipped при определенных ошибках:

• @SkipOnError — декоратор для методов класса
• withSkipOnError — обертка для тест-функции
• skipOnError — вызов внутри теста

Если ошибка совпадает с паттерном — тест помечается - (skipped), если не совпадает — падает как обычно.

Примеры использования: example/skip.spec.ts

Лицензия

MIT