generar informes de cobertura de códigos GCC
sitio web y documentación • rastreador de errores • GitHub
Gcovr proporciona una utilidad para gestionar el uso de la utilidad GNU gcov y generar resultados resumidos de cobertura de código. Este comando está inspirado en el paquete Python cover.py, que proporciona una utilidad similar para Python.
El comando gcovr
puede generar diferentes tipos de informes de cobertura:
Opción CLI | Guía del usuario | Descripción |
---|---|---|
predeterminado, --txt | Salida de texto | resúmenes compactos y legibles por humanos |
--html | Salida HTML | descripción general de todos los archivos |
--html-details | Salida HTML | archivos fuente anotados |
--html-template-dir | Salida HTML | utilizar un conjunto personalizado de plantillas Jinja2 |
--csv | Salida CSV | Informe CSV que resume la cobertura de cada archivo |
--json | Salida JSON | Informe JSON con estructura y cobertura del archivo fuente |
--json-summary | Salida JSON | Informe de cobertura resumido JSON |
--clover | Salida XML de trébol | Informes XML legibles por máquina en formato Clover |
--cobertura | Salida XML de Cobertura | Informes XML legibles por máquina en formato Cobertura. |
--coveralls | Salida JSON del mono | Informe JSON legible por máquina en formato Coveralls |
--jacoco | Salida XML de JaCoCo | Informes XML legibles por máquina en formato JaCoCo |
--lcov | Información LCOV Salida | informe legible por máquina en formato de información LCOV |
--sonarqube | Salida XML de SonarQube | Informes XML legibles por máquina en formato SonarQube |
Por lo tanto, gcovr puede verse como una alternativa de línea de comandos a la utilidad lcov, que ejecuta gcov y genera un informe con formato HTML. El desarrollo de gcovr fue motivado por la necesidad de resúmenes de texto e informes XML.
Ejemplo de resumen HTML:
Detalles HTML de ejemplo:
Gcovr está disponible como un paquete de Python que se puede instalar mediante pip.
Instale la versión estable más reciente gcovr
desde PyPI:
pip install gcovr
Instale la versión de desarrollo desde GitHub (necesita al menos la versión 21.3 de pip):
pip install git+https://github.com/gcovr/gcovr.git
GCC puede instrumentar los ejecutables para emitir datos de cobertura. Debe volver a compilar su código con las siguientes banderas:
--cobertura -g -O0
A continuación, ejecute su conjunto de pruebas. Esto generará archivos de cobertura sin procesar.
Finalmente, invoque gcovr. Esto imprimirá un informe tabular en la consola.
gcovr
También puede generar informes HTML detallados o anidados:
gcovr --html-detalles cobertura.html gcovr --cobertura html anidada.html
Gcovr creará un informe HTML por archivo fuente y para --html-nested
también por directorio junto al resumen de cobertura.html.
Debes ejecutar gcovr desde el directorio de compilación. La opción -r
debería apuntar a la raíz de su proyecto. Esto sólo importa si tiene un directorio de compilación separado. Por ejemplo:
compilación de CD; gcovr-r..
Para obtener la documentación completa, lea el manual.
Si desea informar un error o contribuir al desarrollo de gcovr, lea primero nuestras pautas de contribución: https://gcovr.com/en/latest/contributing.html
Este software se distribuye bajo la licencia BSD de 3 cláusulas. Consulte https://gcovr.com/en/latest/license.html#license-terms para obtener más detalles. Consulte https://gcovr.com/en/latest/license.html#acknowledgements para obtener la lista completa de contribuyentes.