gcovr
8.2
генерировать отчеты о покрытии кода GCC
веб-сайт и документация • система отслеживания ошибок • GitHub
Gcovr предоставляет утилиту для управления использованием утилиты GNU gcov и генерации обобщенных результатов покрытия кода. Эта команда основана на пакете Python Cover.py, который предоставляет аналогичную утилиту для Python.
Команда gcovr может создавать различные виды отчетов о покрытии:
| Опция CLI | Руководство пользователя | Описание |
|---|---|---|
по умолчанию, --txt | Текстовый вывод | компактные, понятные человеку резюме |
--html | HTML-вывод | обзор всех файлов |
--html-details | HTML-вывод | аннотированные исходные файлы |
--html-template-dir | HTML-вывод | использовать собственный набор шаблонов Jinja2 |
--csv | CSV-вывод | Отчет в формате CSV с подведением итогов по каждому файлу. |
--json | Вывод JSON | Отчет JSON со структурой исходного файла и покрытием |
--json-summary | Вывод JSON | Сводный отчет о покрытии в формате JSON |
--clover | XML-вывод Clover | машиночитаемые XML-отчеты в формате Clover |
--cobertura | XML-вывод Кобертуры | машиночитаемые XML-отчеты в формате Cobertura |
--coveralls | Вывод JSON комбинезона | машиночитаемый отчет JSON в формате комбинезонов |
--jacoco | XML-вывод JaCoCo | машиночитаемые XML-отчеты в формате JaCoCo |
--lcov | Информация о LCOV Вывод | машиночитаемый отчет в информационном формате LCOV |
--sonarqube | XML-вывод SonarQube | машиночитаемые XML-отчеты в формате SonarQube |
Таким образом, gcovr можно рассматривать как альтернативу командной строки утилите lcov, которая запускает gcov и генерирует отчет в формате HTML. Разработка gcovr была мотивирована необходимостью текстовых сводок и отчетов в формате XML.
Пример сводки HTML:
Пример HTML-деталей:
Gcovr доступен в виде пакета Python, который можно установить через pip.
Установите новейшую стабильную версию gcovr из PyPI:
pip install gcovrУстановите версию для разработки с GitHub (требуется pip не ниже версии 21.3):
pip install git+https://github.com/gcovr/gcovr.gitGCC может настроить исполняемые файлы для передачи данных о покрытии. Вам необходимо перекомпилировать код со следующими флагами:
--покрытие -g -O0
Затем запустите набор тестов. Это создаст необработанные файлы покрытия.
Наконец, вызовите gcovr. Это приведет к печати табличного отчета на консоли.
гковр
Вы также можете создавать подробные или вложенные отчеты HTML:
gcovr --html-подробности покрытия.html gcovr --html-вложенное покрытие.html
Gcovr создаст один HTML-отчет для каждого исходного файла, а для --html-nested также для каждого каталога рядом со сводкой Cover.html.
Вам следует запустить gcovr из каталога сборки. Опция -r должна указывать на корень вашего проекта. Это имеет значение только в том случае, если у вас есть отдельный каталог сборки. Например:
сборка компакт-диска; гковр -р ..
Для получения полной документации прочтите руководство.
Если вы хотите сообщить об ошибке или внести свой вклад в разработку gcovr, сначала прочтите наши рекомендации по участию: https://gcovr.com/en/latest/contributing.html.
Это программное обеспечение распространяется по лицензии BSD, состоящей из 3 пунктов. Подробности см. на https://gcovr.com/en/latest/license.html#license-terms. См. https://gcovr.com/en/latest/license.html#acknowledgements для получения полного списка участников.
