La importancia de la calidad del software
En la industria del desarrollo, la calidad del software es un elemento fundamental. Contar con herramientas que nos ayuden a evaluar nuestro código se vuelve imprescindible para garantizar un desarrollo correcto y la aplicación de buenas prácticas.
¿Qué es SonarQube?
SonarQube es una plataforma de código abierto que permite la inspección continua de la calidad del código a través de diversas herramientas de análisis estático del código fuente. Proporciona métricas que ayudan a mejorar la calidad del código de un programa, permitiendo a los equipos de desarrollo realizar un seguimiento y detectar errores y vulnerabilidades de seguridad para mantener el código limpio.
Esta herramienta esencial para la fase de testing y auditoría de código dentro del ciclo de desarrollo de una aplicación, se considera perfecta para guiar a los equipos de desarrollo durante las revisiones de código y soporta una etapa de inspección continua.
SonarQube está escrito en Java, pero puede analizar y administrar código de 29 lenguajes de programación importantes, incluyendo C/C++, PL/SQL, Cobol, entre otros, a través de conjuntos de reglas incorporados que pueden ser ampliados con varios complementos.
¿Por qué usar SonarQube?
Esta herramienta se centra en el nuevo código y ayuda a la detección de muchos problemas, lo que facilita su solución de manera rápida en cuanto aparecen, permitiendo mantener el código limpio, sencillo y fácil de leer.
Los desarrolladores se apoyan en esta plataforma para lograr la integración e implementación continua del código. SonarQube no solo detecta problemas, sino que también permite rastrear, controlar y verificar la calidad continua del código.
Características de SonarQube
- Admite los lenguajes de programación más populares como Java, C/C++, Objective-C, C#, PHP, Flex, Groovy, JavaScript, Python, PL/SQL, COBOL, etc.
- Realiza revisiones automáticas con análisis de código estático detectando problemas que afectan la calidad del código.
- Facilita informes ofreciendo información objetiva de la calidad actual de los proyectos utilizando métricas y gráficos de prueba de calidad avanzados. Esto incluye datos sobre código duplicado, estándares de codificación, pruebas unitarias, cobertura de código, complejidad del código, errores potenciales, comentarios, diseño y arquitectura.
- Es ampliable con el uso de complementos.
- Alerta de manera automática a los desarrolladores de los errores de código para corregirlos previamente a la implementación en producción.
- No sólo muestra los errores, también las reglas de codificación, la cobertura de las pruebas, las duplicaciones, la complejidad y la arquitectura, plasmando todos estos datos en paneles de control detallados.
- Ayuda al equipo a mejorar en sus habilidades como programadores al facilitar un seguimiento de los problemas de calidad.
- Permite la creación de paneles y filtros personalizables para centrarse en áreas clave y entregar productos de calidad a tiempo.
- Favorece la productividad al reducir la complejidad del código, acortando tiempos y costes adicionales al evitar cambios constantes.
- Descarga el archivo zip de SonarQube Community Edition.
- Descomprímelo en la ubicación deseada, como C:sonarqube o /opt/sonarqube. Asegúrate de hacerlo como usuario no root.
- Inicia SonarQube Server también como usuario no root:
- Busca la imagen de Docker de Community Edition en Docker Hub.
- Una vez que tu instancia esté en funcionamiento, accede a http://localhost:9000 e inicia sesión con las credenciales de administrador del sistema:
- Inicio de sesión: admin
- Contraseña: admin
- Haz clic en el botón “Crear nuevo proyecto”.
- Asigna una clave y un nombre al proyecto y haz clic en “Configurar”.
- En la sección “Proporcionar un token”, selecciona la opción “Generar un token”.
- Dale un nombre al token y haz clic en “Generar” y luego en “Continuar”.
- Selecciona el lenguaje principal de tu proyecto en la sección “Ejecutar análisis en tu proyecto” y sigue las instrucciones para analizar el proyecto. Si estás utilizando Maven o Gradle, el escáner se descargará automáticamente.
SonarQube: Mejora la calidad de tu código con análisis estático
SonarQube es una herramienta que te permite realizar revisiones automáticas en tu código, detectando problemas que afectan a la calidad del mismo. Además, facilita informes objetivos sobre la calidad actual de tus proyectos, utilizando métricas y gráficos avanzados.
Características principales de SonarQube:
Beneficios de SonarQube:
Cómo comenzar a usar SonarQube:
El único requisito previo para ejecutar SonarQube es tener Java (Oracle JRE 11 u OpenJDK 11) instalado en el ordenador.
A continuación, te mostraremos los pasos para instalar una instancia local de SonarQube y analizar un proyecto. Instalar una instancia local facilita su funcionamiento de forma rápida.
Instalación de una instancia local de SonarQube:
Para realizar la instalación de SonarQube, tienes dos opciones. Puedes utilizar la instalación tradicional con el archivo zip o hacer girar un contenedor Docker.
Instalación de SonarQube Community Edition
Para instalar SonarQube desde el archivo comprimido, sigue estos pasos:
Cómo analizar un proyecto en SonarQube
Una vez que hayas iniciado sesión en tu instancia local de SonarQube, puedes comenzar a analizar un proyecto:
Una vez que el código haya sido analizado, podrás ver las principales métricas en SonarQube.
Análisis de calidad de código
Al evaluar la calidad del código en un proyecto, es importante tener en cuenta diferentes métricas y criterios. A continuación, te presentamos algunos de los principales factores que se utilizan para evaluar la calidad del código:
Complejidad
La complejidad es una medida que refleja la complejidad ciclomática del código. La complejidad ciclomática se calcula en base al número de caminos a través del código, lo cual generalmente se observa a nivel de métodos o funciones individuales. Una complejidad alta puede dificultar la comprensión y la mantención del código.
Duplicados
La presencia de líneas de código duplicadas puede conducir a resultados inesperados y errores en el software. El análisis de duplicados detecta el número de bloques de líneas duplicados en el código, permitiendo detectar y corregir duplicaciones innecesarias. Eliminar duplicados ayuda a mejorar la consistencia y la eficiencia del código.
Evidencias
Las evidencias son fragmentos de código que incumplen alguna de las reglas establecidas en el proyecto. Estos fragmentos pueden representar problemas de seguridad, código innecesario o malas prácticas. Al revisar las evidencias, se pueden identificar y corregir posibles vulnerabilidades o problemas de calidad en el código.
Mantenibilidad
La mantenibilidad es una medida que refleja la calidad general del código en términos de problemas de “Code Smell”. Estos problemas pueden incluir código duplicado, código muerto, acoplamiento excesivo o falta de cohesión. Un alto recuento de problemas de Code Smell indica un código difícil de mantener y comprender, lo cual puede aumentar el riesgo de errores y dificultar futuras modificaciones.
Umbrales de calidad
Los umbrales de calidad son los requisitos establecidos para el proyecto antes de su lanzamiento a producción. Estos requisitos pueden incluir criterios como la ausencia de evidencias bloqueantes, una cobertura de código superior al 80% para el código nuevo, o cumplimiento de estándares de codificación establecidos. Establecer umbrales de calidad claros ayuda a garantizar que el software cumpla con los estándares requeridos antes de ser utilizado por los usuarios finales.
Tamaño del proyecto
El tamaño del proyecto es importante para tener una idea del volumen que representa en términos generales. Nos ayuda a entender la magnitud y alcance del trabajo a realizar.
Pruebas de código
Las pruebas de código son fundamentales para comprobar el correcto funcionamiento de las unidades de código, así como su integración en el proyecto. Estas pruebas nos permiten identificar y corregir posibles errores o fallos antes de que el software sea lanzado o entregado.
Conclusión
En la actualidad, la calidad del software juega un papel cada vez más relevante en el proceso de desarrollo. Es por eso que herramientas como SonarQube se han convertido en plataformas integrales para el análisis de código estático.
SonarQube es una herramienta fundamental para mejorar la calidad del código, reducir la deuda técnica y detectar vulnerabilidades. Su implementación, gracias a su sencillez, se convierte en una ayuda clave para desarrollar un software de calidad.
¿Utilizas SonarQube en tus proyectos de desarrollo de software?
Si no es así, te recomendamos considerar su implementación. ¿Qué otras herramientas utilizas para evaluar la calidad de tu código?
Recuerda que SonarQube se integra con nuestra plataforma de VSM, lo que te permitirá hacer un seguimiento más preciso y detectar errores y vulnerabilidades de seguridad. ¡No dudes en pedir una demo y descubre cómo la gestión del flujo de valor puede ayudarte en tus proyectos!