Siempre es conveniente realizar un análisis de nuestro código fuente para conocer su calidad, y en caso de ser necesario, mejorarla.
En este artículo, veremos como auditar el código de un proyecto REST creado con spring-data-rest y maven.
Lo primero que se debe hacer es instalar SonarQube y ejecutar el servidor, este enlace puede ayudarte
Una vez iniciado el servidor, debemos abrir una terminal y ubicarnos en la raíz del proyecto que queremos analizar. Allí debemos ejecutar el siguiente comando:
mvn clean install sonar:sonar -Dsonar.host.url=http://localhost:9000 -Dsonar.analysis.mode=publish
Finalizado el análisis, podremos acceder al reporte ingresando http://localhost:9000 en nuestro navegador web.
Si hacemos clic en el nombre del proyecto, en este caso "rest", accederemos a su detalle:
Podemos observar que la "calidad" de nuestro código fue aprobada (Quality Gate - Passed), también vemos que no tenemos bugs (0 Bugs), no hay vulnerabilidades, pero si hay código que "huele mal" (3 Code Smells), y que solucionarlo podria llevarnos unos 14 minutos aproximadamente. Si hacemos clic en el número 3 que se encuentra sobre "Code Smells", veremos su detalle:
En este caso, el código "oloroso" o que "huele mal", o con el que podríamos llegar a tener problemas en un futuro son dos lineas que contienen imports que no se utilizan y un caso de test incompleto.
El análisis que realizamos en esta ocasión es manual, ya que nosotros introducimos el comando maven necesario para ello, lo ideal seria que el mismo se realice de manera automática al momento de compilar el proyecto. En una próxima entrega, veremos como integrarlo con Jenkins.
El proyecto utilizado en este artículo esta disponible en el siguiente repositorio
0 comentarios:
Publicar un comentario