Linter embarqué - SonarQube

Themis embarque la version 5.6.6 de SonarQube. Par défaut, une instance de SonarQube est exécutée au démarrage de Themis. Si vous souhaitez utiliser ce linter, vous devez vous assurer que l'instance est bien lancée. Vérifiez dans le fichier de configuration docker-compose.yml que vous n'avez pas placé la variable d'environnement SONARQUBE à FALSE (voir ce lien pour des précisions supplémentaires).

  • Rendez-vous dans la partie Administration > Projets, ouvrez la liste des sources du projet concerné, puis la liste des plugins et enfin, cliquez sur le bouton Ajouter un plugin :

plugin_configuration.png

  • Dans la fenêtre de configuration, sélectionnez la pratique Dette technique et le type de plugin Linter embarqués. Vous avez ensuite la possibilité de n'activer le plugin que pour une durée précise.
  • Une fois le plugin créé, cliquez sur le bouton d'édition des sous-plugins puis sur le bouton de création d'un sous-plugin :

sub_plugin.png

  • Dans la fenêtre de configuration du sous-plugin, sélectionnez Linter embarqué - SonarQube comme type de plugin

SonarQube est intégralement géré par Themis et vous avez seulement la possibilité de configurer les paramètres d'analyse via le formulaire d'édition du plugin. Ce format reprend celui mis en place par SonarSource avec l'utilisation d'un fichier sonar-project.properties. Ce fichier liste des couples <KEY>=<VALUE> avec un couple par ligne.

Plugins installés par défaut

Les langages et plugins pré-installés par défaut les suivants :

Langages Clé Plugins
CSS css CSS / SCSS / Less
Groovy groovy Groovy
Javascript js SonarJs
Java java SonarJava, Pmd et Checkstyle. L'analyse de code compilé n'étant pas disponible,  certaines règles du référentiel SonarJava ne seront pas disponibles à l'analyse.
HTML web Web
Php php SonarPhp
Python python Python
Xml xml SonarXML

Dans la ligne de configuration correspondant aux langages, vous avez ici la possibilité de sélectionner un langage en particulier, si vous ne remplissez pas ce champ, l'ensemble des langages seront analysés. 

Paramètres d'analyse

Voici les principaux attributs que vous pouvez utiliser lors de l'analyse (repris de la documentation officielle de SonarQube) :

Clé Description
sonar.host.url L'URL de l'instance de SonarQube à utiliser, dans le cas où vous souhaitez utiliser votre propre instance. Laissez vide si vous préférez que Themis utilise sa propre instance de SonarQube.
sonar.sources Liste de chemins de répertoires contenant les fichiers sources, séparés par des virgules.
sonar.language Vous pouvez forcer l'analyse à un langage spécifique. Si vous n'appliquez rien à ce champ, une analyse multi-language sera executée. La clé est à retrouver dans le tableau précédent.
sonar.inclusions Liste des motifs de fichiers à inclure dans l'analyse. Quand il est défini, seulement les fichiers qui respectent les motifs seront concernés. Voir la documentation pour la définition des motifs.
sonar.exclusions Liste des motifs de fichiers à exclure de l'analyse, séparés par des virgules. Voir la documentation pour la définition des motifs.

 

 

 

 

 

 

 

 

 

Tous les autres attributs seront exclus de l'analyse.

 

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0

Commentaires

0 commentaire

Veuillez vous connecter pour laisser un commentaire.