sonar sql pluginのダウンロード - sonar sql pluginソースコードダウンロード

sonar sql plugin

その他のカテゴリー

1.4.0 release

ダウンロード

Sonar-SQL-Plugin

SQL言語（T-SQL、MySQL、PostgreSQL、Snowflake、Vertica SQL Dialects）Sonarqubeのプラグイン

寄付

PayPalを介してこのプロジェクトやその他のプロジェクトをサポートできます

説明

現在、プラグインサポート：

ANTLR4文法を使用して、いくつかのSQL方言を使用して：
- TSQL
- mysql
- postgreSql
- postgreSql
- vsql
- スノーフレーク
発見された問題の報告：
- sqlcodeguard
- msbuild
- sqlcheck
- プラグインによって報告されたSQLコード違反
SQLCoverによって計算されたコードカバレッジのレポート
報告書とコメントラインの測定報告
認知および環状複雑さのメトリックレポート
カスタムユーザールール。ユーザーは、サポートされているSQL方言の宣言形式で追加の検出ルールを定義できます。これらのルールは、コードベースとドメインに固有のコード違反を報告できます。たとえば、ユーザーは、各挿入ステートメントの後にコミットステートメントが見つからないコードバイオルデーションを表示したいと考えています。ただし、プラグインはそのようなコードを報告しませんが、ユーザーが宣言形式でカスタムルールを定義する場合、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

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.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-カスタムルールへのパスは、ディレクトリまたは絶対ファイルにすることができます。デフォルトです。 。複数の値がサポートされています。
sonar.sql.rules.suffix-カスタムルールの接尾辞
sonar.sql.tsql.ms.Report -msbuildレポートのパスディレクトリを検索するサフィックス。デフォルトはstaticcodeanalysis.results.xmlになります。絶対的または相対的なものにすることができます
sonar.sql.sqlcheck.path -sqlcheckツールへのパス。デフォルトは/usr/bin/sqlcheckになります
sonar.sql.tsql.cg.path-コードガードツールへのパス。デフォルトはc：プログラムファイル sqlcodeguardcmdline sqlcodeguard30.cmd.exeになります
sonar.sql.tsql.sqlcover.Report -SQLCoverレポートへのパス。ベースディードで検索するための絶対または接尾辞にすることができます。 default.opencoverxmlにデフォルト。
sonar.sql.file.suffixes- SQLランゲージに属する報告されるファイルサフィックス。デフォルトは.sqlです
sonar.sql.sca.timeout-秒単位でプラグインで行われた静的コード分析のタイムアウト値。デフォルトは3600です
sonar.sql.sca.maxfilesize-プラグインによって分析されるファイルのバイトの制限。デフォルトは2097152です
sonar.sql.rules.skip-コンマの分離repokeyのリスト：Ruleidペアプラグインによって報告されないルールを選択するためのルール、すなわちtsql -cg：st008

PLSQLプラグインと一緒に使用します

追加のプロパティを構成してください：

PLSQLプラグインの実行が必要な場合（これにより、実行されますSQLプラグインが無効になります）： sonar.lang.patterns.sql=na
SQLプラグインの実行が必要な場合（これによりPSSQLプラグインが無効になります）： sonar.lang.patterns.plsqlopen=na

コマンドラインツールを使用します

プラグインを使用すると、追加のCLIツールがあります（ソナーの実行は必要ありません）：

Ruleshelper.jar-プラグインとカスタムSQLルールを操作するためのコマンドラインヘルパーツール

ルールシェルパー

使用法：

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

次に、ライフサイクル>パッケージターゲットを使用して、プラグインを構築できます。 .jarファイルは、Sonar-SQL-Plugin/SRC/SONAR-SQL-PLUGIN/ターゲット/フォルダーになります。
jarを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

Sonarqubeを開始します

初めてコンテナを作成します

 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

（オプション）Sonarqubeを停止します
すすぎ - 繰り返します

新しい文法サポートを追加します

./src/external/readme.mdの外部ソースから外部パーサーとレクサーがどのように生成されるかを確認します
LexerとParserを生成し、パッケージの例：org.antlr.sql.dialects.vsql
sqldialect extending beadialect.class、すなわちvsqldialectを実装します
SQLルール、例vsqlrulesの実装
sqldialectrulesでルールを登録します。プラグインはXML形式で提供されるユーザープロジェクトのカスタムルールをサポートするため、このステップはオプションです。
更新/external/readme.md追加の文法への参照

スノーフレーク文法を追加するためのコミット：https：//github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785

拡大する

追加情報