Разработка и Git

Сводка покрытия тестами

Читает coverage.json или coverage.xml, показывает общий процент и файлы ниже порога.

Python Windows macOS Linux Средний
Скачать coverage_summary.py
Описание

Что делает скрипт

Скрипт разбирает отчёт coverage.py в JSON или XML и выводит общий процент покрытия, число операторов и список слабых файлов. Порог задаётся флагом --min. Отчёт только читается, тесты запускаются отдельно.

Запуск

Быстрый старт

python coverage_summary.py --file coverage.json --min 80

Скачайте файл, откройте терминал в папке со скриптом и выполните команду. В Linux и macOS интерпретатор может называться python3, в Windows - python или py.

Примеры

Другие варианты

  • python coverage_summary.py --file coverage.json
  • python coverage_summary.py --xml coverage.xml --min 90
Зависимости

Что понадобится

Python 3.10+ Только стандартная библиотека
Windows winget install Python.Python.3.12
macOS brew install python
Linux sudo apt install python3
coverage Сбор покрытия тестами
Windows py -m pip install coverage
macOS python3 -m pip install coverage
Linux python3 -m pip install coverage
Исходник

coverage_summary.py

#!/usr/bin/env python3
"""Краткая сводка покрытия из отчёта coverage.py."""
from __future__ import annotations

import argparse
import json
import xml.etree.ElementTree as ET
from pathlib import Path


def read_json(path: Path) -> tuple[float, int, int, list[tuple[str, float]]]:
    data = json.loads(path.read_text(encoding="utf-8"))
    totals = data.get("totals", {})
    percent = float(totals.get("percent_covered", 0.0))
    statements = int(totals.get("num_statements", 0))
    missing = int(totals.get("missing_lines", 0))
    rows = []
    for name, info in data.get("files", {}).items():
        summary = info.get("summary", {})
        rows.append((name, float(summary.get("percent_covered", 0.0))))
    return percent, statements, missing, rows


def read_xml(path: Path) -> tuple[float, int, int, list[tuple[str, float]]]:
    root = ET.parse(path).getroot()
    percent = float(root.attrib.get("line-rate", "0")) * 100
    statements = int(root.attrib.get("lines-valid", "0"))
    covered = int(root.attrib.get("lines-covered", "0"))
    missing = max(0, statements - covered)
    rows = []
    for node in root.iter("class"):
        name = node.attrib.get("filename") or node.attrib.get("name") or "unknown"
        rows.append((name, float(node.attrib.get("line-rate", "0")) * 100))
    return percent, statements, missing, rows


def main() -> int:
    parser = argparse.ArgumentParser(description="Сводка покрытия тестами")
    group = parser.add_mutually_exclusive_group()
    group.add_argument("--file", type=Path, help="Путь к coverage.json")
    group.add_argument("--xml", type=Path, help="Путь к coverage.xml")
    parser.add_argument("--min", type=float, default=80.0, help="Минимальный процент")
    parser.add_argument("--top", type=int, default=20, help="Сколько слабых файлов показать")
    args = parser.parse_args()

    if not args.file and not args.xml:
        default = Path("coverage.json")
        if default.exists():
            args.file = default
        else:
            print("Укажите --file coverage.json или --xml coverage.xml.")
            print("JSON можно получить командой: coverage json")
            return 2

    path = args.file or args.xml
    if not path or not path.is_file():
        print(f"Файл отчёта не найден: {path}")
        return 2

    try:
        if args.file:
            percent, statements, missing, rows = read_json(args.file)
        else:
            percent, statements, missing, rows = read_xml(args.xml)
    except (OSError, ValueError, KeyError, ET.ParseError) as error:
        print(f"Не удалось прочитать отчёт: {error}")
        return 2

    rows.sort(key=lambda item: (item[1], item[0]))
    print(f"Отчёт: {path}")
    print(f"Общее покрытие: {percent:.1f}%")
    print(f"Операторов: {statements}, не покрыто строк: {missing}")
    print()

    weak = [item for item in rows if item[1] < args.min]
    if weak:
        print(f"Файлы ниже {args.min:.1f}%:")
        for name, value in weak[: args.top]:
            print(f"  {value:6.1f}%  {name}")
    else:
        print(f"Все файлы покрыты не ниже {args.min:.1f}%.")

    return 0 if percent >= args.min else 1


if __name__ == "__main__":
    raise SystemExit(main())

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

CLI 1.0.0

Скачать без браузера

Команда скачает этот файл в текущую папку. CLI работает на Windows, macOS и Linux.

scriptdock get dev-coverage-summary
  • Поиск по всему каталогу
  • Python 3.10+
  • Без внешних пакетов
Скачать CLI

GUI-версия готовится. Подробнее

Категория

Разработка и Git

Git, сборка, тесты, зависимости, логи и обслуживание проектов.