Página Inicial>Código fonte JSP>Outras categorias
Baixar

SONAR-SQL-PLUGIN

Idioma SQL (T-SQL, MySQL, PostgreSQL, Snowflake e Dialets SQL SQL) para Sonarqube

Doar

Você pode apoiar este projeto e outros via PayPal

Descrição

Atualmente, suportes de plug-in:

  • Vários dialetos SQL usando gramáticas ANTLR4:
    • TSQL
    • Mysql
    • PostGresql
    • PostGresql
    • Vsql
    • FLOCO DE NEVE
  • Relatório de questões encontradas por:
    • SQLCodeguard
    • Msbuild
    • Sqlcheck
    • Violações de código SQL relatadas pelo plug -in
  • Relatório da cobertura de código calculada pelo SQLCover
  • Linhas e linhas de comentários medem relatórios
  • Relatórios de complexidade cognitiva e ciclomática
  • Regras de usuário personalizadas. Os usuários podem definir regras de detecção adicionais no formato declarativo para os dialetos SQL suportados. Essas regras podem relatar violações de código específicas à base e domínio do código. Por exemplo, o usuário deseja ver o código violdations, onde após cada instrução Inserir a instrução CONMITEM não for encontrada. O plug -in não relata esse código, no entanto, se o usuário definir a regra personalizada no formato declarativo, o Sonarqube reportará essas violações. Mais detalhes podem ser encontrados aqui

Tutoriais

Tutoriais:

  • Integração do Redgate SQL Code Guard com Sonarqube
  • Examinando um projeto TSQL com Sonarqube

Requisitos

Diferentes versões do plug -in suporta o seguinte:

  • 1.0.0 - Versões Sonarqube 7.4+
  • 1.2.0 - Sonarqube 9+ versões

Instalação

  1. Baixar e instalar Sonarqube
  2. Faça o download do plug -in dos lançamentos e copie -o para o Sonarqube's Extensions Plugins Directory
  3. Iniciar o sonarqube e permitir regras
  4. [TSQL] (Opcional) Instale o SQLCodeguard na sua máquina de construção, onde você planeja executar o Sonar Scanner
  5. [TSQL, MySQL, POTSGRESQL] (Opcional) - Instale o SQLCHECK na sua máquina de construção, onde você planeja executar o Sonar Scanner
  6. [TSQL] (Opcional) Configure a reortção SQLCover. Você pode verificar o exemplo do TSQL aqui para obter uma configuração completa.

Começando

Consulte Exemplos sobre como usar dialetos diferentes.

T-SQL

Configurações do sonar para TSQL. Você pode verificar o exemplo aqui 

 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

Configurações de sonar para PSSQL. Você pode verificar o exemplo aqui 

 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

Configurações de sonar para MySQL. Você pode verificar o exemplo aqui 

 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

Configurações do sonar para VSQL (Vertica SQL). Você pode verificar o exemplo aqui 

 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

FLOCO DE NEVE

Configurações do sonar para floco de neve. Você pode verificar o exemplo aqui 

 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

Exemplo de regras personalizadas

Este é um exemplo para configurações de sonar para o projeto, que utiliza regras de plug -in personalizadas do diretório local (localizado no diretório ./Rules). Você pode verificar o exemplo completo aqui 

 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

Configuração do plug -in

As seguintes opções estão disponíveis para configuração:

  • SONAR.SQL.DIALECT - SQL DIALECT PARA ANÁLISE. Padrões para TSQL . Os valores suportados são: TSQL, MYSQL, PSSQL, PSSQL, PSSQLV2.
  • SONAR.SQL.RULES.PATH - Caminho para as regras do Custome, pode ser diretório ou arquivo absoluto. Padrão para. . Vários valores são suportados.
  • SONAR.SQL.RULES.SUFFIX - Regras personalizadas sufixo
  • SONAR.SQL.TSQL.MS.REPORT - Sufixo para pesquisar diretórios de caminho do Relatório MSBUILD. Padrões para staticCodeanalysis.results.xml . Pode ser absoluto ou relativo
  • SONAR.SQL.SQLCHECK.PATH - Ferramenta Pato para Sqlcheck. Padrão para/usr/bin/sqlcheck
  • SONAR.SQL.TSQL.CG.PATH - Caminho para a ferramenta CodeGuard. Padrão para C: Arquivos de Programas SqlCodeGuardCmdline SqlcodeGuard30.cmd.exe
  • SONAR.SQL.TSQL.SQLCOVER.REPORT - Relatório de caminho para SQLCover. Pode ser absoluto ou sufixo para pesquisar no dir. Padrões para a cobertura.opencoverxml .
  • SONAR.SQL.FILE.SUFFIXES - Sufixos de arquivo que serão relatados pertencentes ao SQL Langauge. Padrão para .sql
  • SONAR.SQL.SCA.TIMEOUT - Valor do tempo limite para análise de código estático feito por plug -in em segundos. Padrão para 3600
  • SONAR.SQL.SCA.MAXFILLESIZE - Limite em bytes para os arquivos a serem analisados ​​pelo plug -in. Padrão para 2097152
  • SONAR.SQL.RULES.SKIP - Lista de vírgula separada de Revokey: RuleId Pares para selecionar regras que não serão relatadas pelo plug -in, por exemplo, TSQL -CG: ST008

Usando junto com o plug -in PLSQL

Configure propriedades adicionais:

  • Quando você deseja execução do plug -in do PLSQL (isso desativará o plug -in SQL de execução): sonar.lang.patterns.sql=na

  • Quando você deseja a execução do plug -in SQL (isso desativará o plug -in PSSQL): sonar.lang.patterns.plsqlopen=na

Usando ferramentas de linha de comando

Com o plug -in - existe uma ferramenta CLI adicional disponível (não requer execução do sonar):

  • RULSHELPER.JAR - FERRAMENTA DE ASSINADOR DE LINHA DE COMANDO PARA TRABALHAR COM PUNDIN E REGRAS SQL Custom

RulaShelper

Uso:

  • java -jar rulesHelper.jar - Imprimirá a ajuda
  • java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql - Imprimirá a árvore AST analisada para o dialeto TSQL

Informações completas de ajuda: 

 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"

Contribuindo

Construindo localmente

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

Desenvolvendo localmente

Definições de contêiner adicionadas para facilitar o desenvolvimento com o VSCODE. Faça o download da extensão dos contêineres remotos e deixe descobrir os alvos maven. vscode_remote_containers_extension_maven

  1. Em seguida, você pode ciclo de vida> alvo do pacote para criar o plug -in. O arquivo .jar acabará na pasta SOMAR-SQL-PLUGIN/SRC/SONAR-SQL-PLUGIN/Target/ .
  2. Copie o frasco para a pasta Plugins da sua instância 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. Iniciar Sonarqube
  • Primeira vez, crie o contêiner 
 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
  • Na próxima vez, apenas inicie o contêiner 
 docker start sonarqube
  1. Digitalize seu código (eu uso um scanner do 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) Pare o Sonarqube
  2. Enxágue - Repita

Adicionando um novo suporte de gramática

  1. Verifique como os analisadores e lexers externos são gerados a partir de fontes externas em ./src/external/readme.md
  2. Gere Lexer e Parser, pacote de exemplo: org.antlr.sql.dialects.vsql
  3. Implementar sqldialect estender baseado.class, ou seja, vsqldialect
  4. Implementar regras SQL, exemplo vsqlrules
  5. Registrar regras em sqldialetrules. Esta etapa é opcional, pois o plug -in suportará regras personalizadas do projeto de usuário fornecido no formato XML.
  6. Atualização ./src/external/readme.md com referências à sua gramática adicionada

Exemplo Compromet para adicionar Snowflake Grammar: https://github.com/gretard/sonar-sql-plugin/commit/e3296a5d1c69a031f24358aad87a4e46c46ea785

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos