Пороги покрытия

Пороги покрытия (coverage thresholds) в тестировании с использованием Karma являются критическим инструментом для поддержания качества кода. Они позволяют задать минимальные показатели покрытия кода тестами и автоматически контролировать их соблюдение при выполнении тестов. В контексте Karma это обычно реализуется через плагин karma-coverage или его более современный вариант karma-coverage-istanbul-reporter.

Настройка плагина для покрытия

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

{
  "devDependencies": {
    "karma": "^6.4.2",
    "karma-jasmine": "^5.1.0",
    "karma-chrome-launcher": "^3.1.1",
    "karma-coverage": "^2.2.0"
  }
}

В файле конфигурации karma.conf.js добавляется настройка coverageReporter:

coverageReporter: {
  type: 'html',
  dir: 'coverage/',
  check: {
    global: {
      statements: 80,
      branches: 70,
      functions: 75,
      lines: 80
    },
    each: {
      statements: 70,
      branches: 60,
      functions: 65,
      lines: 70
    }
  }
}

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

  • type: формат отчета (html, lcov, text, text-summary).
  • dir: директория для хранения отчета.
  • check.global: глобальные пороги покрытия для всего проекта.
  • check.each: пороги для каждого отдельного файла.

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

Разделение порогов на уровни

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

Локальные пороги — применяются к отдельным файлам. Они помогают отслеживать прогресс по каждому модулю и предотвращают появление новых участков кода с низким покрытием.

Статистика по типам покрытия:

  • statements — процент проверенных операторов.
  • branches — процент проверенных ветвлений условных операторов.
  • functions — процент протестированных функций.
  • lines — процент строк кода, проверенных тестами.

Установка разных значений для этих категорий позволяет более гибко управлять качеством кода.

Применение порогов в workflow

Включение проверки порогов покрытия в CI/CD pipeline обеспечивает автоматический контроль качества на каждом этапе. Пример интеграции с GitHub Actions:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install dependencies
        run: npm ci
      - name: Run tests with coverage
        run: npx karma start karma.conf.js --single-run

Если порог покрытия не выполнен, шаг с тестами завершится с ошибкой, предотвращая слияние кода с низким покрытием в основную ветку.

Гибкость настройки

Пороги можно задавать:

  • Абсолютные — фиксированный процент для всех файлов.
  • Динамические — на основе текущего состояния проекта. Например, можно требовать более высокое покрытие для новых файлов и мягче относиться к старому коду.
  • По директориям — различные модули могут иметь разные минимальные требования.

Пример задания порогов по директориям:

check: {
  each: {
    statements: 80,
    branches: 70,
    functions: 75,
    lines: 80
  },
  global: {
    statements: 85,
    branches: 75,
    functions: 80,
    lines: 85
  }
}

Отчеты о покрытии

После выполнения тестов Karma генерирует отчет, визуализирующий процент покрытия:

  • Зеленый цвет — порог достигнут.
  • Желтый — близко к порогу.
  • Красный — порог не выполнен.

HTML-отчет позволяет просматривать, какие строки и ветвления не покрыты, что упрощает анализ пробелов в тестах.

Практические рекомендации

  • Устанавливать пороги постепенно, повышая их по мере роста тестового покрытия.
  • Совмещать глобальные и локальные пороги для комплексного контроля качества.
  • Использовать CI/CD для автоматической проверки порогов на каждом pull request.
  • Анализировать отчеты, чтобы выявлять участки кода, которые требуют дополнительных тестов.

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

Оглавление