Главная страница>Исходный код JSP>Другие категории
Скачать

Sonar-Sql-Plugin

Плагин для Sonarqube для Sonarqube для Sonarqube для Sonarqube для Sonarqube

Пожертвование

Вы можете поддержать этот проект и других через PayPal

Описание

В настоящее время плагические поддержки:

  • Несколько диалектов SQL с использованием грамматики ANTLR4:
    • TSQL
    • Mysql
    • Postgresql
    • Postgresql
    • Vsql
    • Снежинка
  • Сообщение о проблемах, найденных:
    • SQLCODEGUARD
    • MSBUILD
    • SQLCHECK
    • Нарушения кода SQL, сообщаемые плагином
  • Отчетность о покрытии кода, рассчитанная SQLCover
  • Линии и линии комментариев измерения отчетности
  • Отчетность по когнитивной и цикломальной сложности отчетности
  • Пользовательские правила пользователя. Пользователи могут определить дополнительные правила обнаружения в декларативном формате для поддерживаемых диалектов SQL. Эти правила могут сообщать о нарушениях кода, специфичные для базы кода и домена. Например, пользователь хочет видеть кодовые Violdations, где после каждого оператора Commit Commit ancert не найдено. Плагин не сообщает о таком коде, однако, если пользователь определяет пользовательское правило в декларативном формате, то Sonarqube сообщит о таких нарушениях. Подробнее можно найти здесь

Учебные пособия

Учебные пособия:

  • Интеграция Redgate SQL Code Guard с Sonarqube
  • Сканирование проекта TSQL с Sonarqube

Требования

Различные версии плагина поддерживают следующее:

  • 1.0.0 - Sonarqube 7.4+ версии
  • 1.2.0 - версии Sonarqube 9+

Установка

  1. Скачать и установить Sonarqube
  2. Скачать плагин с выпусков и скопируйте его в каталог расширения Sonarqube Plugins
  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

Настройки сонара для 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

Пример пользовательских правил

Это пример для настройки Sonar для Project, который использует пользовательские правила плагина из локального каталога (расположенного по адресу ./rules Directory). Вы можете проверить полный пример здесь 

 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. По умолчанию к статичному кодеализу.results.xml . Может быть абсолютным или относительным
  • Sonar.sql.sqlcheck.path - Path to Sqlcheck Tool. По умолчанию/usr/bin/sqlcheck
  • Sonar.sql.tsql.cg.path - Path to CodeGuard Tool. По умолчанию в C: Program Files SQLCodeGuardCmdline sqlcodeguard30.cmd.exe
  • Sonar.sql.tsql.sqlcover.Report - Путь к отчету SQLCover. Может быть абсолютным или суффиксом для поиска в базовом режиме. По умолчанию к покрытию. Opencoverxml .
  • sonar.sql.file.suffixes - файловые суффиксы, которые будут сообщены, принадлежащие SQL Langauge. По умолчанию .sql
  • sonar.sql.sca.timeout - значение тайм -аута для анализа статического кода, выполненного плагина за секунды. По умолчанию до 3600
  • sonar.sql.sca.maxfilesize - Limit в байтах для файлов, которые будут анализироваться с помощью плагина. По умолчанию до 2097152
  • Sonar.sql.rules.skip - разделенная запятая Список репоки: Правил, чтобы выбрать правила, о которых не будет сообщено плагин, IE TSQL -CG: ST008

Использование вместе с плагином PLSQL

Настройте дополнительные свойства:

  • Когда вы хотите выполнить выполнение плагина PLSQL (это отключит плагин SQL SQL): sonar.lang.patterns.sql=na

  • Когда вы хотите выполнить плагин SQL (это отключит плагин PSSQL): sonar.lang.patterns.plsqlopen=na

Использование инструментов командной строки

С помощью плагина - есть дополнительный инструмент CLI (он не требует выполнения сонара):

  • Ruleshelper.jar - инструмент Helper Command Line для работы с плагинами и пользовательскими правилами 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"

Внося

Здание локально

Запустить: mvn versions:display-dependency-updates spotless:check spotless:apply install

Разработка локально

Добавлены определения контейнеров для легкой разработки с VSCODE. Загрузите расширение удаленных контейнеров и дайте ему выяснить цели Maven. vscode_remote_containers_extension_maven

  1. Тогда вы можете LifeCycle> Target Target для создания плагина. Файл .JAR в конечном итоге в папке /Target/Target/Target/Target/Target/Target/Target/Target/Target/Target/Target .
  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. Начни Сонаркубе
  • В первый раз создать контейнер 
 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. Проверьте, как внешние анализаторы и лексеры генерируются из внешних источников по адресу ./src/external/readme.md
  2. Генерировать Lexer и Parser, пример пакета: org.antlr.sql.dialects.vsql
  3. Реализовать sqlialect extending basealect.class, то есть vsqlidialect
  4. Реализовать правила SQL, пример vsqlrules
  5. Регистрировать правила в SQLidialectrules. Этот шаг необязательно, так как плагин будет поддерживать пользовательские правила из пользовательского проекта, представленного в формате XML.
  6. Обновление ./src/external/readme.md со ссылками на добавленную грамматику

Пример для добавления грамматики снежинки: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a46c46ea785

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все