Bazel cuenta con un subcomando coverage para producir cobertura de código.
Informes sobre repositorios que se pueden probar con bazel coverage. Venc.
a las idiosincrasias de los diversos ecosistemas lingüísticos,
siempre es trivial para que esto funcione en un proyecto determinado.
En esta página, se documenta el proceso general de creación y visualización informes de cobertura y también incluye algunas notas específicas del idioma para lenguajes de programación cuya configuración es conocida. Se recomienda leer primero leer la sección general y, luego, leyendo sobre los requisitos de un lenguaje específico. Ten en cuenta también sección de ejecución remota, que requiere consideraciones adicionales.
Si bien es posible realizar una gran cantidad de personalización, este documento se centra en
produce y consume informes de lcov, que actualmente es el
la ruta más compatible.
Cómo crear un informe de cobertura
Preparación
El flujo de trabajo básico para crear informes de cobertura requiere la lo siguiente:
- Un repositorio básico con objetivos de prueba
- Una cadena de herramientas con las herramientas de cobertura de código específicas del lenguaje instaladas
- Una “instrumentación” correcta configuración
Las dos primeras son específicas del lenguaje y, en su mayoría, sencillas, Sin embargo, este último puede ser más difícil en proyectos complejos.
"Instrumentación" en este caso, a las herramientas de cobertura
usarse para un objetivo específico. Bazel permite activar esta función para un
subconjunto específico de archivos con el
--instrumentation_filter
marca, que especifica un filtro para los objetivos que se prueban con el
instrumentación habilitada. Para habilitar la instrumentación para pruebas,
--instrument_test_targets
es obligatoria.
De forma predeterminada, bazel intenta hacer coincidir los paquetes de destino y, luego, imprime los
relevante como un mensaje INFO.
Cobertura para correr
Para crear un informe de cobertura, usa bazel coverage
--combined_report=lcov
[target]. Esto ejecuta el
pruebas para la orientación y la generación de informes de cobertura en formato lcov
para cada archivo.
Cuando termina, Bazel ejecuta una acción que recopila todo lo que
archivos de cobertura y los combina en uno, que finalmente
creada con $(bazel info
output_path)/_coverage/_coverage_report.dat.
Los informes de cobertura también se generan si las pruebas fallan. Sin embargo, ten en cuenta que Esto no se extiende a las pruebas fallidas, solo se aprueban informes.
Cómo ver la cobertura
El informe de cobertura solo se genera en un formato no legible por humanos lcov
de un conjunto de datos
tengan un formato común. Desde esto, podemos usar la utilidad genhtml (parte de lcov
proyecto) para generar un informe que se pueda ver en una
navegador:
genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
Ten en cuenta que genhtml también lee el código fuente para anotar que falta
cobertura en estos archivos. Para que esto funcione, se espera que
genhtml se ejecuta en la raíz del proyecto de Bazel.
Para ver el resultado, simplemente abre el archivo index.html generado en
genhtml en cualquier navegador web.
Para obtener más información y ayuda sobre la herramienta genhtml o
Formato de cobertura de lcov; consulta el proyecto lcov.
Ejecución remota
La ejecución con la ejecución de prueba remota actualmente tiene algunas advertencias:
- La acción de combinación de informes todavía no se puede ejecutar de forma remota. Este es
ya que Bazel no considera los archivos de salida de cobertura como parte
en su gráfico (consulta este problema) y, por lo tanto, puede
no las tratan correctamente como entradas en la acción de combinación. Para
solucionar esto, usa
--strategy=CoverageReport=local.- Nota: Tal vez sea necesario especificar
--strategy=CoverageReport=local,remoteen su lugar, si Bazel está configurado para probarlocal,remote, debido a la forma en que Bazel resuelve las estrategias.
- Nota: Tal vez sea necesario especificar
- Tampoco se pueden usar
--remote_download_minimalni marcas similares. como consecuencia de lo primero. - Por el momento, Bazel no podrá crear información de cobertura si se realizan pruebas.
se almacenaron en caché anteriormente. Para solucionar esto,
--nocache_test_resultsse puede configurar específicamente para ejecuciones de cobertura, aunque esto, por supuesto, genera un alto costo en términos de tiempos de prueba. --experimental_split_coverage_postprocessingy--experimental_fetch_all_coverage_outputs- Por lo general, la cobertura se realiza como parte de la acción de prueba. de forma predeterminada, no obtenemos toda la cobertura como salida del ejecución de forma predeterminada. Estas marcas anulan el valor predeterminado y obtienen los datos de cobertura. Consulta este problema para obtener más información más detalles.
Configuración de lenguaje específico
Java
Java debería funcionar de inmediato con la configuración predeterminada. El Las cadenas de herramientas de bazel contienen todo lo necesario para ejecución remota, incluida JUnit.
Python
Consulta los documentos de cobertura de rules_python.
a fin de conocer los pasos adicionales necesarios para habilitar la compatibilidad de cobertura en Python.