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

Karma — это инструмент для запуска тестов в реальных браузерах. Он позволяет запускать тесты на различных платформах и браузерах, обеспечивая интеграцию с различными тестовыми фреймворками, такими как Mocha. Karma позволяет запускать тесты автоматически, предоставляет отчеты о выполнении тестов и может быть интегрирован с другими инструментами для создания непрерывной интеграции (CI).

Установка Karma

Для начала работы с Karma потребуется установить несколько пакетов. Необходимо установить сам Karma и несколько плагинов для интеграции с Mocha и различными браузерами.

Для установки всех необходимых зависимостей используется npm:

npm install karma --save-dev
npm install karma-mocha --save-dev
npm install karma-chrome-launcher --save-dev
npm install karma-coverage --save-dev
  • karma — основной пакет для Karma.
  • karma-mocha — плагин для интеграции с Mocha.
  • karma-chrome-launcher — плагин для запуска тестов в браузере Chrome.
  • karma-coverage — плагин для отчётов по покрытию кода.

После установки пакетов необходимо настроить Karma с помощью конфигурационного файла.

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

После установки зависимостей нужно создать файл конфигурации Karma. Это можно сделать с помощью команды:

karma init karma.conf.js

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

Пример конфигурационного файла karma.conf.js:

module.exports = function(config) {
  config.set({
    // Указываем фреймворк тестирования
    frameworks: ['mocha'],
    
    // Указываем браузеры для запуска тестов
    browsers: ['Chrome'],
    
    // Указываем плагины
    plugins: [
      'karma-mocha',
      'karma-chrome-launcher',
      'karma-coverage'
    ],
    
    // Настройки отчётов
    reporters: ['progress', 'coverage'],
    
    // Опции покрытия кода
    preprocessors: {
      'src/**/*.js': ['coverage']
    },
    
    // Ожидание завершения тестов
    captureTimeout: 60000,
    singleRun: false
  });
};

В этом файле указаны основные параметры:

  • frameworks — указывает, что для тестирования будет использоваться Mocha.
  • browsers — указывает браузеры для тестирования (в данном случае Chrome).
  • plugins — список плагинов для интеграции с Mocha, Chrome и покрытия кода.
  • reporters — отчеты о тестах и покрытии кода.
  • preprocessors — настройка для покрытия кода.
  • captureTimeout — максимальное время ожидания для браузера.
  • singleRun — указывает, что тесты будут выполнены один раз при запуске Karma.

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

После того как конфигурация настроена, можно запускать Karma с помощью команды:

karma start karma.conf.js

Karma запустит браузер, выполнит тесты в указанном браузере и отобразит результаты в консоли. Важно, чтобы Karma был настроен для работы с Mocha, а также корректно настроены все плагины для запуска в браузерах.

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

Mocha — это гибкий и популярный фреймворк для тестирования в JavaScript. Karma идеально подходит для его использования, обеспечивая автоматический запуск тестов в реальных браузерах.

Пример теста с использованием Mocha:

describe('Математические операции', function() {
  it('должен складывать два числа', function() {
    const result = 2 + 2;
    assert.equal(result, 4);
  });

  it('должен вычитать два числа', function() {
    const result = 5 - 3;
    assert.equal(result, 2);
  });
});

Этот тест проверяет две математические операции: сложение и вычитание. Mocha предоставляет удобный синтаксис для описания тестов с использованием describe и it.

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

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

Для использования Karma с системой непрерывной интеграции (например, Jenkins, Travis CI или GitHub Actions), необходимо настроить Karma для работы в безголовом (headless) режиме, то есть без открытия браузера. Для этого в конфигурации Karma можно добавить плагин для запуска тестов в headless-режиме.

Для Chrome это будет выглядеть так:

browsers: ['ChromeHeadless']

Теперь тесты будут запускаться в фоновом режиме, без открытия браузера, что ускоряет процесс тестирования в CI.

Отчёты о тестах

Karma предоставляет возможность использовать различные репортеры для вывода информации о тестах. Один из самых популярных — progress — показывает прогресс тестирования в реальном времени. Также можно настроить отчёты о покрытии кода с использованием плагина karma-coverage, который будет генерировать отчеты по выполнению тестов и покрытию.

Пример конфигурации для отчёта о покрытии:

reporters: ['progress', 'coverage'],
coverageReporter: {
  type: 'html',
  dir: 'coverage/'
}

Этот код генерирует отчёт о покрытии кода в формате HTML, который сохраняется в папке coverage/.

Плагины для Karma

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

  • karma-chrome-launcher — для запуска тестов в браузере Chrome.
  • karma-firefox-launcher — для запуска тестов в Firefox.
  • karma-jasmine — для использования Jasmine как фреймворка для тестирования.
  • karma-phantomjs-launcher — для запуска тестов в PhantomJS (безголовый браузер).

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

Тестирование в нескольких браузерах

Karma позволяет запускать тесты в нескольких браузерах одновременно, что помогает убедиться в совместимости вашего приложения с различными браузерами. Для этого нужно просто указать несколько браузеров в конфигурации:

browsers: ['Chrome', 'Firefox', 'Safari']

Теперь Karma будет запускать тесты в этих браузерах, и вы получите отчёт о прохождении тестов в каждом из них.

Заключение

Karma — это мощный инструмент для интеграции тестов Mocha с реальными браузерами, который обеспечивает гибкость, расширяемость и совместимость с различными браузерами. Он подходит для разработки приложений, где важно тестировать код в реальных условиях, а также для интеграции в CI/CD pipeline. Karma помогает поддерживать высокое качество кода, автоматизируя процесс тестирования и отчетности.

Оглавление