หน้าแรก>ซอร์สโค้ด JSP>หมวดหมู่อื่นๆ
ดาวน์โหลด

Sonar-sql-plugin

SQL Language (T-SQL, MySQL, PostgreSQL, Snowflake และ Vertica SQL Sidiacts) ปลั๊กอินสำหรับ SonarQube

การบริจาค

คุณสามารถสนับสนุนโครงการนี้และอื่น ๆ ผ่าน PayPal

คำอธิบาย

ปัจจุบันปลั๊กอินรองรับ:

  • ภาษา SQL หลายภาษาโดยใช้ไวยากรณ์ ANTLR4:
    • TSQL
    • mysql
    • PostgreSQL
    • PostgreSQL
    • VSQL
    • เกล็ดหิมะ
  • การรายงานปัญหาที่พบโดย:
    • sqlcodeguard
    • msbuild
    • sqlcheck
    • การละเมิดรหัส SQL รายงานโดยปลั๊กอิน
  • การรายงานความครอบคลุมของรหัสที่คำนวณโดย SQLCover
  • บรรทัดและบรรทัดความคิดเห็นวัดการรายงาน
  • การรายงานตัวชี้วัดความซับซ้อนทางปัญญาและวัฏจักร
  • กฎผู้ใช้ที่กำหนดเอง ผู้ใช้สามารถกำหนดกฎการตรวจจับเพิ่มเติมในรูปแบบการประกาศสำหรับภาษา SQL ที่รองรับ กฎเหล่านี้สามารถรายงานการละเมิดรหัสเฉพาะกับฐานรหัสและโดเมน ตัวอย่างเช่นผู้ใช้ต้องการดูรหัส Violdations ซึ่งไม่พบคำสั่ง INSERT แต่ละคำสั่ง ปลั๊กอินไม่ได้รายงานรหัสดังกล่าวหากผู้ใช้กำหนดกฎที่กำหนดเองในรูปแบบการประกาศ Sonarqube จะรายงานการละเมิดดังกล่าว รายละเอียดเพิ่มเติมสามารถดูได้ที่นี่

บทเรียน

บทเรียน:

  • การรวมตัวป้องกันรหัส Redgate SQL เข้ากับ Sonarqube
  • การสแกนโครงการ TSQL ด้วย Sonarqube

ความต้องการ

ปลั๊กอินเวอร์ชันที่แตกต่างกันรองรับสิ่งต่อไปนี้:

  • 1.0.0 - Sonarqube 7.4+ เวอร์ชัน
  • 1.2.0 - Sonarqube 9+ เวอร์ชัน

การติดตั้ง

  1. ดาวน์โหลดและติดตั้ง sonarqube
  2. ดาวน์โหลดปลั๊กอินจากรีลีสและคัดลอกไปยังไดเรกทอรีส่วนขยายของ Sonarqube
  3. เริ่ม Sonarqube และเปิดใช้งานกฎ
  4. [TSQL] (ไม่บังคับ) ติดตั้ง SQLCodeGuard ลงในเครื่องสร้างของคุณซึ่งคุณวางแผนที่จะเรียกใช้ Sonar Scanner
  5. [TSQL, MySQL, POTSGRESQL] (ไม่บังคับ) - ติดตั้ง SQLCHECK ลงในเครื่องสร้างของคุณซึ่งคุณวางแผนที่จะเรียกใช้ Sonar Scanner
  6. [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

การตั้งค่า Sonar สำหรับ 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

การตั้งค่า Sonar สำหรับ 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

ตัวอย่างกฎที่กำหนดเอง

นี่เป็นตัวอย่างสำหรับการตั้งค่าโซนาร์สำหรับโครงการซึ่งใช้กฎปลั๊กอินที่กำหนดเองจากไดเรกทอรีท้องถิ่น (อยู่ที่./ulules ไดเรกทอรี) คุณสามารถตรวจสอบตัวอย่างเต็มได้ที่นี่ 

 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 Dialect สำหรับการวิเคราะห์ ค่าเริ่มต้นเป็น 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 - พา ธ ไปยังเครื่องมือ CodeGuard ค่าเริ่มต้นเป็น c: program files sqlcodeguardcmdline sqlcodeguard30.cmd.exe
  • Sonar.sql.tsql.sqlcover.Report - เส้นทางไปยังรายงาน SQLCover สามารถเป็นแบบสัมบูรณ์หรือต่อท้ายเพื่อค้นหาในฐาน DIR ค่าเริ่มต้นเป็นความครอบคลุม . openCoverxml
  • Sonar.sql.file.suffixes - ไฟล์ต่อท้ายซึ่งจะรายงานว่าเป็นของ SQL Langauge ค่าเริ่มต้นเป็น. sql
  • sonar.sql.sca.timeout - ค่าการหมดเวลาสำหรับการวิเคราะห์รหัสแบบคงที่ทำโดยปลั๊กอินในไม่กี่วินาที ค่าเริ่มต้นเป็น 3600
  • sonar.sql.sca.maxfilesize - จำกัด ในไบต์สำหรับไฟล์ที่จะวิเคราะห์โดยปลั๊กอิน ค่าเริ่มต้นเป็น 2097152
  • Sonar.sql.rules.skip - รายการคั่นด้วยเครื่องหมายจุลภาคของ Repokey: คู่ Ruleid เพื่อเลือกกฎซึ่งจะไม่ถูกรายงานโดยปลั๊กอินเช่น TSQL -CG: ST008

ใช้ร่วมกับปลั๊กอิน PLSQL

โปรดกำหนดค่าคุณสมบัติเพิ่มเติม:

  • เมื่อคุณต้องการการดำเนินการปลั๊กอิน PLSQL (จะปิดการใช้งานปลั๊กอิน SQL Execution): sonar.lang.patterns.sql=na

  • เมื่อคุณต้องการการดำเนินการปลั๊กอิน SQL (จะปิดการใช้งานปลั๊กอิน PSSQL): sonar.lang.patterns.plsqlopen=na

ใช้เครื่องมือบรรทัดคำสั่ง

ด้วยปลั๊กอิน - มีเครื่องมือ CLI เพิ่มเติม (ไม่จำเป็นต้องดำเนินการ Sonar):

  • Ruleshelper.jar - เครื่องมือตัวช่วยบรรทัดคำสั่งสำหรับการทำงานกับปลั๊กอินและกฎ SQL ที่กำหนดเอง

ผู้ปกครอง

การใช้งาน:

  • java -jar rulesHelper.jar - จะพิมพ์ความช่วยเหลือ
  • java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql - จะพิมพ์ต้นไม้ AST ที่แยกวิเคราะห์สำหรับภาษา TSQL

ข้อมูลความช่วยเหลือแบบเต็ม: 

 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"

การบริจาค

อาคารในพื้นที่

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

พัฒนาในพื้นที่

เพิ่มคำจำกัดความของคอนเทนเนอร์เพื่อการพัฒนาที่ง่ายด้วย VSCODE ดาวน์โหลดส่วนขยายคอนเทนเนอร์ระยะไกลและปล่อยให้มันคิดออกเป้าหมาย Maven vscode_remote_containers_extension_maven

  1. จากนั้นคุณสามารถ Lifecycle> Package Target เพื่อสร้างปลั๊กอิน ไฟล์. jar จะจบลงใน Sonar-SQL-Plugin/Src/Sonar-SQL-Plugin/Farget/ Folder
  2. คัดลอกขวดไปยังโฟลเดอร์ปลั๊กอินของอินสแตนซ์ 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. เริ่ม 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
  1. สแกนรหัสของคุณ (ฉันใช้เครื่องสแกน 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. (ไม่บังคับ) หยุด sonarqube
  2. ล้าง - ทำซ้ำ

การเพิ่มการสนับสนุนไวยากรณ์ใหม่

  1. ตรวจสอบว่าตัวแยกวิเคราะห์ภายนอกและ lexers สร้างขึ้นจากแหล่งข้อมูลภายนอกได้อย่างไรที่ ./src/external/readme.md
  2. สร้าง lexer และ parser ตัวอย่างแพ็คเกจ: org.antlr.sql.dialects.vsql
  3. ใช้ sqldialect extended actendialect.class, IE vsqldialect
  4. ใช้กฎ SQL ตัวอย่าง vsqlrules
  5. ลงทะเบียนกฎที่ SQLDIALECTULES ขั้นตอนนี้เป็นทางเลือกเนื่องจากปลั๊กอินจะรองรับกฎที่กำหนดเองจากโครงการผู้ใช้ที่มีให้ในรูปแบบ XML
  6. อัปเดต ./src/external/readme.md พร้อมการอ้างอิงถึงไวยากรณ์ที่เพิ่มขึ้นของคุณ

ตัวอย่างการกระทำเพื่อเพิ่มไวยากรณ์เกล็ดหิมะ: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785555

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด