Startseite>JSP-Quellcode>Andere Kategorien
Herunterladen

Sonar-SQL-Plugin

SQL Language (T-SQL, MySQL, PostgreSQL, Snowflake und Vertica SQL Dialekte) Plugin für Sonarqube

Spenden

Sie können dieses und andere Projekt über PayPal unterstützen

Beschreibung

Derzeit Plug-in-Supports:

  • Mehrere SQL -Dialekte unter Verwendung von Antlr4 -Grammatiken:
    • TSQL
    • Mysql
    • PostgreSQL
    • PostgreSQL
    • Vsql
    • SCHNEEFLOCKE
  • Berichterstattung von Problemen von:
    • SQLCodeGuard
    • MSBUILD
    • Sqlcheck
    • Verstöße gegen SQL -Code, die vom Plugin gemeldet wurden
  • Berichterstattung über die von SQLCover berechnete Codeabdeckung
  • Zeilen und Kommentarlinien messen die Berichterstattung
  • Berichterstattung über kognitive und zyklomatische Komplexitätsmetriken
  • Benutzerdefinierte Benutzerregeln. Benutzer können zusätzliche Erkennungsregeln im deklarativen Format für die unterstützten SQL -Dialekte definieren. Diese Regeln können Verstöße gegen Code melden, die für die Codebasis und die Domäne spezifisch sind. Zum Beispiel möchte der Benutzer Code Violdations ansehen, bei denen nach jeder Einfüge Anweisung Commit Anweisung nicht gefunden wird. Plugin meldet keinen Code, wenn der Benutzer im deklarativen Format eine benutzerdefinierte Regel definiert, meldet Sonarqube solche Verstöße. Weitere Details finden Sie hier

Tutorials

Tutorials:

  • Integration von Redgate SQL Code Guard in Sonarqube
  • Scannen eines TSQL -Projekts mit Sonarqube

Anforderungen

Unterschiedliche Plugin -Versionen unterstützen Folgendes:

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

Installation

  1. Laden Sie Sonarqube herunter und installieren Sie sie
  2. Laden Sie das Plugin aus den Veröffentlichungen herunter und kopieren Sie es in die Extensions Plugins -Verzeichnisse von Sonarqube
  3. Beginnen Sie Sonarqube und aktivieren Sie Regeln
  4. [TSQL] (optional) Installieren Sie SQLCodeGuard in Ihren Build -Computer, auf dem Sie den Sonar -Scanner ausführen möchten
  5. [TSQL, MySQL, PotsGresql] (optional) - SQLCECK in Ihren Build -Computer einbauen, auf dem Sie den Sonar -Scanner ausführen möchten
  6. [TSQL] (optional) Setup SQLCover -Wiederholung. Sie können das TSQL -Beispiel hier überprüfen, um eine vollständige Einrichtung zu erhalten.

Erste Schritte

Bitte beachten Sie Beispiele, wie Sie verschiedene Dialekte verwenden.

T-SQL

Sonareinstellungen für TSQL. Sie können Beispiele hier überprüfen 

 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

Sonareinstellungen für PSSQL. Sie können Beispiele hier überprüfen 

 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

Sonareinstellungen für MySQL. Sie können Beispiele hier überprüfen 

 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

Sonareinstellungen für VSQL (Vertica SQL). Sie können Beispiele hier überprüfen 

 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

SCHNEEFLOCKE

Sonareinstellungen für Schneeflocken. Sie können Beispiele hier überprüfen 

 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

Beispiel für benutzerdefinierte Regeln

Dies ist ein Beispiel für Sonar -Einstellungen für Projekt, das benutzerdefinierte Plugin -Regeln aus dem lokalen Verzeichnis verwendet (im Verzeichnis ./RULES). Hier können Sie das vollständige Beispiel überprüfen 

 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

Plugin -Konfiguration

Die folgenden Optionen stehen zur Konfiguration zur Verfügung:

  • SONAR.SQL.DIALECT - SQL -Dialekt zur Analyse. Standardeinstellung zu TSQL . Unterstützte Werte sind: TSQL, MySQL, PSSQL, PSSQL, PSSQLV2.
  • Sonar.sql.rules.Path - Pfad zu Vorbehaltsregeln kann ein Verzeichnis oder eine absolute Datei sein. Standardmäßig an. . Mehrere Werte werden unterstützt.
  • Sonar.sql.rules.suffix - benutzerdefinierte Regeln Suffix
  • SONAR.SQL.TSQL.MS.REPORT - Suffix für die Suche nach Pfadverzeichnissen für MSBuild -Bericht. Standardeinstellungen zur staticCodeanalyse.Results.xml . Kann absolut oder relativ sein
  • Sonar.sql.sqlcheck.Path - Pfad zum SQLCheck -Tool. Standardeinstellungen zu/usr/bin/sqlcheck
  • Sonar.SQL.TSQL.CG.Path - Pfad zum Codeguard -Tool. Standardeinstellungen zu C: Programmdateien SQLCodeGuardcMdline SQLCodeGuard30.cmd.exe
  • sonar.sql.tsql.sqlcover.Report - Pfad zum SQLCover -Bericht. Kann absolut oder suffix sein, um in Base Dir zu suchen. Standardt zur deckt.opecoverxml .
  • Sonar.sql.file.suffixes - Datei -Suffixe, die von SQL Langauge gehören. Standardmäßig zu .sql
  • Sonar.sql.sca.Timeout - Zeitüberschreitungswert für die statische Codeanalyse durch Plugin in Sekunden. Standardeinstellung auf 3600
  • Sonar.sql.sca.maxFileSize - Limit in Bytes, damit Dateien mit Plugin analysiert werden sollen. Standardeinstellungen bis 2097152
  • Sonar.sql.rules.skip - Komma getrennte Liste von Repokey: RegelID -Paare, um Regeln auszuwählen, die vom Plugin nicht gemeldet werden, dh TSQL -CG: ST008

Verwenden Sie zusammen mit PLSQL -Plugin

Bitte konfigurieren Sie zusätzliche Eigenschaften:

  • Wenn Sie die Ausführung von PLSQL -Plugin -Ausführung wünschen (dies deaktiviert die Ausführung SQL Plugin): sonar.lang.patterns.sql=na

  • Wenn Sie SQL Plugin -Ausführung wünschen (so wird das PSSQL -Plugin deaktiviert): sonar.lang.patterns.plsqlopen=na

Verwenden von Befehlszeilen -Tools

Mit dem Plugin ist zusätzliches CLI -Tool verfügbar (es ist keine Sonarausführung erforderlich):

  • RulleShelper.jar - Befehlszeilen -Helfer -Tool zum Arbeiten mit Plugin und benutzerdefinierten SQL -Regeln

Ruleshelper

Verwendung:

  • java -jar rulesHelper.jar - wird Hilfe drucken
  • java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql - Drucken Sie Parsend AST -Baum für den TSQL -Dialekt

Vollständige Hilfe Info: 

 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"

Beitragen

Lokal bauen

Ausführen: mvn versions:display-dependency-updates spotless:check spotless:apply install

Lokal entwickeln

Containerdefinitionen für eine einfache Entwicklung mit VSCODE hinzugefügt. Laden Sie die Erweiterung der Remote -Container herunter und lassen Sie sie die Maven -Ziele herausfinden. VSCODE_REMOTE_CONTAINERS_EXTERSIVIS_MAVEN

  1. Anschließend können Sie das Plugin für Lebenszyklus> Paket für das Erstellen des Plugins Lifecycle> Package. Die .JAR-Datei landet in der Sonar-SQL-Plugin/SRC/Sonar-SQL-Plugin/Target/ Ordner.
  2. Kopieren Sie das Glas in den Plugins -Ordner Ihrer Sonarqube -Instanz 
 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. Beginnen Sie Sonarqube
  • Erstellen Sie zum ersten Mal den Container 
 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
  • Starten Sie das nächste Mal nur den Container 
 docker start sonarqube
  1. Scannen Sie Ihren Code (ich verwende einen Docker -Scanner) 
 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. (Optional) STOP SONARQUE
  2. Spülen - Wiederholen

Hinzufügen einer neuen Grammatikunterstützung

  1. Überprüfen Sie, wie externe Parsers und Lexer aus externen Quellen unter ./Src/external/Readme.md erzeugt werden
  2. Generieren Sie Lexer und Parser, Beispielpaket: org.antlr.sql.dialects.vsql
  3. Implementieren Sie sqldialect Extending -basiertes. Class, dh vsqldialect
  4. Implementieren Sie SQL -Regeln, Beispiele VSQLRULES
  5. Registrieren Sie Regeln bei SQLDIALECRECLELES. Dieser Schritt ist optional, da Plugin benutzerdefinierte Regeln aus dem im XML -Format bereitgestellten Benutzerprojekt unterstützt.
  6. Update ./src/external/readme.md mit Verweisen auf Ihre zusätzliche Grammatik

Beispiel für das Hinzufügen von Snowflake-Grammatik: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785

Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle