Reporter настройки

Jasmine предоставляет возможность настраивать отчеты тестирования с помощью различных репортеров, которые могут вывести результат в различных форматах. Эта возможность полезна для интеграции с CI/CD системами, создания пользовательских отчетов или просто для улучшения визуальной привлекательности выводимой информации.

Стандартные репортеры

Jasmine поставляется с несколькими встроенными репортерами. Они могут быть использованы для вывода результатов тестов в различных форматах, таких как текст, HTML или JSON. Стандартные репортеры включают:

  • Console Reporter — отображает результаты непосредственно в консоли.
  • JUnit Reporter — генерирует отчет в формате JUnit для последующей обработки в CI/CD системах.
  • HTML Reporter — создает HTML отчет, который удобно просматривать в браузере.

Эти репортеры можно настроить через объект конфигурации Jasmine, что позволяет гибко адаптировать вывод результатов под требования проекта.

Конфигурация репортеров

Для настройки репортеров в Jasmine необходимо в файле конфигурации (например, jasmine.json) или внутри тестов с помощью метода jasmine.getEnv().addReporter(reporter). Каждому репортеру можно передавать собственные параметры для изменения формата вывода или подключения к сторонним сервисам.

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

jasmine.getEnv().addReporter(new jasmine.ConsoleReporter());

Для более сложной настройки, например, подключения HTML-репортера, нужно использовать сторонние библиотеки, такие как jasmine-reporters.

Установка и настройка внешнего репортера

  1. Установить пакет jasmine-reporters через npm:
npm install jasmine-reporters --save-dev
  1. Подключить и настроить репортер в тестах:
const JasmineReporters = require('jasmine-reporters');

jasmine.getEnv().addReporter(
    new JasmineReporters.JUnitXmlReporter({
        savePath: 'test_results',
        filePrefix: 'results'
    })
);

Этот код создаст отчет в формате JUnit XML и сохранит его в папку test_results.

Пользовательские репортеры

В дополнение к стандартным и внешним репортерам, Jasmine позволяет создавать собственные репортеры, что дает полную свободу для настройки выводимых данных. Пользовательские репортеры реализуют интерфейс Reporter и могут содержать несколько методов:

  • specDone — вызывается после выполнения каждого теста.
  • suiteDone — вызывается после завершения выполнения всех тестов в группе.
  • jasmineDone — вызывается по завершении всех тестов.

Пример простого пользовательского репортера:

function CustomReporter() {
  this.specDone = function(result) {
    console.log('Тест завершен: ' + result.description + ' - ' + result.status);
  };
}

jasmine.getEnv().addReporter(new CustomReporter());

Этот репортер выводит описание теста и его статус после каждого выполнения.

Настройки репортеров

При работе с репортерами можно использовать следующие параметры:

  • savePath — путь к папке, в которую будут сохраняться результаты (для файловых репортеров).
  • filePrefix — префикс для имени файла отчета (для файловых репортеров).
  • consoleColors — позволяет настроить вывод цветов в консоли (для текстовых репортеров).
  • reporterOptions — дополнительные опции, специфичные для каждого репортера.

Подключение нескольких репортеров

Можно подключить несколько репортеров одновременно. Это полезно, когда необходимо выводить результаты как в консоль, так и в файл, например, для дальнейшей обработки.

Пример подключения нескольких репортеров:

const JasmineReporters = require('jasmine-reporters');

jasmine.getEnv().addReporter(new jasmine.ConsoleReporter());
jasmine.getEnv().addReporter(
  new JasmineReporters.JUnitXmlReporter({
    savePath: 'test_results',
    filePrefix: 'results'
  })
);

В данном примере сначала выводятся результаты в консоль, а затем сохраняется отчет в формате JUnit.

Сложные отчеты

В случае, если необходимо создать сложный отчет с дополнительными метками или статистикой, можно использовать пользовательский репортер для сбора данных во время тестов и вывода их в нужном формате. Например, можно собирать информацию о времени выполнения тестов, количестве успешных и неудачных тестов, а затем выводить это в отчет.

Пример пользовательского репортера, который собирает статистику:

function StatsReporter() {
  this.passed = 0;
  this.failed = 0;

  this.specDone = function(result) {
    if (result.status === 'passed') {
      this.passed++;
    } else if (result.status === 'failed') {
      this.failed++;
    }
  };

  this.jasmineDone = function() {
    console.log('Тесты завершены');
    console.log('Успешных: ' + this.passed);
    console.log('Неудачных: ' + this.failed);
  };
}

jasmine.getEnv().addReporter(new StatsReporter());

Этот репортер выводит количество успешных и неудачных тестов по завершению тестов.

Интеграция с CI/CD

Репортеры Jasmine можно настроить для интеграции с системами непрерывной интеграции (CI/CD), такими как Jenkins, Travis CI или GitLab CI. Это обычно осуществляется через репортеры, которые генерируют отчеты в формате JUnit или других форматах, поддерживаемых соответствующими системами.

Пример настройки JUnit-репортера для работы с Jenkins:

jasmine.getEnv().addReporter(
  new JasmineReporters.JUnitXmlReporter({
    savePath: 'junit_reports',
    filePrefix: 'test_results'
  })
);

Jenkins или другая система CI/CD будет автоматически обрабатывать созданные XML-файлы и показывать результаты тестов на своей панели управления.

Завершение работы с репортерами

После того как репортеры настроены, и тесты выполнены, результаты могут быть обработаны и использованы для анализа или создания отчетности. Подключение репортеров предоставляет гибкость в представлении данных, что важно для разработчиков и команд, работающих с большими проектами.

Jasmine предоставляет обширные возможности для настройки репортеров, что позволяет интегрировать тестирование в любые процессы разработки и анализа кода.

Оглавление