quarta-feira, 10 de janeiro de 2024

Instalando o SonarQube com o Plugin para o Delphi

 


Em meados de 2022, a Embarcadero liberou um plugin para ser instalado no SonarQube. Com isso os projetos feitos em Delphi ganharam a possibilidade de integrar com essa poderosa ferramenta de análise estática de código-fonte.
Neste artigo trago de forma simples e direta como realizar a instalação do SonarQube juntamente com este plugin do Delphi.

Instalando o SonarQube

O SonarQube possui como pré-requisito o Java 17, para instalarmos podemos utilizar a distribuição JDK Temurin.
A instalação do Java não tem segredo (next, next, next e finish). Após a instalação ser concluída, certifique-se que o Java foi instalado com sucesso no sistema operacional, para isso execute no cmd o seguinte comando "java -version". Deverá listar a versão 17, conforme a imagem abaixo:


Com o Java instalado, agora é a hora de baixar e descompactar o SonarQube.
Acesse o site oficial e na página de downloads, escolha a versão Community Edition.
Descompacte na sua pasta de preferência, porém recomendo ser em: "C:\Utilitarios\sonarqube".

Antes de iniciarmos o SonarQube, devemos baixar e adicionar o plugin para trabalharmos com o Delphi.

SonarDelphi

O SonarQube não vem com a linguagem Delphi por padrão, infelizmente. Dessa forma devemos adicionar um plugin por fora. Para isso basta acessar o repositório oficial da embarcadero e baixar o plugin.

Uma vez baixado basta descompactar o arquivo sonar-delphi-plugin-1.0.8.jar em "C:\Utilitarios\sonarqube\extensions\plugins\".

Iniciando o SonarQube

Nesse momento chegou a hora de iniciarmos o SonarQube pela primeira vez e realizarmos algumas configurações. Para isso basta executar o arquivo StartSonar.bat, localizado em "C:\Utilitarios\sonarqube\bin\windows-x86-64\StartSonar.bat" pelo cmd (recomendo rodar como administrador).
Dependendo das configurações da sua máquina, pode levar cerca de 1 a 3 minutos para levantar o serviço. No final você terá uma imagem conforme abaixo:


Como acessar a ferramenta?

Com o serviço no ar, agora basta digitar no seu navegador o endereço http://localhost:9000/.
No primeiro acesso o usuário padrão será "admin" e a senha "admin" e em seguida será solicitado para realizar a troca.




Após aplicar a nova senha você será notificado sobre a inclusão de um novo plugin. Essa notificação é exibida, pois não instalamos o plugin do Delphi pelo Marketplace do SonarQube.


Nesse momento seu SonarQube já estará em operação (Sucesso!!!).

Agora vamos apenas certificarmos que o nosso plugin foi instalado corretamente. Acesse o menu Rules e no submenu Language pesquise por Delphi, deverá exibir as 43 regras implementadas pelo plugin da Embarcadero.


Instalando o SonarScanner CLI

Para finalizarmos essa etapa de instalações, devemos instalar o SonarScanner CLI. É um utilitário do SonarQube. Como o próprio nome diz, ele realizará um scanner do nosso código-fonte e enviará as métricas para o SonarQube.

Para instalar, basta baixar o SonarScanner e descompactar em "C:\Utilitarios\sonarscanner", depois disso adicionar a pasta "C:\Utilitarios\sonarscanner\bin" no path do windows.


Para termos a certeza que o Scanner foi configurado corretamente, basta digitarmos no cmd "sonar-scanner -h", irá exibir o help de comandos da ferramenta.


Gravei um vídeo no meu canal com o passo a passo completo, caso tenham dúvidas.
Comentem e compartilhe ficarei feliz em ouvir vocês.

No próximo artigo vamos configurar um projeto e verificar na prática como funciona a cobertura do SonarQube.


Links

Java 17
SonarQube
Plugin SonarDelphi
SonarScanner

Nenhum comentário:

Postar um comentário

Postagem em Destaque

Configurando o Projeto Delphi para o SonarQube

  No post anterior expliquei como instalar e configurar o SonarQube com o plugin do Delphi . Neste post vamos configurar nosso projeto Del...

As mais visitadas