sonar php

Qualidade e segurança de código para PHP

Este projeto SonarSource é um analisador de código estático para a linguagem PHP usada como uma extensão da plataforma Sonarqube. Ele permitirá que você produza um código limpo estável e facilmente suportado, ajudando você a encontrar e corrigir bugs, vulnerabilidades e cheiros de código.

Características

• Mais de 200 regras
• Suporta até Php 8.3
• Métricas (complexidade, número de linhas, etc.)
• Importação de resultados de teste e cobertura de unidade
• Suporte de regras personalizadas

Links úteis

• Página inicial do projeto
• Documentação
• Rastreamento de problemas
• Regras disponíveis
• Fórum da Comunidade Sonarsource
• Análise de Projeto Demo

Mais documentação

• Documentação do gráfico de fluxo de controle

Tem perguntas ou feedback?

Para fornecer feedback (solicite um recurso, relate um bug, etc.), use o fórum da comunidade SONARSource. Não se esqueça de especificar o idioma (PHP!), Versão do plug -in e versão Sonarqube.

Se você tiver uma pergunta sobre como usar o plug -in (e os documentos não o ajudarem), também o incentivamos a usar o fórum da comunidade.

Contribuindo

Tópico no fórum da comunidade Sonarsource

Para solicitar um novo recurso, crie um novo tópico no fórum da comunidade Sonarsource. Mesmo se você planeja implementá -lo e enviá -lo de volta à comunidade, inicie um novo tópico primeiro para ter certeza de que podemos acompanhá -lo.

Solicitação de tração (PR)

Para enviar uma contribuição, crie uma solicitação de tração para este repositório. Certifique -se de seguir nosso estilo de código e que todos os testes estão passando.

Regras personalizadas

Se você tem uma ideia para uma regra, mas não tem certeza de que todos precisam, pode implementar uma regra personalizada disponível apenas para você.

Alterações de API de regras personalizadas

• 3.32 (outubro de 2023)
  • NEWSPONDENTE newIssue adicionado adicionado à interface da API CheckContext
• 3.15 (janeiro de 2021)
  • PHPCustomRulesDefinition foi removido, foi obsoleto desde a versão 2.13 (março de 2018)
  • Dependência removida da ponte sslr-squid que não é mais mantida
• 3.11 , Apoio ao Php 8:
  • ParameterTree#type() está depreciado. Use ParameterTree#declaredType() em vez disso.
  • ReturnTypeClauseTree#type() está depreciado. Use ReturnTypeClauseTree#declaredType() .
  • ClassPropertyDeclarationTree#typeAnnotation() está depreciado. Use ClassPropertyDeclarationTree#declaredType() .
  • CatchBlockTree#variable() agora pode retornar NULL .
  • FunctionCallTree#arguments() está depreciado. Use FunctionCallTree#callArguments() em vez disso.
  • AnonymousClassTree#arguments() está depreciado. Use AnonymousClassTree#callArguments() .
  • Nova árvore: CallArgumentTree . Esta árvore envolve expressões passadas como argumentos agora.
  • Novo tipo de expressão: ThrowExpressionTree .
  • Novo tipo de expressão: MatchExpressionTree .
  • ParameterTree agora tem um método visibility .

Teste

Para executar testes, siga localmente estas instruções.

Construir o projeto e executar testes de unidade

Para construir o plug -in e executar seus testes de unidade, execute este comando do diretório raiz do projeto:

./gradlew build

Testes de integração

Para executar testes de integração, você precisará criar um arquivo de propriedades como o mostrado abaixo e definir sua localização em uma variável de ambiente nomeada ORCHESTRATOR_CONFIG_URL .

 # version of SonarQube server
sonar.runtimeVersion =9.9

Antes de executar qualquer um dos testes de integração, verifique se os submódulos estão verificados:

  git submodule update --init

Teste de plug -in

O "Plugin Test" é um teste de integração adicional que verifica recursos do plug -in, como cálculo métrico, cobertura etc. para iniciá -lo:

./gradlew its:plugin:integrationTest

Teste dominante

O "teste de decisão" é um teste de integração especial que inicia a análise de uma base de código grande, salva os problemas criados pelo plug -in nos arquivos de relatório e compara esses resultados ao conjunto de problemas esperados (armazenados como arquivos JSON). Para iniciar o teste de domingo:

./gradlew its:ruling:integrationTest

Este teste oferece a oportunidade de examinar os problemas criados por cada regra e verifique se eles são o que você espera. Você pode inspecionar questões novas/perdidas verificando o URL local Sonarqube mencionado nos logs no final da análise. Se tudo parecer bom para você, você pode copiar o arquivo com os problemas reais localizados em

 sonar-php/its/ruling/target/actual/

no diretório com os problemas esperados

 sonar-php/its/ruling/src/test/resources/expected/

Descrições de regras

Atualizar descrições de regra

Para atualizar todas as descrições de regras:

./gradlew ruleApiUpdate

Gerar nova descrição de regra

Para buscar arquivos estáticos para uma regra sxxxx da RSPEC:

./gradlew ruleApiGenerateRule -Prule=SXXXX

O mesmo para uma filial RSPEC específica ( master por padrão):

./gradlew ruleApiGenerateRule -Prule=SXXXX -Pbranch=my-branch

Licença

Copyright 2010-2024 SONARSource.

Os analisadores do Sonarqube divulgados após 29 de novembro de 2024, incluindo correções de patches para versões anteriores, são publicados sob a licença Sonar Source-Alowable versão 1 (SSALV1).

Consulte arquivos individuais para obter detalhes que especificam a licença aplicável a cada arquivo. Os arquivos sujeitos ao SSALV1 serão observados em seus cabeçalhos.