Il y a quelques semaines j’ai eu l’occasion d’intervenir sur une ferme cliente qui posait des problèmes de performances. Il y avait aussi des problèmes de consistances des données affichées entre plusieurs appels.

J’ai très rapidement suspecté un problème de configuration du load balancer qui répartissait les appels entre les différents serveurs. Cependant n’ayant accès uniquement à la ferme SharePoint, j’ai dû fournir une preuve à l’équipe réseau pour qu’ils déclenchent un incident.

L’installation et la mise en place de SonarQube peut paraitre assez complexe et fastidieuse.

J’espère que cette suite d’articles et les scripts que je vous ai fournis vous ont permis d’aller plus vite dans sa mise en place.

Vous avez maintenant la capacité de déterminer clairement votre dette technique et d’y remédier pour améliorer la qualité de vos développements.

Il est évident que voir apparaitre un millier de problèmes dans le code peut être décourageant, gardez simplement cela en tête :

TL ; DR

Vous avez la possibilité d’afficher les résultats d’analyse SonarQube en direct dans la console erreur et informations de Visual Studio avec la même base de règles configurées pour le projet d’analyse que sur le serveur.

Installation de l’extension

Simplement se rendre sur https://www.sonarlint.org/visualstudio/index.html et procéder à l’installation.

Liaison de la solution Visual Studio au Projet d’analyse

Depuis le Team Explorer cliquer sur SonarQube

Cliquer sur connecter.

TL ; DR

Les erreurs d’analyse statique vont apparaitre comme des warnings dans la section compilation. Un badge d’état de l’analyse statique va apparaitre sur la page de rapport de la build et vous aurez des résultats visibles dans SonarQube.

Résultats affichés avec la build

Lorsque vous lancez une build au résultat vous trouverez un encart supplémentaire pointant vers les résultats de l’analyse statique

Résultats visibles dans SonarQube

Sur votre instance de SonarQube vous trouverez des résultats d’analyse qui indiqueront la progression ou la regression du code. A l’aide de SonarQube vous pourrez vous bâtir des tableaux de bord qui vous aideront à avoir une vision claire sur votre dette technique et comment la corriger.

TL ; DR

L’analyse statique va s’effectuer au moment où vous buildez votre projet. Notez que pour le moment seule une intégration avec msbuild (la tâche Visual Studio Build) existe.

Si vous buildez des projets avec node/npm ou autres, il  est possible que la configuration requise soit différente ainsi que les outils (tâches gulp par exemple).

Ajout des tâches à la définition

Nous partirons du principe que vous avez déjà une build 2015 en place

TL ; DR

SonarQube a une notion de projet d’analyse. Ces projets vont regrouper les résultats d’analyse de votre code. Vous pouvez configurer un projet par dépôt de code ou même par branche pour avoir des deltas d’analyse différents. (ex ma master build tous les mois, je veux voir l’évolution au par mois et ma dev tous les jours donc je veux voir l’évolution tous les jours).

Ajout du projet

Pour cela rendez-vous dans « configuration » -> « Projects » -> « Management » puis « create project »

TL ; DR

Pour éviter que m’importe qui puisse envoyer des résultats d’analyse sur votre serveur SonarQube, nous allons créer un compte de service et forcer l’authentification.

Création du compte de service

Pour cela rendez-vous dans administration, sécurité, utilisateurs et ajoutez un compte.

Provisionnement du compte de service

Pour le référencer dans VSTS, rendez-vous sur votre projet d’équipe, cliquez sur paramètres (la roue crantée), Services, nouveau service générique et entrez url, nom d’usager et mot de passe du compte de service.

TL ; DR

Nous allons installer et configurer un module complémentaire pour déléguer l’authentification à Azure Active Directory. Cela permettra à nos développeurs d’utiliser le même compte entre Visual Studio Team Services et SonarQube.

Configuration du module d’authentification

Depuis la version 5.4 SonarQube dispose d’un plugin supplémentaire pour configurer l’authentification avec AAD en se reposant sur OAuth. Cela va vous permettre d’utiliser vos comptes d’entreprise pour authentifier les collaborateurs et leur donner des permissions.

TL ; DR

L’analyse statique fonctionne à l’aide de règles. Ces règles sont regroupées par langages ou familles de langages dans des modules que vous pouvez installer. Outre l’apport du support de langages de développements ces modules peuvent étendre les fonctionnalités natives de SonarQube.

La plupart sont gratuits et libres, certains sont soumis à des licences commerciales.

Installation des modules complémentaires

Rendez-vous dans configuration, système, et recherchez puis installez les modules qui vous intéressent.

TL ; DR

Nous allons mettre la machine à jour, installer docker dessus, provisionner les conteneurs dont nous avons besoin.

Installation de docker et mises à jour

Connectez-vous en ssh sur la machine (Putty est un très bon client pour windows) et exécutez les commandes suivantes :

https://github.com/baywet/azure-docker-sonarqube#step-4-setup-docker

Mise en place des conteneurs, création des certifcats

Les conteneurs sont les composants de notre installation qui vont effectuer le travail de gérer le trafic web et fournir le service de SonarQube.