Beranda>Kode sumber JSP>Kategori lainnya
Unduh

sonar-sql-plugin

SQL Language (T-SQL, MySQL, PostgreSQL, Snowflake dan Vertica SQL Dialects) Plugin untuk Sonarqube

Menyumbang

Anda dapat mendukung proyek ini dan orang lain melalui PayPal

Keterangan

Saat ini mendukung plug-in:

  • Beberapa dialek SQL dengan menggunakan tata bahasa ANTLR4:
    • Tsql
    • Mysql
    • PostgreSQL
    • PostgreSQL
    • VSQL
    • KEPINGAN SALJU
  • Pelaporan masalah yang ditemukan oleh:
    • SQLCODEGUARD
    • MsBuild
    • Sqlcheck
    • Pelanggaran kode SQL yang dilaporkan oleh plugin
  • Pelaporan cakupan kode yang dihitung oleh SQLCOVER
  • Lines and Comment Lines mengukur pelaporan
  • Pelaporan metrik kompleksitas kognitif dan siklus
  • Aturan Pengguna Kustom. Pengguna dapat menentukan aturan deteksi tambahan dalam format deklaratif untuk dialek SQL yang didukung. Aturan ini dapat melaporkan pelanggaran kode khusus untuk basis kode dan domain. Misalnya, pengguna ingin melihat violdasi kode di mana setelah setiap pernyataan komit pernyataan tidak ditemukan. Plugin tidak melaporkan kode tersebut, namun, jika pengguna mendefinisikan aturan khusus dalam format deklaratif, maka Sonarqube akan melaporkan pelanggaran tersebut. Rincian lebih lanjut dapat ditemukan di sini

Tutorial

Tutorial:

  • Mengintegrasikan Redgate SQL Code Guard dengan Sonarqube
  • Memindai proyek TSQL dengan sonarquce

Persyaratan

Versi plugin yang berbeda mendukung yang berikut:

  • 1.0.0 - Sonarqube 7.4+ Versi
  • 1.2.0 - Sonarqube 9+ versi

Instalasi

  1. Unduh dan Instal Sonarquce
  2. Unduh Plugin dari Rilis dan Salin ke Direktori Ekstensi Sonarquce Plugins
  3. Mulailah Sonarquce dan aktifkan aturan
  4. [TSQL] (Opsional) Instal SQLCodeguard ke mesin build Anda di mana Anda berencana untuk menjalankan sonar scanner
  5. [TSQL, MySQL, Potsgresql] (Opsional) - Instal SQLCheck ke mesin build Anda di mana Anda berencana menjalankan sonar scanner
  6. [TSQL] (Opsional) Pengaturan SQLCOVER REORTING. Anda dapat memeriksa contoh TSQL di sini untuk pengaturan lengkap.

Memulai

Silakan lihat contoh tentang cara menggunakan dialek yang berbeda.

T-sql

Pengaturan Sonar untuk TSQL. Anda dapat memeriksa contoh di sini 

 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

Pengaturan Sonar untuk Pssql. Anda dapat memeriksa contoh di sini 

 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

Pengaturan Sonar untuk MySQL. Anda dapat memeriksa contoh di sini 

 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

Pengaturan Sonar untuk VSQL (Vertica SQL). Anda dapat memeriksa contoh di sini 

 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

KEPINGAN SALJU

Pengaturan sonar untuk kepingan salju. Anda dapat memeriksa contoh di sini 

 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

Contoh Aturan Kustom

Ini adalah contoh untuk pengaturan sonar untuk proyek yang menggunakan aturan plugin khusus dari direktori lokal (terletak di direktori ./rules). Anda dapat memeriksa contoh lengkap di sini 

 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

Konfigurasi Plugin

Opsi berikut tersedia untuk konfigurasi:

  • sonar.sql.dialect - dialek SQL untuk analisis. Default ke TSQL . Nilai yang didukung adalah: TSQL, MySQL, PSSQL, PSSQL, PSSQLV2.
  • sonar.sql.rules.path - path to custome aturan, dapat menjadi direktori atau file absolut. Default ke. . Beberapa nilai didukung.
  • sonar.sql.rules.suffix - Suffix Aturan Kustom
  • sonar.sql.tsql.ms.report - akhiran untuk mencari direktori jalur untuk laporan msBuild. Default ke staticdodeanalysis.results.xml . Bisa absolut atau relatif
  • sonar.sql.sqlcheck.path - jalur ke alat sqlcheck. Default ke/usr/bin/sqlcheck
  • sonar.sql.tsql.cg.path - jalur ke alat codeguard. Default ke C: Program Files SQLCODEGUARDCMDLINE SQLCODEGUARD30.CMD.EXE
  • sonar.sql.tsql.sqlcover.report - Path to SQLCover Report. Dapat menjadi absolut atau akhiran untuk mencari di dasar dasar. Default untuk cakupan.opencoverxml .
  • sonar.sql.file.suffixes - File sufiks yang akan dilaporkan milik SQL Langauge. Default ke .sql
  • sonar.sql.sca.timeout - nilai batas waktu untuk analisis kode statis yang dilakukan oleh plugin dalam hitungan detik. Default ke 3600
  • sonar.sql.sca.maxfileSize - Batasi dalam byte untuk file yang akan dianalisis dengan plugin. Default ke 2097152
  • sonar.sql.rules.skip - Daftar yang terpisah koma dari Repokey: Pasangan aturan untuk memilih aturan yang tidak akan dilaporkan oleh plugin, yaitu TSQL -CG: ST008

Menggunakan bersama dengan plugin plsql

Harap konfigurasikan properti tambahan:

  • Saat Anda ingin eksekusi plugin PLSQL (ini akan menonaktifkan Plugin SQL Eksekusi): sonar.lang.patterns.sql=na

  • Saat Anda menginginkan eksekusi plugin SQL (ini akan menonaktifkan plugin pssql): sonar.lang.patterns.plsqlopen=na

Menggunakan alat baris perintah

Dengan plugin - ada alat CLI tambahan yang tersedia (tidak memerlukan eksekusi sonar):

  • Ruleshelper.jar - Alat pembantu baris perintah untuk bekerja dengan plugin dan aturan SQL khusus

Ruleshelper

Penggunaan:

  • java -jar rulesHelper.jar - akan mencetak bantuan
  • java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql - Akan mencetak pohon ast yang diuraikan untuk dialek TSQL

Info Bantuan Lengkap: 

 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"

Berkontribusi

Membangun secara lokal

Jalankan: mvn versions:display-dependency-updates spotless:check spotless:apply install

Berkembang secara lokal

Menambahkan definisi wadah untuk pengembangan yang mudah dengan vScode. Unduh ekstensi wadah jarak jauh dan biarkan mengetahui target Maven. vscode_remote_containers_extension_maven

  1. Kemudian Anda dapat hidup> target paket untuk membangun plugin. File .jar akan berakhir di sonar-sql-plugin/src/sonar-sql-plugin/target/ folder.
  2. Salin toples ke folder plugin dari sonarqube instance Anda 
 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. Mulai Sonarqube
  • Pertama kali membuat wadah 
 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
  • Lain kali hanya mulai wadah 
 docker start sonarqube
  1. Pindai kode Anda (saya menggunakan pemindai 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. (Opsional) Hentikan Sonarqube
  2. Bilas - Ulangi

Menambahkan dukungan tata bahasa baru

  1. Periksa bagaimana parser eksternal dan lexers dihasilkan dari sumber eksternal di ./src/external/readme.md
  2. Hasilkan Lexer dan Parser, Paket Contoh: org.antlr.sql.dialects.vsql
  3. Menerapkan sqldialect extending endentialect.class, yaitu vsqldialect
  4. Menerapkan aturan SQL, contoh vsqlrules
  5. Daftar Aturan di Sqldialectrules. Langkah ini opsional karena plugin akan mendukung aturan khusus dari proyek pengguna yang disediakan dalam format XML.
  6. Perbarui ./src/external/readme.md dengan referensi tata bahasa tambahan Anda

Contoh komit untuk menambahkan tata bahasa kepingan salju: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua