Esse tutorial irá explicar de forma simples e clara como fazer a instalação do SonarQube, tanto local quanto remota através do Azure DevOps, além de abordar questões sobre a cobertura de código e análises em geral.

Esse tutorial irá explicar de forma simples e clara como fazer a instalação do SonarQube, tanto local quanto remota através do <a href="https://dtidigital.com.br/blog/azure-function-parte-1-scripts-com-c/">Azure</a> DevOps, além de abordar questões sobre a cobertura de código e análises em geral.
<div id="toc_container" class="toc_white no_bullets">Sum&aacute;rio<ul class="toc_list"><li><a href="#Vamos-la">1 Vamos lá!</a><ul><li><a href="#Para-comecar-vamos-fazer-a-instalacao-e-configuracao-local-para-isso-voce-deve-seguir-os-passos">1.1 Para começar vamos fazer a instalação e configuração local, para isso você deve seguir os passos:</a></li><li><a href="#Instale-o-OpenCover-versao-46519-via-comando-ou-pelo-nuget-no-projeto-de-teste-unitarioexecutando-o-seguinte-comando">1.2 Instale o OpenCover (versão 4.6.519) via comando, ou pelo nuget no projeto de teste unitário, executando o seguinte comando:</a></li><li><a href="#Agora-crie-um-arquivo-bat-usando-um-editor-de-texto-qualquer-adequando-os-comandos-a-seguirpara-os-do-seu-projeto">1.3 Agora crie um arquivo .bat usando um editor de texto qualquer adequando os comandos a seguir para os do seu projeto.</a></li></ul></li><li><a href="#Extra">2 Extra</a></li><li><a href="#Configuracao-Sonarqube-remoto-usando-o-Azure-DevOps">3 Configuração Sonarqube remoto usando o Azure DevOps</a><ul><li><a href="#Execute-a-build-e-pronto">3.1 Execute a build e pronto!</a></li></ul></li></ul></div>
<h2>Vamos lá!</h2>
<h3>Para começar vamos fazer a instalação e configuração local, para isso você deve seguir os passos:</h3>
<ul>
<li> Baixar o servidor do SonarQube através do link https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-7.6.zip</li>
</ul>
<ul>
<li> Extrair o sonarqube-7.6.zip no disco local C:\</li>
<li> Executar o StartSonar.bat através do caminho C:\sonarqube-7.6\bin\windows-x86-64\StartSonar.bat (tem que ter o Java JRE instalado)</li>
</ul>
<ul>
<li> Adicionar a pasta sonar nas variáveis de ambiente</li>
</ul>
<h3>Instale o OpenCover (versão 4.6.519) via comando, ou pelo nuget no projeto de teste unitário, executando o seguinte comando:</h3>
<ul>
<li> dotnet add</li>
</ul>
C:\Projeto_Teste\src\Backend\Application\Projeto_Teste.Backend.AppService.TestesUnitarios\Projeto_Teste.Backend.AppService.TestesUnitarios.csproj package OpenCover &#8211;version4.6.519
Edite todos os arquivos .csproj e a solução principal.
<figure id="attachment_4230" aria-describedby="caption-attachment-4230" style="width: 525px" class="wp-caption aligncenter"><img fetchpriority="high" decoding="async" class="wp-image-4230" title="sonarqube" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-1-1-1024x466.png" alt="" width="525" height="239" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-1-1-1024x466.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-1-1-300x137.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-1-1-768x350.png 768w" sizes="(max-width: 525px) 100vw, 525px" /><figcaption id="caption-attachment-4230" class="wp-caption-text">Figura 01: Configuração da solução e dos projetos</figcaption></figure>
Insira o trecho de código &lt;DebugType&gt;Full&lt;/DebugType&gt; entre as tags &lt;PropertyGroup&gt;&lt;/PropertyGroup&gt;
<figure id="attachment_4220" aria-describedby="caption-attachment-4220" style="width: 610px" class="wp-caption aligncenter"><img decoding="async" class="wp-image-4220" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-2-1024x484.png" alt="" width="610" height="288" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-2-1024x484.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-2-300x142.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-2-768x363.png 768w" sizes="(max-width: 610px) 100vw, 610px" /><figcaption id="caption-attachment-4220" class="wp-caption-text">Figura 02: Inserção dos comandos nos projetos</figcaption></figure>
<h3>Agora crie um arquivo .bat usando um editor de texto qualquer adequando os comandos a seguir para os do seu projeto.</h3>
<ul>
<li> Instale o sonarscanner 
<ul>
<li> dotnet tool install &#8211;global dotnet-sonarscanner</li>
</ul>
</li>
</ul>
<ul>
<li> Inicialize o sonarscanner 
<ul>
<li> dotnet sonarscanner begin /k:&#8221;Projeto_Teste&#8221;/d:sonar.cs.opencover.reportsPaths=&#8221;%CD%\opencover.xml&#8221;</li>
</ul>
</li>
</ul>
<ul>
<li> Buildar o projeto 
<ul>
<li>dotnet build C:\Projeto_Teste\ Projeto_Teste.sln</li>
</ul>
</li>
</ul>
<figure id="attachment_4221" aria-describedby="caption-attachment-4221" style="width: 612px" class="wp-caption aligncenter"><img decoding="async" class="wp-image-4221" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-3-1024x139.png" alt="" width="612" height="83" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-3-1024x139.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-3-300x41.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-3-768x104.png 768w" sizes="(max-width: 612px) 100vw, 612px" /><figcaption id="caption-attachment-4221" class="wp-caption-text">Figura 03: Criando o script</figcaption></figure>
&nbsp;
Salve com o nome “sonar-execute&#8221; e com a extensão .bat
<figure id="attachment_4222" aria-describedby="caption-attachment-4222" style="width: 531px" class="wp-caption aligncenter"><img loading="lazy" decoding="async" class="wp-image-4222" title="sonarqube" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-4-1024x712.png" alt="" width="531" height="369" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-4-1024x712.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-4-300x209.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-4-768x534.png 768w" sizes="(max-width: 531px) 100vw, 531px" /><figcaption id="caption-attachment-4222" class="wp-caption-text">Figura 04: Salvando o script no formato .bat</figcaption></figure>
Execute o sonar-execute.bat dentro do projeto onde foi salvo. 
Para subir a análise do seu projeto de teste, basta criar um arquivo .bat como no passo anterior e salvar com o nome “sonar-only-opencover&#8221;. Assim será feito um scanner do projeto de teste para geração do relatório de cobertura (coverage).
<ul>
<li> %USERPROFILE%\.nuget\packages\opencover\4.6.519\tools\OpenCover.Console.exe &#8211; output:&#8221;%CD%\opencover.xml&#8221; -register:user -target:&#8221;C:\Program Files\dotnet\dotnet.exe&#8221; &#8211; targetargs:&#8221;test Projeto_Teste.Backend.AppService.TestesUnitarios\AppService.TestesUnitarios.csproj&#8221; -oldstyle</li>
</ul>
<ul>
<li> Use o comando “dotnet sonarscanner end” para finalizar a análise e enviar os dados para o servidor</li>
</ul>
Execute o sonar-only-opencover.bat
<h2>Extra</h2>
 Caso queira que algum projeto seja excluído da análise do SonarQube, insira o trecho de código &lt;SonarQubeExclude&gt;true&lt;/SonarQubeExclude&gt; entre as tags&lt;PropertyGroup&gt;&lt;/PropertyGroup&gt;
Pronto! Agora é só acessar o http://localhost:9000 usando login e senha “admin” e terá as análises e relatórios do seu código.
<h2>Configuração Sonarqube remoto usando o Azure DevOps</h2>
Após configurado o Sonarqube local, basta ajustar a build no Pipelines do Azure DevOps.
Clique em “Edit” para realizar configuração da build que deseja ativar a cobertura de código. Acesse a aba “Prepare analysis on SonarQube” e preencha seu campo obrigatório Project Key, além do nome do projeto (Project Name).
<figure id="attachment_4223" aria-describedby="caption-attachment-4223" style="width: 603px" class="wp-caption aligncenter"><img loading="lazy" decoding="async" class="wp-image-4223" title="sonarqube" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-5-1024x355.png" alt="" width="603" height="209" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-5-1024x355.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-5-300x104.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-5-768x266.png 768w" sizes="(max-width: 603px) 100vw, 603px" /><figcaption id="caption-attachment-4223" class="wp-caption-text">Figura 05: Configuração do “Prepare analysis on SonarQube”</figcaption></figure>
Lembre-se de preencher a guia Advanced. Nela, poderá definir o caminho que se localiza o arquivo opencover.xml (sonar.cs.opencover.reportsPaths), além de ser possível também excluir alguns arquivos específicos da solução da cobertura de código na análise (sonar.coverage.exclusions).
<figure id="attachment_4224" aria-describedby="caption-attachment-4224" style="width: 681px" class="wp-caption aligncenter"><img loading="lazy" decoding="async" class="wp-image-4224" title="sonarqube" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-6-1024x258.png" alt="" width="681" height="172" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-6-1024x258.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-6-300x76.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-6-768x194.png 768w" sizes="(max-width: 681px) 100vw, 681px" /><figcaption id="caption-attachment-4224" class="wp-caption-text">Figura 06: Guia Advanced do “Prepare analysis on SonarQube”</figcaption></figure>
Posteriormente, preencha a guia Run sonar-only-opencover.bat. Nesta etapa, deve-se apontar o caminho do .bat criado na configuração local. Para isso, preencha a aba “Path”.
<figure id="attachment_4225" aria-describedby="caption-attachment-4225" style="width: 688px" class="wp-caption aligncenter"><img loading="lazy" decoding="async" class="wp-image-4225" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-7-1024x169.png" alt="" width="688" height="113" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-7-1024x169.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-7-300x50.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-7-768x127.png 768w" sizes="(max-width: 688px) 100vw, 688px" /><figcaption id="caption-attachment-4225" class="wp-caption-text">Figura 07: Definição do caminho do .bat criado.</figcaption></figure>
&nbsp;
Lembre-se de preencher a guia Advanced com a pasta que se encontra o arquivo .bat na aba Working folder.
<figure id="attachment_4226" aria-describedby="caption-attachment-4226" style="width: 561px" class="wp-caption aligncenter"><img loading="lazy" decoding="async" class="wp-image-4226" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-8-1024x190.png" alt="" width="561" height="104" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-8-1024x190.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-8-300x56.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-8-768x143.png 768w" sizes="(max-width: 561px) 100vw, 561px" /><figcaption id="caption-attachment-4226" class="wp-caption-text">Figura 08: Preenchimento da pasta que se encontra o .bat criado.</figcaption></figure>
Após realizadas as configurações acima, rode a build remota através da opção Queue.
<figure id="attachment_4227" aria-describedby="caption-attachment-4227" style="width: 444px" class="wp-caption aligncenter"><img loading="lazy" decoding="async" class="wp-image-4227" title="sonarqube" src="https://dtidigital.com.br/wp-content/uploads/2019/03/Figura-9-1024x1024.png" alt="" width="444" height="444" srcset="https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-9-1024x1024.png 1024w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-9-300x300.png 300w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-9-768x768.png 768w, https://www.cms.dtidigital.com.br/wp-content/uploads/2019/03/Figura-9.png 1597w" sizes="(max-width: 444px) 100vw, 444px" /><figcaption id="caption-attachment-4227" class="wp-caption-text">Figura 09: Execução da build</figcaption></figure>
<h3>Execute a build e pronto!</h3>
Caso encontre algum erro que quebre a build, verifique seu “Log”. Caso a build seja bem sucedida, entre no link: http://sonarqube.”seu_servidor”.com.br:9000/. Os dados analisados pelo SonarQube, inclusive a cobertura de código, deverão ser apresentados.
Esperamos ter ajudado vocês leitores.
Até a próxima!

Chegou o momento de impulsionar os resultados da sua empresa! Para entrar em contato com a gente, clique no botão abaixo e preencha o formulário.

SonarQube: Configuração remota e local para projetos .NET

One-stop shop em tecnologia

Confira outros artigos