SonarQube - Cobertura de código fuente

Hola a todo@s, en la siguiente entrada os quiero presentar como incorporar al informe del análisis de código fuente que realiza SonarQube, el informe de la cobertura de código fuente a través de sus tests de covertura.

Hay que informar, que SonarQube, no se encarga de lanzar los procesos de cobertura de código, lo único que hace es recoger unos informes generado por vuestra plataforma de desarrollo, he integrarlo en el informe global de SonarQube.

Aun que toda la información para realizar la cobertura las tenéis en los enlaces oficiales de SonarQube (Test Coverage & Execution) y de su comunidad ([Coverage & Test Data] Generate Reports for C#, VB.net), he de reconocer que me ha costado entender como funciona y por eso espero poder dejar un poco más claro su funcionamiento.

Los objetos que persigue la entrada son los siguientes:

  • Configurar la ejecución de los proyectos de tipo test fuera de Visual Studio
  • Ejemplo de agregar la cobertura de código al informe de SonarQube

Configurar la ejecución de los proyectos de tipo test fuera de Visual Studio

En este apartado lo que se pretende es configurar una serie de rutas físicas de Visual Studio relacionadas con los proyectos de tipo test, con el fin de no tener que manejar esas rutas físicas en los comandos de ejecución de las pruebas unitarias y pruebas de cobertura por la línea de comando.

Para lanzar las pruebas unitarias y la cobertura de código a través de una consola, son necesarios ejecutar los comandos vstest.console.exe y CodeCoverage.exe que se encuentran en mi caso, por usar un Visual Studio 2019 Enterprise, en las rutas C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\IDE\CommonExtensions\Microsoft\TestWindow y C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Team Tools\Dynamic Code Coverage Tools

Por ello, se han configurado las rutas a nivel de máquina, para facilitar su manejo y no estar pendiente de las rutas físicas.

Ejemplo de agregar la cobertura de código al informe de SonarQube

Para agregar la cobertura de código al análisis de SonarQube, se van a agregar las líneas de comandos relacionadas con la cobertura de código sobre las líneas de comando de analizar el código fuente del proyecto.


    SonarScanner.MSBuild.exe begin /k:"[Key-Proyecto]" /n:"[Nombre-Proyecto]" /v:"[Versión]" /d:sonar.cs.vscoveragexml.reportsPaths="VisualStudio.coveragexml"
    MSBuild.exe /t:Rebuild
    del "VisualStudio.coveragexml"
    del "VisualStudio.coverage"
    vstest.console.exe /EnableCodeCoverage "[Ruta relativa del fichero DLL del proyecto de tipo test]"
    CodeCoverage.exe collect /output:"VisualStudio.coverage" "vstest.console.exe" "[Ruta relativa del fichero DLL del proyecto de tipo Test]"
    CodeCoverage.exe analyze /output:"VisualStudio.coveragexml" "VisualStudio.coverage"
    SonarScanner.MSBuild.exe end

Los comandos del que se encargan de eliminar los ficheros VisualStudio.coveragexml y VisualStudio.coverage se hacen porque si ya se ha generado una cobertura de código, al volver a ejecutar los scripts, no sobrescribe los ficheros y entonces no se actualiza en el análisis de SonarQube, y así nos aseguramos de que siempre se vuelve a generar cada vez que se ejecuta el script.

Tras ejecutar el escaneo del proyecto, en el DashBoard de SonarQube, ya debería de aparecer en el informe, la sección de cobertura rellena.

Visión global del análisis de SonarQube con la cobertura de código agregada

Representación gráfica de la cobertura de código a través de sus ficheros analizados

A continuación, os dejo un ejemplo de las sentencias lanzadas para realizar todo este análisis de código en SonarQube, para que dispongáis un ejemplo real y espero que esto os ayude a tener un código más mantenible en el futuro.


    SonarScanner.MSBuild.exe begin /k:"SonarQube-key" /n:"SonarQube" /v:"2.0" /d:sonar.cs.vscoveragexml.reportsPaths="VisualStudio.coveragexml"
    MSBuild.exe /t:Rebuild
    del "VisualStudio.coveragexml"
    del "VisualStudio.coverage"
    vstest.console.exe /EnableCodeCoverage "SonarQube.Test\bin\Debug\SonarQube.Test.dll"
    CodeCoverage.exe collect /output:"VisualStudio.coverage" "vstest.console.exe" "SonarQube.Test\bin\Debug\SonarQube.Test.dll"
    CodeCoverage.exe analyze /output:"VisualStudio.coveragexml" "VisualStudio.coverage"
    SonarScanner.MSBuild.exe end

Entradas populares de este blog

Cargar archivos desde PowerApps a bibliotecas de SharePoint

Imagen
Hola a tod@s, en la siguiente entrada vengo a presentaros como cargar en bibliotecas de SharePoint Online ficheros desde una aplicación de PowerApps a través de Power Automate . Hay que indicar en un principio, que el artículo que tenía pensado redactar, tenía como objetivo explicar cómo subir ficheros de más de 75Mb de tamaño , a las bibliotecas de documentos de SharePoint Online desde una aplicación de PowerApps , pero después de realizar muchas pruebas con diferentes técnicas, métodos y herramientas, he de reconocer que ha sido ¡Un fracaso absoluto! Bueno, hay que reconocer que tan poco ha sido en valde todos los intentos realizados para conseguir este objetivo, ya que me ha servido para entender más en profundidad, cómo trabajan las herramientas de SharePoint , PowerApps , Power Automate y OneDrive , con los ficheros que tienen un tamaño grande, como puedes ser los videos. ...
Leer más

Menús desplegables relacionados en SharePoint Online

Imagen
Hola a tod@s, en la siguiente entrada vengo a presentaros como resolver de forma sencilla, uno de los principales problemas que nos encontramos los desarrolladores de SharePoint desde sus orígenes en SharePoint On-Premise. Quien no se ha topado en su vida laboral, con el clásico problema de tener que trabajar en las listas con los menús desplegables, que tienen que estar relacionados entre ellos. Como pueden ser la lista de comunidades autónomas y sus provincias en los datos de los clientes. O por poner otro ejemplo, si se trata de una empresa su negocio está relacionado con la automoción, donde la lista de modelos de los vehículos está relacionada con las marcas de vehículos que maneja la empresa. Para resolver este tipo de problemas de datos relacionados en listas, se ...
Leer más

Generar contenido para páginas modernas con JSON

Imagen
Hola a tod@s, en la siguiente entrada vengo a presentaros como implementar una solución sencilla a nuestro cliente sin tener que implementar una solución con ' SharePoint FrameWork ', a través de la customización de las vistas en las listas. A la hora de hacer ofertas y propuestas a nuestros clientes, no se dispone de un presupuesto holgado y/o el cliente desea implementar soluciones con los componentes que ofrece el producto, para no depender de la implementación de soluciones a medida, en un futuro. Teniendo en cuenta este tipo de limitaciones, en las ofertas que se realizan a nuestros clientes, la mayoría de los requisitos se pueden resolver, con los componentes que ofrece ' SharePoint Online ', ofreciendo ejemplos y diseños, de la página oficial ...
Leer más