Instalando o SonarQube

Em Abril desse ano o time da Microsoft anunciou a integração do SonarQube com o MSBuild, neste post veremos o que é o SonarQube e como realizar a instalação e configuração

O que é SonarQube?

O SonarQube é uma plataforma de código aberto dedicado para analisar continuamente seu código e mensurar a qualidade técnica do código fonte, desde o projeto até o nível do método. O SonarQube abrange as 7 pilares abaixo fornecendo vários indicadores de qualidade do nosso projeto incluindo o Technical Debt.

7axes

O que é Technical Debt?

Technical Debt (Dívida Técnica) é uma metáfora recente referindo-se às eventuais consequências de qualquer projeto de sistema, arquitetura de software ou de desenvolvimento de software dentro de uma base de código. A dívida pode ser pensado como o trabalho que precisa ser feito antes que um determinado trabalho pode ser considerada completa ou adequada. Se a dívida não for paga, então ele vai continuar a acumular juros, tornando-se difícil de implementar mudanças mais tarde.

TechDebt

Em outras palavras, sabe aquele código que ainda não foi totalmente finalizado, faltando o code review, faltando passar pela suíte de testes porém muitas vezes pelo prazo de entrega curto ou por alguma razão de negócio ele precisa ir para produção. Resumindo Technical Debt é todo aquele código que foi escrito de forma rápida ou mal escrito que no futuro pode trazer um problema em seu software, esse dívida deve ser liquidado o mais rápido possível ou a dívida irá crescer a cada novo deployment.

Instalando o SonarQube

Para instalar o SonarQube é necessário atender os seguintes pré-requisitos

  • Java (Oracle JRE 7 or greater or OpenJDK 7 or greater)
  • Database (SQL Server, MySQL, Oracle ou PostegreSQL)

Para mais detalhes, veja essa documentação

Passo 1) Baixar o SonarQube nesse link SonarQube 5.1.2 

Passo 2) Descompactar em qualquer diretório, nesse caso C:\sonarqube-5.1.2

Passo 3) Editar as configurações de conexão com a base de dados no arquivo C:\sonarqube-5.1.2\conf\sonar.properties

Sonar_Image01

Passo 4) Iniciar o servidor do SonarQube, execute o script C:\sonarqube-5.1.2\bin\windows-x86-64\StartSonar.bat

Sonar_Image02

Passo 5) Para acessar o portal digite a seguinte URL http://localhost:9000 (usuário= admin Senha=admin)

Sonar_Image03

Instalando o Plugin para C#

A instalação padrão do Sonar, não vem com o plugin C# instalado, para instalar o plugin deveremos seguir os seguintes passos

Passo 1) Acessar o portal do Sonar e entrar na área administrativa (o usuário padrão é admin e a senha padrão é admin)

Passo 2) Clicar no menu Settings -> System -> Update Center

Sonar_Image05

Passo 3) Clicar na aba Available Plugins

Sonar_Image06

Passo 4) Localizar o plugin C#, e clicar em Install

Sonar_Image07

Passo 5) Após a instalação do Plugin será necessário reiniciar o serviço do SonarQube

Sonar_Image08

Instalando o MSBuild SonarQube Runner

O próximo passo é instalar o MSBuild SonarQube Runner no servidor onde será executado a análise do código, nesse caso será configurado no TFS Build, esse componente é responsável por integrar o SonarQube com o MSBuild.

Passo 1) Baixar o MSBuild SonarQube Runner nesse link

Passo 2) Configurar o arquivo C:\MSBuild.SonarQube.Runner-1.0.1\SonarQube.Analysis.xml conforme abaixo

Sonar_Image04

ATENÇÃO: Para que o SonarQube  Runner funcione adequadamente, é necessário realizar a instalação do Java na mesma máquina.

Toda a configuração do SonarQube está pronta, no próximo post veremos como executar a análise do nosso código

Aquele abraço!

 

Sobre Leandro Prado

Leandro Silveira Prado é Premier Field Engineer na Microsoft especializado em Application Lifecycle Management.