Sonar CNES Report

SonarQube est une plateforme ouverte pour gérer la qualité du code. Ce programme peut exporter l'analyse du code depuis un serveur SonarQube sous forme de fichiers docx, xlsx, csv, markdown et texte.

Ce programme est un logiciel libre ; vous pouvez le redistribuer et/ou le modifier selon les termes de la licence publique générale GNU telle que publiée par la Free Software Foundation ; soit la version 3 de la licence, soit (à votre choix) toute version ultérieure.

Cet outil peut être utilisé en standalone comme un exécutable JAR (avec la ligne de commande) ou comme un plugin Sonarqube.

• Sources : https://github.com/lequal/sonar-cnes-report
• Issue tracker : https://github.com/lequal/sonar-cnes-report/issues
• Communiqués de presse : https://github.com/lequal/sonar-cnes-report/releases

Démarrage rapide

• Configurer une instance SonarQube.
• Exécuter une analyse avec sonar-scanner, maven, gradle, msbuild, etc.
• Exécuter cnesreport :
  - En standalone, grâce à la ligne de commande ;
  - En mode plugin, copier le jar dans /opt/sonarqube/plugins, redémarrer sonarqube, puis cliquer sur "More" > "CNES Report".

Installation

Mode autonome

Cnesreport ne nécessite aucune installation. C'est une application Java portable que vous pouvez copier et exécuter selon les exemples suivants. La seule exigence est un JRE à jour (>1.8).

Mode plugin (depuis 2.2.0)
 

• Copiez le fichier sonar-cnes-report.jar dans le dossier plugin de sonarqube (sous linux, le chemin devrait être /opt/sonarqube/plugins).
• Redémarrez sonarqube (Sous linux : sudo service sonar restart)

Installation

cnesreport ne nécessite aucune installation. C'est une application Java portable que vous pouvez copier et exécuter selon les exemples suivants. La seule exigence est un JRE à jour (>1.8).

Obtenir de l'aide

Utilisez java -jar cnesreport.jar -h pour obtenir l'aide suivante sur cnesreport :

usage: java -jar cnesreport.jar [-a <arg>] [-c] [-d <arg>] [-e] [-h] [-l <arg>] [-o <arg>] [-p <arg>] [-r <arg>] 
       [-s <arg>] [-t <arg>] [-v] [-w] [-x <arg>]
Generate editable reports for SonarQube projects.

 -a,--author <arg>                 Name of the report writer.
 -c,--disable-conf                 Disable export of quality configuration used during analysis.
 -d,--date <arg>                   Date for the report. Default: current date.
 -e,--disable-spreadsheet          Disable spreadsheet generation.
 -h,--help                         Display this message.
 -l,--language <arg>               Language of the report. Values: en_US, fr_FR. Default: en_US.
 -o,--output <arg>                 Output path for exported resources.
 -p,--project <arg>                SonarQube key of the targeted project.
 -r,--template-report <arg>        Path to the report template. Default: usage of internal template.
 -s,--server <arg>                 Complete URL of the targeted SonarQube server.
 -t,--token <arg>                  SonarQube token of the SonarQube user who has permissions on the project.
 -v,--version                      Display current version.
 -w,--disable-report               Disable report generation.
 -x,--template-spreadsheet <arg>   Path to the spreadsheet template. Default: usage of internal template.


Please report issues at https://github.com/lequal/sonar-cnes-report/issues

Obtenir les logs

Vous pouvez avoir des logs plus détaillés dans le répertoire caché .cnesreport qui doit être créé dans votre répertoire personnel au premier lancement.

Exemples
 

• Utilisation la plus simple

Ceci est l'utilisation minimale de cnesreport. Cet exemple exporte (rapport + feuille de calcul + configuration) le projet public projectId du serveur SonarQube http://localhost:9000. Ceci utilisera les modèles internes par défaut.

java -jar cnesreport.jar -p projectId

• Utilisation avancée (standalone)

Si vous utilisez une instance sécurisée de SonarQube, vous pouvez fournir un jeton d'authentification SonarQube grâce à l'option -t et spécifier l'url de l'instance SonarQube avec -s. Le modèle interne pour le rapport texte sera remplacé par celui donné par l'option -r.

java -jar cnesreport.jar -t xuixg5hub345xbefu -s https://example.org:9000 -p projectId -r ./template.docx

Des fonctionnalités d'entreprise disponibles pour tous

Comme cette application est utilisée dans de nombreux contextes d'entreprise, nous avons ajouté la possibilité de passer par un proxy. L'application cnesreport utilise la configuration du proxy du système afin que vous n'ayez aucun paramètre fantaisiste à définir.

Pour utiliser la fonction proxy, assurez-vous de définir les propriétés suivantes :

• https.proxyHost

• https.proxyPort

• https.proxyUser

• https.proxyPassword

Exemple

Si le proxy de votre JRE n'est pas défini, vous pouvez utiliser les drapeaux Java comme suit :

java -Dhttps.proxyHost=https://myproxy -Dhttps.proxyPort=42-Dhttps.proxyUser=jerry Dhttps.proxyPassword=siegel-jar cnesreport.jar -t xuixg5hub345xbefu -s https://example.org:9000 -p projectId

Caractéristiques

• Exportation de l'analyse de code sous forme d'un ensemble de fichiers
• Exportation de la configuration de l'analyse de code
• Utilisation de modèles personnalisés
• Obtenir un rapport OpenXML (docx, xlsx) personnalisé
• Obtenez un tableau croisé dynamique avec tous les problèmes
• Exportation en français ou en anglais

Matrice de compatibilité

Remarque sur le mode plugin

• Vous pouvez accéder au plugin avec l'api web (/api/cnesreport/report) ou avec l'interface web (/extension/cnesreport/report / "More" > "CNES Report").
   
• Le mode plugin est conçu pour fournir une utilisation plus facile que l'utilisation autonome. Si vous avez besoin d'utiliser des fonctionnalités avancées, vous devez utiliser le plugin en mode standalone.
   
• Pendant l'exécution, le mode plugin utilise le dossier ${SONARQUBE_HOME}/temp. Il écrit quelques fichiers, les zippe et les envoie au client. Les fichiers sont supprimés après le téléchargement. Si vous interrompez le plugin pendant son exécution (bug, arrêt du sonar, etc.) vous pouvez vérifier ce dossier pour supprimer les fichiers inutiles.

Comment contribuer

Si vous avez rencontré un problème avec le plugin, veuillez ouvrir une question. Dans ce problème, expliquez-nous comment reproduire le problème et collez le log.

Si vous souhaitez faire un PR, veuillez indiquer dans celui-ci la raison de cette demande. Si ce pull request corrige un problème, veuillez insérer le numéro du problème ou expliquer dans le PR comment reproduire ce problème.