Subdirección de las Tecnologías de la Información y Comunicaciones

Área de Gobernanza y Calidad

Histórico de cambios

Los cambios en las publicaciones vendrán acompañados de un registro de las modificaciones. De este modo se podrá realizar un seguimiento y consultar su evolución.

Introducción

Una de las bases para poder obtener un producto software de calidad y libre de defectos es la detección temprana de errores en el código mientras se desarrolla su programación. Por ello desde la OCA recomendamos el uso de herramientas que proporcionen análisis estáticos de código fuente mediante un catálogo de reglas de calidad predefinida.

Dentro de este marco descrito se encuentra la herramienta SonarLint, plugin desarrollado por los creadores de Sonarqube, herramienta utilizada por la STIC para la verificación de la calidad del código fuente:

SonarLint

Descripción

SonarLint es una extensión para diferentes IDE de desarrollo que permite encontrar incidencias en el código de forma automática mientras se codifica, mostrando las diferentes incidencias para poder localizarlas fácilmente, así como una explicación de la misma y su posible solución.

SonarLint también permite conectar la instancia de SonarQube de la STIC con el entorno de desarrollo de tal forma que el análisis se realice teniendo en cuenta la configuración especifica implantada por la OCA, usando de esta manera las reglas establecidas para cada lenguaje (Java, JavaScript, PHP, Web).

En la Web https://www.sonarlint.org  se puede consultar toda la información relativa a la herramienta, en sus diferentes integraciones.

Integraciones

La herramienta SonarLint está disponible para los siguientes entornos de desarrollo:

• IntelliJ IDEA
• Eclipse
• Visual Studio
• Visual Studio Code
• Atom

Estas integraciones se instalan desde los diferentes IDE. El código de las diferentes integraciones lo podemos encontrar en el GitHub de SonarQube:

https://github.com/search?q=topic%3Asonarlint+org%3ASonarSource+fork%3Atrue

Integración de SonarLint en IntelliJ IDEA

Instalación

La instalación se realiza desde la gestión de plugins del IDE accediendo a  Settings -> Plugins -> BrowseRepositories. Y ahí buscar SonarLint. Tal y como se muestra en la imagen:

Análisis de código

El análisis de código se realiza automáticamente mientras codificamos, mostrando las incidencias en la parte de abajo accesible pulsando el botón de SonarLint        En la derecha se nos mostrará una explicación del problema:

Y a la izquierda un listado con las incidencias del fichero abierto, del proyecto y el log.

Exclusiones de ficheros

Desde la configuración del plugins se permite realizar exclusiones de ficheros para que no sean tratados por el análisis automático.

Vincular con proyecto del SonarQube.

Para vincular nuestro proyecto de SonarQube debemos realizar los siguientes pasos:

1. Agregar el servidor SonarQube al plugin de SonarLint seleccionando la opción SonarQube servers.

Desde la opción de SonarQube servers.

Hay que indicar la URL de nuestro servidor SonarQube, el nombre de la configuración y las opciones de proxy si son necesarias.

Aquí tendremos que indicar el token pudiéndolo generar usando el botón Create Token, o seleccionar otra forma de autenticación.

Una vez creado el servidor veremos que se enlaza con nuestro plugin de SonarLint y ya nos permite conectar con un proyecto en particular.

2. Seleccionar el proyecto de SonarQube con la configuración del proyecto del plugin de SonarLint.

Integración de SonarLint con Eclipse

Instalación

Para instalar el plugin tendremos que ir al Eclipse Marketplace y buscar el SonarLint.

Análisis de código

El análisis de código se realiza automáticamente mientras codificamos, mostrando las diferentes vistas que podemos activar desde el menú Window -> Show View -> Other -> SonarLint.

• SonarLint Issue Locations: vista que nos enlaza con las lineas código causantes del problema.
• SonarLint On-The-Fly: Listado de incidencias del fichero actual.
• SonarLint Report: Listado de incidencias en el proyecto.
• SonarLint Rule Description: Descripción de la incidencia.
• SonarQube Servers: Servidores de SonarQube y enlaces a proyectos.

Vista para ver una explicación del problema.

Vista de incidencias del fichero abierto.

Exclusiones de ficheros

Desde el menú de preferencias, Window -> Preferences, podemos configurar el plugin para realizar exclusiones de ficheros para que no sean tratados por el análisis automático, así como otras propiedades del plugin:

Vincular con proyecto del SonarQube.

Para vincular nuestro proyecto de SonarQube debemos realizar los siguientes pasos.

1. Agregar el servidor SonarQube al plugin de SonarLint, desde el menú contextual en el proyecto entrando en SonarLint -> Bind to a SonarQube project¿ o desde la vista SonarQube Servers
   
   

Pulsando en Connect to a SonarQube server se inicia el asistente para la configuración del nuevo Servidor de SonarQube

Una vez seleccionado el tipo (SonarQube) indicamos el URL

Aquí tendremos que indicar el tipo de autenticación.

La siguiente pantalla nos pedirá la información de las credenciales de autenticación

Una vez creado el servidor veremos que se enlaza con nuestro plugin de SonarLint y ya nos permite conectar con un proyecto en particular.

2. Seleccionar el proyecto de SonarQube con la configuración del proyecto del plugin de SonarLint