Интеграция с test management системами

Cypress — современный инструмент для автоматизации фронтенд-тестирования на JavaScript, обеспечивающий быстрый запуск и надежное управление тестами. В крупных проектах важной задачей становится интеграция с системами управления тестами (Test Management Systems, TMS), такими как Jira, TestRail, Zephyr и другие. Эта интеграция позволяет централизованно отслеживать выполнение тестов, поддерживать документацию и получать статистику качества.

Подходы к интеграции

Интеграция Cypress с TMS может быть реализована несколькими способами:

Через плагины и библиотеки Для популярных систем, таких как TestRail, существуют готовые библиотеки, позволяющие отправлять результаты тестов напрямую. Например, cypress-testrail-reporter автоматически формирует отчеты и обновляет статусы тест-кейсов в TestRail.
Через API систем управления тестами Если готового плагина нет, можно использовать REST API TMS. Cypress поддерживает выполнение HTTP-запросов с помощью команды cy.request(). Сценарий интеграции обычно включает:
- Авторизацию в API TMS.
- Формирование структуры данных теста (название, описание, статус, шаги).
- Отправку результатов после выполнения тестов (afterEach или after хуки).
Через CI/CD и промежуточные файлы Cypress может экспортировать результаты в формате JUnit, JSON или Mochawesome, которые затем передаются в TMS через CI/CD пайплайн. Этот способ удобен, когда API ограничены или интеграция через плагины невозможна.

Форматирование отчетов

Для корректного отображения результатов в TMS важно учитывать структуру отчетов:

JUnit Cypress поддерживает экспорт в формат JUnit с помощью cypress-mochawesome-reporter или mocha-junit-reporter. В отчете указываются:
- Название теста
- Результат (pass/fail)
- Время выполнения
- Ошибки и стектрейсы
Mochawesome JSON Предоставляет более детализированные отчеты, включая скриншоты и видео выполнения. JSON-файл можно парсить скриптом и отправлять данные в TMS.

Автоматизация отправки результатов

Пример интеграции через API TMS (на примере TestRail):

const axios = require('axios');

Cypress.on('test:after:run', (test, runnable) => {
  const status = test.state === 'passed' ? 1 : 5; // 1 - Passed, 5 - Failed
  const caseId = getCaseIdFromTest(runnable.title); // Функция извлечения ID тест-кейса

  axios.post('https://your-testrail-url/index.php?/api/v2/add_result_for_case/1/' + caseId, {
    status_id: status,
    comment: test.err ? test.err.message : 'Test passed successfully'
  }, {
    auth: {
      username: process.env.TESTRAIL_USER,
      password: process.env.TESTRAIL_API_KEY
    }
  }).catch(err => console.error('TestRail API error:', err));
});

Ключевые моменты:

test:after:run позволяет отправлять результаты после каждого теста.
Статусы тест-кейсов необходимо сопоставлять с TMS (например, passed, failed, blocked).
Идентификаторы тест-кейсов могут храниться в именах тестов или в тегах.

Использование тегов и аннотаций

Для интеграции с TMS полезно использовать теги, которые связывают тест с конкретным тест-кейсом. В Cypress это реализуется через Mocha it с дополнительной информацией или с помощью плагина cypress-grep:

it('C1234: Проверка авторизации пользователя', { tags: ['C1234'] }, () => {
  cy.visit('/login');
  cy.get('#username').type('user');
  cy.get('#password').type('password');
  cy.get('button[type=submit]').click();
  cy.contains('Добро пожаловать');
});

Тег C1234 можно использовать для автоматического сопоставления с тест-кейсом в TMS.

Ведение истории и повторное выполнение тестов

Интеграция Cypress с TMS позволяет:

Хранить историю выполнения тестов.
Отслеживать стабильность и флаки-тесты.
Автоматически создавать отчеты по повторным прогонам.

Использование before и after хуков Cypress позволяет добавлять метаданные, например, ID тестового прогона или ссылку на задачу в Jira:

before(() => {
  cy.task('createTestRun', { name: 'Regression Run', suiteId: 1 });
});

after(() => {
  cy.task('closeTestRun');
});

Интеграция с Jira и Zephyr

Jira: можно использовать REST API для обновления статуса задачи или создания баг-репортов на основе результатов Cypress. Структура запроса обычно включает ключ задачи, комментарий и статус.
Zephyr: для Zephyr Scale и Zephyr Squad существует API для добавления результатов тестов. Cypress может формировать JSON-отчеты и отправлять их с помощью cy.request().