Inicio>código fuente JSP>Otras categorias
Descargar

sonar-sql-plugin

SQL Language (T-SQL, MySQL, PostgreSQL, Snowflake y Vertica SQL Dialects) complemento para Sonarqube

Donación

Puede apoyar este proyecto y otros a través de PayPal

Descripción

Actualmente soportes de enchufe:

  • Varios dialectos SQL utilizando gramáticas Antlr4:
    • TSQL
    • Mysql
    • Postgresql
    • Postgresql
    • VSQL
    • COPO DE NIEVE
  • Informes de temas encontrados por:
    • Sqlcodeguard
    • Msbuild
    • Sqlcheck
    • Violaciones del código SQL reportadas por el complemento
  • Informe de la cobertura de código calculada por SQLCover
  • Líneas y comentarios Medidas de las líneas Informes
  • Informes de métricas de complejidad cognitiva y ciclomática
  • Reglas de usuario personalizadas. Los usuarios pueden definir reglas de detección adicionales en el formato declarativo para los dialectos SQL compatibles. Estas reglas pueden informar violaciones del código específicas para la base de código y el dominio. Por ejemplo, el usuario desea ver Violdations del Código donde después de cada declaración de confirmación de inserción no se encuentra. El complemento no informa dicho código, sin embargo, si el usuario define la regla personalizada en el formato declarativo, entonces Sonarqube informará tales violaciones. Se pueden encontrar más detalles aquí

Tutoriales

Tutoriales:

  • Integrar la protección de código Redgate SQL con Sonarqube
  • Escaneo de un proyecto TSQL con Sonarqube

Requisitos

Diferentes versiones de complementos admiten lo siguiente:

  • 1.0.0 - versiones Sonarqube 7.4+
  • 1.2.0 - versiones Sonarqube 9+

Instalación

  1. Descargar e instalar sonarqube
  2. Descargue el complemento de las versiones y cópielo al directorio Extensions Plugins de Sonarqube
  3. Comience Sonarqube y habilite las reglas
  4. [TSQL] (Opcional) Instale SQLCodeGuard en su máquina de compilación donde planea ejecutar el escáner SONAR
  5. [TSQL, MYSQL, POTSGRESQL] (Opcional) - Instale SQLCheck en su máquina de compilación donde planea ejecutar el escáner SONAR
  6. [TSQL] (Opcional) Configuración SQLCover Reorting. Puede consultar el ejemplo de TSQL aquí para obtener una configuración completa.

Empezando

Consulte ejemplos sobre cómo usar diferentes dialectos.

T-SQL

Configuración de sonar para TSQL. Puedes consultar el ejemplo aquí 

 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

Configuración de sonar para PSSQL. Puedes consultar el ejemplo aquí 

 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

Configuración de sonar para MySQL. Puedes consultar el ejemplo aquí 

 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

Configuración de sonar para VSQL (Vertica SQL). Puedes consultar el ejemplo aquí 

 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

COPO DE NIEVE

Configuración de sonar para copos de nieve. Puedes consultar el ejemplo aquí 

 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

Ejemplo de reglas personalizadas

Este es un ejemplo para la configuración de sonar para el proyecto que utiliza reglas de complemento personalizadas del directorio local (ubicado en el directorio ./rules). Puedes consultar el ejemplo completo aquí 

 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

Configuración de complementos

Las siguientes opciones están disponibles para la configuración:

  • Sonar.sql.dialect - Dialecto SQL para el análisis. El valor predeterminado a TSQL . Los valores compatibles son: TSQL, MySQL, PSSQL, PSSQL, PSSQLV2.
  • sonar.sql.rules.path - Path to Custome Reglas, puede ser directorio o archivo absoluto. Predeterminado a. . Se admiten múltiples valores.
  • sonar.sql.rules.suffix - sufijo de reglas personalizadas
  • sonar.sql.tsql.ms.Report - Sufijo a los directorios de ruta de búsqueda para el informe MSBuild. El valor predeterminado a staticcodeanysis.results.xml . Puede ser absoluto o relativo
  • Sonar.sql.sqlcheck.path - Ruta a la herramienta SQLCHECK. Predeterminado es/usr/bin/sqlcheck
  • sonar.sql.tsql.cg.path - Ruta a la herramienta CodeGuard. Predeterminado a c: archivos de programa sqlcodeguardcmdline sqlcodeguard30.cmd.exe
  • sonar.sql.tsql.sqlcover.report - Ruta al informe SQLCover. Puede ser absoluto o sufijo para buscar en la base dir. El valor predeterminado es cobertura.opencoverxml .
  • sonar.sql.file.suffixes - sufijos de archivo que se informarán pertenecientes a SQL Langauge. El valor predeterminado a .sql
  • SONAR.SQL.SCA.TimeOut - Valor de tiempo de espera para el análisis de código estático realizado por complemento en segundos. Predeterminado a 3600
  • sonar.sql.sca.maxfilesize - Límite en bytes para que los archivos se analicen mediante complemento. Los valores predeterminados a 2097152
  • sonar.sql.rules.skip - Lista separada de comas de repokey: pares de reglas para seleccionar reglas que no serán informadas por el complemento, es decir, TSQL -CG: ST008

Usar junto con el complemento PLSQL

Configure las propiedades adicionales:

  • Cuando desee la ejecución del complemento PLSQL (esto deshabilitará la ejecución del complemento SQL): sonar.lang.patterns.sql=na

  • Cuando desee la ejecución del complemento SQL (esto deshabilitará el complemento PSSQL): sonar.lang.patterns.plsqlopen=na

Uso de herramientas de línea de comandos

Con el complemento: hay una herramienta CLI adicional disponible (no requiere ejecución de sonar):

  • Ruleshelper.jar - Herramienta de línea de línea de comandos para trabajar con complementos y reglas SQL personalizadas

germeneño

Uso:

  • java -jar rulesHelper.jar - imprimirá ayuda
  • java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql - Imprimirá un árbol AST analizado para el dialecto TSQL

Información de ayuda completa: 

 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"

Que contribuye

Edificio localmente

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

Desarrollando localmente

Se agregaron definiciones de contenedores para un fácil desarrollo con VScode. Descargue la extensión de contenedores remotos y deje que descubra los objetivos Maven. vscode_remote_containers_extension_maven

  1. Luego puede el objetivo del ciclo de vida> el objetivo del paquete para construir el complemento. El archivo .JAR terminará en el Sonar-SQL-Plugin/SRC/Sonar-SQL-Plugin/Target/ Folder.
  2. Copie el jar en la carpeta de complementos de su instancia de 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. Comienza Sonarqube
  • primera vez crea el contenedor 
 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
  • La próxima vez solo comienza el contenedor 
 docker start sonarqube
  1. Escanee su código (uso un escáner 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. (Opcional) Detente sonarqube
  2. Enjuague - Repita

Agregar un nuevo soporte de gramática

  1. Verifique cómo se generan analizadores y lexers externos a partir de fuentes externas en ./src/external/readme.md
  2. Genere Lexer y Parser, paquete de ejemplo: org.antlr.sql.dialects.vsql
  3. Implementar sqldialect extension basedialect.class, es decir, vSqldialect
  4. Implementar reglas SQL, ejemplo vSQLRULUS
  5. Registrar las reglas en SQLDIALECTRULO. Este paso es opcional, ya que el complemento admitirá reglas personalizadas del proyecto del usuario proporcionado en formato XML.
  6. Actualización ./src/external/readme.md con referencias a su gramática adicional

Ejemplo de compromiso para agregar gramática de copo de nieve: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785

Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo