Genera un informe PDF de la calidad de tu código con SonarQube
31 de julio 2020
SonarQube es una herramienta hecha por desarrolladores para desarrolladores. Proporciona todo lo necesario para escribir código limpio y seguro desde el primer momento y, además, te permite gestionar la deuda técnica para que tu desarrollo sea sostenible.
¿Pero qué ocurre si quieres explotar los datos y generar algún informe de calidad de los proyectos? En este sentido SonarQube no ofrece por defecto ninguna gestión informes sencilla. Puedes usar la API web para desarrollarlos tu mismo, pero en la mayoría de ocasiones lo que se busca es algo más rápido y sencillo.
¿Cómo generar PDFs de forma sencilla en SonarQube?
Con nuestro producto bitegarden Report for SonarQube se pueden generar estos informes fácilmente.
Desde el espacio de proyecto en la opción “More…“ encontrarás una sección que te proporciona todos los informes que necesitas, desde un resumen ejecutivo hasta un informe con todas las evidencias encontradas. Basta con descargar el informe deseado pulsando en el botón de descarga correspondiente.
En la siguiente imagen te mostramos una captura de pantalla de nuestra instancia de SonarQube para que puedas encontrar este aspecto:
Configura un logo personalizado
Por defecto el plugin usará el logo de bitegarden en el pie de cada página, pero si lo necesitas, puedes cambiarlo desde la configuración del plugin para que se utilice el logotipo de tu organización o incluso el logotipo de tu proyecto.
Si quieres cambiar el logotipo para todos los informes de instancia de SonarQube tan solo tienes que ir a la configurcación general del plugin a nivel global (Administration -> General Settings) y usar la URL del logo que quieras que aparezca en el pie de página:
Aquí te dejamos una captura de pantalla para que veas dónde puedes cambiar el logotipo y el resultado final con un ejemplo:
Configuración del logotipo del pie de página
Ejemplo de informe con logotipo personalizado
Diferentes informes, diferentes objetivos
Cada persona del equipo puede requerir un tipo de informe distinto. Inicialmente pensábamos que ciertos roles de los equipos
accederían a SonarQube para ver los detalles de las evidencias pero la experiencia nos dice que esto no es así, y
que existen muchos roles que no acceden a la herramienta y por tanto, necesitan trabajar con informes extraídos y en otro
formato distinto.
Informe con resumen ejecutivo (PDF)
Objetivo: poder determinar de un vistazo si el proyecto cumple o no con las condiciones de calidad así como los principales valores para cada una de las dimensiones de calidad analizadas
De este informe ya hablamos en su momento cuando liberamos la versión 2.0 del plugin. Se trata de un informe en una única página con toda la información importante de la calidad del código de nuestro proyecto, que incluye:
– Los tres ejes del modelo de calidad: fiabilidad, seguridad y mantenibilidad
– Código repetido (o duplicado)
– Cobertura de código y tests unitarios
– Evidencias bloqueantes y críticas desglosadas por bugs, vulnerabilidades y code smells.
Incluye tanto los valores globales como la información en el periodo de fuga (código nuevo o modificado).
VER EJEMPLO RESUMEN EJECUTIVO >
Informe resumen de evidencias (PDF)
Objetivo: conocer un resumen de evidencias de nuestro proyecto (más frecuentes, más severas) y un resumen por regla con las principales evidencias detectadas (fichero, línea, mensaje)
Este informe está disponible a partir de la versión 2.1 e incluye la página de resumen ejecutivo y añade nuevas páginas al informe:
– Evidencias más detectadas: listado de las evidencias por frecuencia de aparición. Las reglas con mayor número de evidencias aparecerán las primeras.
– Evidencias por severidad: listado de las evidencias por severidad. Las reglas con mayor severidad aparecerán las primeras independientemente de que no sean las más frecuentes.
– Desglose de evidencias por regla: una página por cada una de las reglas de las que se hayan detectado evidencias con una pequeña descripción y un listado con un resumen de evidencias detectadas.
El informe permite tener un mayor nivel de detalle para poder remitirse a equipos externos que no puedan ver la herramienta o como informe de auditoría de un proyecto, donde quieran mostrarse las principales evidencias.
VER EJEMPLO RESUMEN EVIDENCIAS >
Informe completo de evidencias (PDF)
Objetivo: conocer el detalle completo de evidencias de nuestro proyecto
Este informe es el más completo (y el más “grande”) ya que incluye toda la información de los informes anteriores pero en lugar de un resumen de una página por regla, se muestran todas las evidencias detectadas. Si una regla tiene 50 evidencias el informe incluirá la localización de las 50 evidencias (fichero, línea, y mensaje de error).
Este informe permite disponer de TODA la información de la calidad del código del proyecto para entregar a quién pueda corresponder la revisión del cumplimiento de la calidad del código.
VER EJEMPLO COMPLETO EVIDENCIAS >
Informe de métricas personalizado (ODT)
Objetivo: crear informes de métricas con aspecto completamente personalizado que además se puedan editar posteriormente para incluir información manual
Este tipo de informe se crea a partir de una plantilla Open Document (documento ODT).
Permite crear informes con las diferentes secciones completamente personalizadas y con textos, párrafos, estilos y tablas según se configure la plantilla.
La definición de la plantilla se basa en el uso de FreeMarker como variables insertadas en el documento ODT. Nuestro plugin sustituirá las variables por los valores reales del proyecto según las métricas de SonarQube™. Más información sobre como utilizarlo aquí.
Descubre más ejemplos…
Si quieres ver como funciona la generación de informes en una instancia de SonarQube™ en funcionamiento puedes descargar la versión de prueba de 14 días o acceder a nuestra instancia de demostración a alguno de los proyectos disponibles, como por ejemplo Apache Airflow.
¿A qué esperas para generar informes de calidad del código? ¿Tienes sugerencias para crear nuevos informes? ¡Deja tus comentarios y ayudanos a mejorar el producto!