Configurar proyecto en SonarCloud

Author
By Darío Rivera
Posted on 2020-07-21 in Static Code Analysis
Tags   SonarQube 8

Si tienes un proyecto público en GitHub, Bitbucket o GitLab puedes configurar el analizador de SonarQube (sonar-scanner) para generar el análisis de código estático de tu proyecto y subirlo a SonarCloud. Si aún no has instalado SonarScanner te invito a revisar el siguiente post:

Instalación SonarScanner

Registro en SonarCloud

Lo primero que debes hacer es crear una cuenta en SonarCloud con tu cuenta de GitHub, GitLab o Bitbucket. Debes seguir los pasos que te indica SonarCloud para registrar tu organización y los repositorios que quieres que aparezcan en el panel de SonarCloud. Una vez hecho esto, tendrás varias opciones para lanzar el análisis del sonar-scanner entre las cuáles está el análisis automático y el análisis manual.

Análisis automático

Para correr este análisis basta simplemente con dar clic en el respositorio indicado en el panel de SonarCloud. Para esto debes tener en cuenta además los siguiente:

- El primer análisis será realizado en la rama por defecto de tu repositorio
- Cada nuevo push en la rama por defecto generará un nuevo análisis automáticamente
- Cada nuevo pull request en la rama por defecto generará un nuevo análisis automático

Puedes crear un archivo llamado .sonarcloud.properties para crear configuraciones adicionales sobre tu proyecto. Una buena práctica es indicar el source en donde están los fuentes del proyecto y el encoding de los archivos tal y como puedes ver a continuación.

sonar.sources=./src
sonar.sourceEncoding=UTF-8

La lista completa de opciones disponibles puedes en contrarla en Automatic Analysis Feature. Sin embargo, no son realmente muchas las opciones disponibles debido a que muchas de ellas puedes configurarlas directamente en el panel del proyecto.

Si tu proyecto no es compatible con SonarCloud, aparecerá una sugerencia para utilizar otros métodos de análisis como por ejemplo el uso de herramientas de CI (Continuos Integration).

Finalmente, si tu proyecto es existente y quieres cambiar el estado del análisis automático, bien sea para activarlo o desactivarlo puedes realizarlo en la opción de menú Administration > Analysis Method.

Análisis manual

Para que puedas ejecutar en análisis manual debes haber instalado previamente sonar-scanner en tu computadora. Puedes seguir los mismos pasos que utilizamos en nuestro post Configurar proyecto privado con SonarQube, teniendo en cuenta que el projectKey será generado automáticamente y estará disponible en el panel de tu proyecto en SonarCloud.A demás del projectKey deberás configurar también la variable sonar.organization.

Si por alguna razón ya habías activado el análisis automático deberás desactivarlo ya que si intentas ejecutar el sonar-scanner obtendrás un error como el siguiente:

ERROR: Error during SonarQube Scanner execution
ERROR: You are running manual analysis while Automatic Analysis is enabled. Please consider disabling one or the other.

Generación de tokens (login)

Para generar un token con el cuál el sonar-scanner pueda iniciar un logueo y subir el informe a SonarCloud deberás generar un token en My Account > Security y asignarlo a la propiedad sonar.login.


Si te ha gustado este artículo puedes invitarme a tomar una taza de café

Acerca de Darío Rivera

Author

Ingeniero de desarrollo en PlacetoPay , Medellín. Darío ha trabajado por más de 6 años en lenguajes de programación web especialmente en PHP. Creador del microframework DronePHP basado en Zend y Laravel.

Sólo aquellos que han alcanzado el éxito saben que siempre estuvo a un paso del momento en que pensaron renunciar.