sonar sql plugin

سونار SQL-Plugin

لغة SQL (T-SQL ، MySQL ، PostgreSQL ، Snowflake و Vertica SQL Dives)

التبرع

يمكنك دعم هذا المشروع وغيرهم عبر PayPal

وصف

يدعم المكونات الإضافية حاليًا:

• العديد من لهجات SQL باستخدام قواعد Antlr4:
  • TSQL
  • MySQL
  • postgresql
  • postgresql
  • VSQL
  • ندفة الثلج
• الإبلاغ عن القضايا التي وجدتها:
  • SqlCodeGuard
  • msbuild
  • Sqlcheck
  • انتهاكات رمز SQL التي أبلغ عنها البرنامج المساعد
• الإبلاغ عن تغطية الكود المحسوبة بواسطة SQLCover
• خطوط وخطوط التعليقات تدابير التقارير
• تقارير مقاييس التعقيد المعرفي و cyclomatic
• قواعد المستخدم المخصصة. يمكن للمستخدمين تحديد قواعد الكشف الإضافية بالتنسيق التعريفي لهجات SQL المدعومة. يمكن لهذه القواعد الإبلاغ عن انتهاكات الكود الخاصة بقاعدة الكود والمجال. على سبيل المثال ، يريد المستخدم رؤية الرمز violdations حيث لم يتم العثور على بيان ملزم بعد كل بيان. لا يبلغ البرنامج المساعد هذا الرمز ، ومع ذلك ، إذا قام المستخدم بتعريف القاعدة المخصصة بالتنسيق التصريحي ، فسيقوم Sonarqube بالإبلاغ عن مثل هذه الانتهاكات. يمكن العثور على مزيد من التفاصيل هنا

دروس

دروس:

• دمج حارس رمز Redgate SQL مع Sonarqube
• مسح مشروع TSQL مع Sonarqube

متطلبات

تدعم إصدارات البرنامج المساعد المختلفة ما يلي:

• 1.0.0 - إصدارات Sonarqube 7.4+
• 1.2.0 - إصدارات Sonarqube 9+

تثبيت

1. تنزيل وتثبيت Sonarqube
2. قم بتنزيل البرنامج المساعد من الإصدارات ونسخه إلى دليل ملحقات Sonarqube Plugins
3. ابدأ Sonarqube وتمكين القواعد
4. [TSQL] (اختياري) قم بتثبيت SQLCodeGuard في جهاز الإنشاء الخاص بك حيث تخطط لتشغيل الماسح الضوئي السونار
5. [TSQL ، MySQL ، Potsgresql] (اختياري) - قم بتثبيت SQLCheck في جهاز الإنشاء الخاص بك حيث تخطط لتشغيل الماسح الضوئي للونار
6. [TSQL] (اختياري) الإعداد sqlcover إعادة. يمكنك التحقق من مثال 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.Suffix - لاحقة القواعد المخصصة
• سونار. الإعدادات الافتراضية إلى staticcodeanalysis.results.xml . يمكن أن تكون مطلقة أو نسبية
• سونار. الإعدادات الافتراضية إلى/usr/bin/sqlcheck
• Sonar.sql.tsql.cg.path - مسار إلى أداة CodeGuard. الإعدادات الافتراضية إلى C: Program Files sqlCodeGuardCmdline SQLCodeGuard30.cmd.exe
• سونار. يمكن أن تكون مطلقة أو لاحقة للبحث في قاعدة dir. الإعدادات الافتراضية للتغطية . opencoverxml.
• Sonar.sql.file.suffixes - لاحقة الملفات التي سيتم الإبلاغ عنها تنتمي إلى SQL Langauge. الإعدادات الافتراضية إلى .SQL
• سونار الإعدادات الافتراضية إلى 3600
• Sonar.sql.sca.maxfilesize - الحد في بايت للملفات ليتم تحليلها بواسطة البرنامج المساعد. الإعدادات الافتراضية حتى 2097152
• Sonar.Sql.Rules.Skip - قائمة مفصولة مفصولة من إعادة البيع: أزواج القواعد لتحديد القواعد التي لن يتم الإبلاغ عنها بواسطة المكون الإضافي ، أي TSQL -CG: ST008

باستخدام البرنامج المساعد PLSQL

يرجى تكوين خصائص إضافية:

• عندما تريد تنفيذ PLSQL Plugin (سيؤدي ذلك إلى تعطيل البرنامج المساعد SQL للتنفيذ): sonar.lang.patterns.sql=na

• عندما تريد تنفيذ المكون الإضافي SQL (سيؤدي ذلك إلى تعطيل البرنامج المساعد PSSQL): sonar.lang.patterns.plsqlopen=na

استخدام أدوات سطر الأوامر

باستخدام البرنامج المساعد - تتوفر أداة إضافية CLI (لا تتطلب تنفيذ السونار):

• Ruleshelper.jar - أداة مساعد سطر الأوامر للعمل مع المكون الإضافي وقواعد SQL المخصصة

Ruleshelper

الاستخدام:

• 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"

المساهمة

بناء محليا

تشغيل: mvn versions:display-dependency-updates spotless:check spotless:apply install

النمو محليا

تعريفات الحاوية المضافة لسهولة التطوير مع VSCode. قم بتنزيل امتداد الحاويات عن بُعد واتركه يكتشف أهداف Maven.

1. ثم يمكنك دورة LIFECYCLE> TARGET لإنشاء المكون الإضافي. سينتهي ملف .jar في Sonar-SQL-Plugin/SRC/Sonar-SQL-Plugin/Target/ 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

3. ابدأ 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

4. مسح الرمز الخاص بك (أنا أستخدم ماسح الضوئي 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

5. (اختياري) توقف Sonarqube
6. شطف - كرر

إضافة دعم نحوي جديد

0. تحقق من كيفية توليد المحللين الخارجيين و lexers من مصادر خارجية في ./SRC/EXERNAL/README.MD
1. إنشاء Lexer و Parser ، حزمة مثال: org.antlr.sql.dialects.vsql
2. تنفيذ sqldialect تمديد المستند إلى class ، أي vsqldialect
3. تنفيذ قواعد SQL ، مثال vsqlrules
4. تسجيل القواعد في sqldialectrules. هذه الخطوة اختيارية لأن البرنامج المساعد يدعم القواعد المخصصة من مشروع المستخدم المتوفر بتنسيق XML.
5. تحديث ./SRC/EXERNAL/README.MD مع إشارات إلى قواعد اللغة الإضافية الخاصة بك

Example commit for adding Snowflake grammar: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785