sonar sql plugin下載sonar sql plugin源代碼下載

sonar sql plugin

其他類別

1.4.0 release

下載

Sonar-Sql-Plugin

SQL語言（T-SQL，MySQL，PostgreSQL，Snowflake和Vertica SQL方言）Sonarqube的插件

捐贈

您可以通過PayPal支持該項目和其他項目

描述

當前插件支持：

使用Antl4語法使用幾種SQL方言：
- TSQL
- mysql
- Postgresql
- Postgresql
- VSQL
- 雪花
報告的報告：
- sqlcodeguard
- msbuild
- sqlcheck
- 插件報告的SQL代碼違規行為
由SQLCover計算的代碼覆蓋範圍的報告
線和評論線衡量報告
認知和循環複雜性指標報告
自定義用戶規則。用戶可以為受支持的SQL方言的聲明格式定義其他檢測規則。這些規則可以報告針對代碼庫和域的特定代碼違規行為。例如，用戶希望看到代碼violdations，在每個插入語句commit語句之後都找不到代碼violdations。但是，插件不會報告此類代碼，但是，如果用戶以聲明格式定義自定義規則，則Sonarqube將報告此類違規行為。可以在這裡找到更多細節

教程

教程：

將Redgate SQL Code Guard與Sonarqube集成
使用Sonarqube掃描TSQL項目

要求

不同的插件版本支持以下內容：

1.0.0- Sonarqube 7.4+版本
1.2.0- Sonarqube 9+版本

安裝

下載並安裝Sonarqube
從發行版下載插件，然後將其複製到Sonarqube的擴展名插件目錄
啟動Sonarqube並啟用規則
[TSQL]（可選）安裝SQLCodeGuard進入您的構建機器，您打算在其中運行聲納掃描儀
[TSQL，MySQL，Potsgresql]（可選） - 安裝SQLCheck進入您的構建機器，您打算在其中運行聲納掃描儀
[TSQL]（可選）設置SQLCOVER REORTING。您可以在此處檢查TSQL示例以進行完整設置。

入門

請參閱有關如何使用不同方言的示例。

T-SQL

tsql的聲納設置。您可以在這裡檢查示例

 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

Sonar設置為PSSQL。您可以在這裡檢查示例

 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

聲納設置Mysql。您可以在這裡檢查示例

 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

VSQL（Vertica SQL）的聲納設置。您可以在這裡檢查示例

 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

雪花

Sonar設置雪花。您可以在這裡檢查示例

 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

定制規則示例

這是項目的聲納設置的一個示例，該設置使用了本地目錄（位於./rules目錄）的自定義插件規則。您可以在這裡檢查完整示例

 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

插件配置

以下選項可用於配置：

Sonar.sql.diaLect -SQL方言進行分析。默認為TSQL 。支持的值為：TSQL，MySQL，PSSQL，PSSQL，PSSQLV2。
Sonar.sql.Rules.Path-通往Custome規則的路徑，可以是目錄或絕對文件。默認為。 。支持多個值。
Sonar.sql.Rules.Suffix-自定義規則後綴
Sonar.SQL.TSQL.MS.Report-搜索MSBUILD報告的路徑目錄的後綴。默認為靜態編碼分析。 Results.xml 。可以是絕對的或相對的
Sonar.sql.sqlcheck.P ath-通往SQLCHECK工具的路徑。默認為/usr/bin/sqlcheck
Sonar.sql.tsql.cg.Path-通往CodeGuard工具的路徑。默認為c： program文件 sqlcodeguardcmdline sqlcodeguard30.cmd.exe
Sonar.sql.tsql.sqlcover.Report-通往SQLCover報告的路徑。可以是絕對的或後綴來搜索基礎dir。默認為coverage.opencoverxml 。
Sonar.sql.file.Suffixes-文件後綴，該後綴將報告屬於SQL Langauge。默認為.sql
Sonar.sql.sca.Timeout-插件分析的靜態代碼分析的超時值。默認為3600
Sonar.sql.sca.maxfilesize-限製字節中要通過插件分析的文件。默認為2097152
Sonar.sql.rules.skip-逗號分開的recokey：RuleId對選擇插件不會報告的規則，即TSQL -CG：ST008

與PLSQL插件一起使用

請配置其他屬性：

當您想要plsql插件執行（這將禁用執行SQL插件）： sonar.lang.patterns.sql=na
當您想要SQL插件執行（這將禁用PSSQL插件）： sonar.lang.patterns.plsqlopen=na

使用命令行工具

使用插件 - 還有其他CLI工具可用（不需要聲納執行）：

ruleshelper.jar-使用插件和自定義SQL規則的命令行輔助工具

dureshelper

用法：

java -jar rulesHelper.jar將打印幫助
java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql將打印對TSQL方言的AST樹打印

完整的幫助信息：

 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"

貢獻

在本地建造

運行： mvn versions:display-dependency-updates spotless:check spotless:apply install

在本地發展

添加了容器定義，可通過VSCODE輕鬆開發。下載遠程容器擴展程序，然後弄清楚Maven目標。 vscode_remote_containers_extension_maven

然後，您可以生命週期>包裝目標來構建插件。。
將罐子復製到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

啟動聲納克

第一次創建容器

 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

下次只啟動容器

 docker start sonarqube

掃描您的代碼（我使用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