Retour aux actualités

Tuto : "intégrer SonarQube à un projet GitLab"

Le 7 février 2024

Temps de lecture estimé : 2 mn
Tuto :

Bonjour, nous allons vous montrer ici comment bénéficier de l’outil de mesure de la qualité de code Sonarqube en l’intégrant à votre projet GitLab.

Assurons-nous au préalable :

  • d’avoir ouvert un compte sur la plateforme GitLab, et avoir créé un projet dans lequel nous déposons le code source de l’application, et pour lequel ont été activés les runners GitLab.
  • d’avoir un accès à la plateforme SonarQube. Vous trouverez toutes les informations nécessaires dans la fiche offre comme on peut le voir à l’écran.

En arrivant sur SonarQube, il nous est proposé de nous connecter avec notre compte Gitlab

Une fois connecté sur SonarQube, nous allons commencer par créer un nouveau projet. Pour ce faire, il suffit de cliquer sur le bouton "create project", et de sélectionner la création manuelle, ou "manually".
Un mode pas à pas va nous guider et nous permettra d’aboutir très facilement.

Après avoir donné un nom au projet, il nous est proposé plusieurs outils d’intégration continue. Nous allons évidemment choisir GitLab CI.

Selon la nature de votre projet, vous pouvez le typer plus précisément. Dans notre cas, nous allons choisir l’option "Other". Apparaît alors sur notre écran un fichier que nous allons devoir créer dans notre dépôt, et dont le contenu est indiqué à l’écran.
Nous allons donc ouvrir notre éditeur de code préféré, ici VSCode, et créer le fichier sonar-project.properties comme indiqué.
Une fois ceci effectué, passons à l’étape suivante : il s’agit ici de créer et paramétrer deux variables CI dans notre projet GitLab, en l’occurrence les variables SONAR_TOKEN et SONAR_URL comme vous pouvez le voir à l’écran.

La dernière étape de ce paramétrage consiste à ajouter un bloc de commandes à notre fichier .gitlab-ci.yml, afin de pouvoir déclencher la première analyse de code dès le prochain commit. Bien entendu, il est tout à fait possible d’adapter la configuration pour déclencher cette analyse à un autre moment : à la création d’une nouvelle version (nouveau tag), ou bien manuellement, à la demande.

Comme nous pouvons le voir, nous n’avons pas modifié le bloc et l’analyse s’est lancée dès notre commit.

SonarQube a donc automatiquement analysé le code de notre projet et nous renvoie ensuite vers le rapport généré.

Nous avons à présent tous les moyens pour maîtriser la qualité du code développé pour notre produit !