Page d'accueil>Code source JSP>Autres catégories
Télécharger

Sonar-SQL-Plugin

SQL Language (T-SQL, MySQL, Postgresql, SnowFlake et Vertica SQL Dialects) Plugin pour Sonarqube

Donant

Vous pouvez soutenir ce projet et d'autres via PayPal

Description

Prise en charge du plug-in: actuellement:

  • Plusieurs dialectes SQL en utilisant des grammaires antlr4:
    • Tsql
    • Mysql
    • Postgresql
    • Postgresql
    • Vsql
    • FLOCON DE NEIGE
  • Rapport des problèmes trouvés par:
    • Sqlcodeguard
    • Msbuild
    • Sqlcheck
    • Violations de code SQL rapportées par le plugin
  • Rapports de la couverture du code calculé par SQLCOVER
  • Lignes et commentaires Lignes mesures Rapports
  • Métriques de complexité cognitive et cyclomatique
  • Règles de l'utilisateur personnalisés. Les utilisateurs peuvent définir des règles de détection supplémentaires dans le format déclaratif pour les dialectes SQL pris en charge. Ces règles peuvent signaler les violations de code spécifiques à la base de code et au domaine. Par exemple, l'utilisateur souhaite voir les viooldations du code où après chaque instruction d'instruction d'insertion n'est pas trouvée. Le plugin ne signale pas ce code, cependant, si l'utilisateur définit la règle personnalisée dans le format déclaratif, alors Sonarqube rapportera ces violations. Plus de détails peuvent être trouvés ici

Tutoriels

Tutoriels:

  • Intégration de Redgate SQL Code Guard avec SonarQube
  • Analyse d'un projet TSQL avec Sonarqube

Exigences

Différentes versions de plugin prennent en charge les éléments suivants:

  • 1.0.0 - versions Sonarqube 7.4+
  • 1.2.0 - versions Sonarqube 9+

Installation

  1. Télécharger et installer Sonarqube
  2. Téléchargez le plugin à partir des versions et copiez-la dans le répertoire d'extensions de Sonarqube Plugins
  3. Démarrez sonarqube et activez les règles
  4. [TSQL] (Facultatif) Installez SQLCodeGuard dans votre machine de construction où vous prévoyez d'exécuter un scanner sonar
  5. [TSQL, MYSQL, POTSGRESQL] (Facultatif) - Installez SQLCHECK dans votre machine de construction où vous prévoyez d'exécuter le scanner de sonar
  6. [TSQL] (Facultatif) Configuration SQLCOVER REFORTING. Vous pouvez vérifier l'exemple TSQL ici pour une configuration complète.

Commencer

Veuillez consulter des exemples sur la façon d'utiliser différents dialectes.

T-SQL

Paramètres de sonar pour TSQL. Vous pouvez vérifier l'exemple ici 

 sonar.projectKey=examples.sql.mysql.project
sonar.projectName=examples.sql.mysql.project
sonar.projectVersion=1.1
sonar.sources=src
# optional
sonar.language=sql
# optional as plugin defaults to tsql
sonar.sql.dialect=tsql

Postgresql

Paramètres de sonar pour PSSQL. Vous pouvez vérifier l'exemple ici 

 sonar.projectKey=examples.sql.psql.project
sonar.projectName=examples.sql.psql.project
sonar.projectVersion=1.1
sonar.sources=src
# optional
sonar.language=sql
sonar.sql.dialect=pssqlv2

Mysql

Paramètres de sonar pour MySQL. Vous pouvez vérifier l'exemple ici 

 sonar.projectKey=examples.sql.mysql.project
sonar.projectName=examples.sql.mysql.project
sonar.projectVersion=1.1
sonar.sources=src
# optional
sonar.language=sql
sonar.sql.dialect=mysql

Vsql

Paramètres de sonar pour VSQL (Vertica SQL). Vous pouvez vérifier l'exemple ici 

 sonar.projectKey=examples.sql.vsql.project
sonar.projectName=examples.sql.vsql.project
sonar.projectVersion=1.1
sonar.sources=src
# optional
sonar.language=sql
sonar.sql.dialect=vsql

FLOCON DE NEIGE

Paramètres de sonar pour le flocon de neige. Vous pouvez vérifier l'exemple ici 

 sonar.projectKey=examples.sql.snowflake.project
sonar.projectName=examples.sql.snowflake.project
sonar.projectVersion=1.1
sonar.sources=src
# optional
sonar.language=sql
sonar.sql.dialect=snowflake

Exemple de règles personnalisées

Ceci est un exemple pour les paramètres de sonar pour le projet qui utilise des règles de plugin personnalisées du répertoire local (situé sur ./rules Directory). Vous pouvez vérifier l'exemple complet ici 

 sonar.projectKey=pssql.custom.rules
sonar.projectName=Test PSSQL custom rules project
sonar.projectVersion=1.0
sonar.sources=src

# optional
sonar.language=sql
sonar.sql.dialect=pssqlv2

# change these
sonar.sql.rules.path=./rules

Configuration du plugin

Les options suivantes sont disponibles pour la configuration:

  • Sonar.sql.dialect - dialecte SQL pour l'analyse. Par défaut à TSQL . Les valeurs prises en charge sont: TSQL, MySQL, PSSQL, PSSQL, PSSQLV2.
  • Sonar.sql.rules.path - Path to Custome Rules, peut être un répertoire ou un fichier absolu. Par défaut. . Plusieurs valeurs sont prises en charge.
  • sonar.sql.rules.suffix - suffixe de règles personnalisés
  • Sonar.sql.tsql.ms.Report - Suffix pour rechercher les répertoires de chemin pour le rapport MSBuild. Par défaut à staticcodeanalysis.results.xml . Peut être absolu ou relatif
  • sonar.sql.sqlcheck.path - Path vers l'outil SQLCHECK. Par défaut à / usr / bin / sqlcheck
  • sonar.sql.tsql.cg.path - Path vers l'outil de code de code. Par défaut est C: Program Files sqlcodeGuardcmdline sqlcodeguard30.cmd.exe
  • sonar.sql.tsql.sqlcover.Report - Path vers le rapport SQLCOVER. Peut être absolu ou suffixe à rechercher dans le Dir de base. Par défaut à la couverture.OpencoverXml .
  • Sonar.sql.file.suffixes - suffixes de fichiers qui seront signalés appartenant à SQL Langauge. Par défaut.
  • Sonar.sql.sca.timeout - Valeur de tempsout pour l'analyse de code statique effectuée par plugin en secondes. Par défaut à 3600
  • Sonar.sql.sca.maxFileSize - Limite en octets pour les fichiers à analyser par plugin. Par défaut est à 2097152
  • Sonar.sql.rules.skip - Liste séparée de la virgule de REPOKEY: RuleID Pairs pour sélectionner des règles qui ne seront pas signalées par le plugin, c'est-à-dire TSQL-CG: ST008

En utilisant avec le plugin PLSQL

Veuillez configurer des propriétés supplémentaires:

  • Lorsque vous souhaitez l'exécution du plugin PLSQL (cela désactivera l'exécution du plugin SQL): sonar.lang.patterns.sql=na

  • Lorsque vous voulez l'exécution du plugin SQL (cela désactivera le plugin pssql): sonar.lang.patterns.plsqlopen=na

Utilisation d'outils de ligne de commande

Avec le plugin - il y a un outil CLI supplémentaire disponible (il ne nécessite pas d'exécution de sonar):

  • ratushelper.jar - outil d'assistance de ligne de commande pour travailler avec le plugin et les règles SQL personnalisées

ruleshelper

Usage:

  • java -jar rulesHelper.jar - imprimera l'aide
  • java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql - Imprimera l'arbre AST analysé pour le dialecte TSQL

Informations sur l'aide complète: 

 Please pass the following: 
	action  (print, verify or analyze)
	type    (text or file)
	value   (sql string or path to rules file/folder) 
	dialect (tsql, pssql, mysql, pssql, pssqlv2, snowflake)
	folder  (folder to analyze, only applicable when using analyze action)

Example to print AST tree:
	print text "SELECT * FROM dbo.test;" tsql

Example to verify custom rules definitions:
	verify file "c:/tests/customRules.rules;" mysql

Example to execute custom rules and plugin rules against specified folder:
	analyze file "c:/tests/customRules.rules;" snowflake "c:docssrc"

Example to execute sql analysis againt specified folder:
	analyze file "NA" snowflake "c:docssrc"

Contributif

Construire localement

Exécution: mvn versions:display-dependency-updates spotless:check spotless:apply install

Développer localement

Ajout de définitions de conteneurs pour un développement facile avec VSCODE. Téléchargez l'extension des conteneurs distants et laissez-le comprendre les cibles Maven. VSCODE_REMOTE_CONTAINERS_EXTENCE_MAVEN

  1. Ensuite, vous pouvez le cycle de vie> cible du package pour construire le plugin. Le fichier .jar se retrouvera dans le dose sonar-sql-plugin / src / sonar-sql-plagin / cible / target / .
  2. Copiez le pot dans le dossier des plugins de votre instance Sonarqube 
 mkdir -p ~/workspace/sonarqube/extensions/plugins
cp ~/workspace/sonar-sql-plugin/src/sonar-sql-plugin/target/sonar-sql-plugin-1.1.0.jar ~/workspace/sonarqube/extensions/plugins
  1. Commencer sonarqube
  • Créez la première fois le conteneur 
 docker run -i --name sonarqube 
  -p 9000:9000 
  -v ~/workspace/sonarqube/conf:/opt/sonarqube/conf 
  -v ~/workspace/sonarqube/extensions:/opt/sonarqube/extensions 
  -v ~/workspace/sonarqube/logs:/opt/sonarqube/logs 
  -v ~/workspace/sonarqube/data:/opt/sonarqube/data 
  sonarqube
  • La prochaine fois, commencez seulement le conteneur 
 docker start sonarqube
  1. Scanner votre code (j'utilise un scanner docker) 
 docker run 
    --rm 
    -e SONAR_HOST_URL="http://127.0.0.1:9000" 
    -e SONAR_LOGIN="YOUR_ADMIN_TOKEN_HERE" 
    -e SONAR_PASSWORD="YOUR_ADMIN_PWD_HERE" 
    --network="host" 
    -v "FOLDER_WITH_THE_CODE:/usr/src" 
    sonarsource/sonar-scanner-cli -X
  1. (Facultatif) Arrêtez sonarqube
  2. Rinter - répéter

Ajout d'un nouveau support de grammaire

  1. Vérifiez comment les analyseurs et lexers externes sont générés à partir de sources externes à ./src/external/readme.md
  2. Générer lexer et l'analyseur, exemple package: org.antlr.sql.dialects.vsql
  3. Implémentez SQLDIALECT Extension BasedIalect.Class, c'est-à-dire VSQLDIALECT
  4. Implémentez les règles SQL, exemple vsqlrules
  5. Enregistrer les règles à SQLDIAL SECTRULES. Cette étape est facultative car le plugin prendra en charge les règles personnalisées du projet utilisateur fourni au format XML.
  6. Mettre à jour ./src/external/readme.md avec des références à votre grammaire supplémentaire

Exemple d'engagement pour ajouter une grammaire de flocon de neige: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout