🥇Exibindo o status de controle de qualidade do código-fonte no SonarQube para desenvolvedores

SonarQube é uma plataforma de garantia de qualidade de código aberto que oferece suporte a uma ampla variedade de linguagens de programação e fornece relatórios sobre métricas como duplicação de código, conformidade com padrões de codificação, cobertura de teste, complexidade de código, possíveis bugs e muito mais. SonarQube visualiza convenientemente os resultados da análise e permite acompanhar a dinâmica do desenvolvimento do projeto ao longo do tempo.

Objetivo: Mostrar aos desenvolvedores o status do controle de qualidade do código-fonte no SonarQube.

Existem duas soluções:

Execute um script para verificar o status do controle de qualidade do código-fonte no SonarQube. Se o controle de qualidade do código-fonte no SonarQube não for aprovado, a montagem será reprovada.
Mostre o status do controle de qualidade do código-fonte na página principal do projeto.

Instalando o SonarQube

Para instalar o sonarqube a partir de pacotes rpm, usaremos o repositório https://harbottle.gitlab.io/harbottle-main.

Vamos instalar o pacote com o repositório do CentOS 7.

yum install -y https://harbottle.gitlab.io/harbottle-main/7/x86_64/harbottle-main-release.rpm

Instalamos o próprio sonarqube.

yum install -y sonarqube

Durante a instalação, a maioria dos plug-ins será instalada, mas você precisará instalar findbugs e pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Inicie o serviço e adicione-o à inicialização

systemctl start sonarqube
systemctl enable sonarqube

Se demorar muito para carregar, adicione um gerador de números aleatórios /dev/./urandom ao final das opções sonar.web.javaOpts

sonar.web.javaOpts=другие параметры -Djava.security.egd=file:/dev/urandom

Executando um script para verificar o status do controle de qualidade do código-fonte no SonarQube.

Infelizmente, o plugin sonar-break-maven-plugin não é atualizado há muito tempo. Então, vamos escrever nosso próprio roteiro.

Para testes usaremos o repositório https://github.com/uweplonus/spotbugs-examples.

Importando para o Gitlab. Adicione o arquivo .gitlab-ci.yml:

variables:
  MAVEN_OPTS: "-Dhttps.protocols=TLSv1.2 -Dmaven.repo.local=~/.m2/repository -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=WARN -Dorg.slf4j.simpleLogger.showDateTime=true -Djava.awt.headless=true"
  MAVEN_CLI_OPTS: "--batch-mode --errors --fail-at-end --show-version -DinstallAtEnd=true -DdeployAtEnd=true"
  SONAR_HOST_URL: "http://172.26.9.226:9000"
  LOGIN: "admin" # логин sonarqube
  PASSWORD: "admin" # пароль sonarqube

cache:
  paths:
    - .m2/repository

build:
  image: maven:3.3.9-jdk-8
  stage: build
  script:
    - apt install -y jq || true
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.failure.ignore=true org.jacoco:jacoco-maven-plugin:0.8.5:prepare-agent clean verify org.jacoco:jacoco-maven-plugin:0.8.5:report
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.skip=true verify sonar:sonar -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$LOGIN -Dsonar.password=$PASSWORD -Dsonar.gitlab.project_id=$CI_PROJECT_PATH -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
    - export URL=$(cat target/sonar/report-task.txt | grep ceTaskUrl | cut -c11- ) #URL where report gets stored
    - echo $URL
    - |
      while : ;do
          curl -k -u "$LOGIN":"$PASSWORD" "$URL" -o analysis.txt
          export status=$(cat analysis.txt | jq -r '.task.status') #Status as SUCCESS, CANCELED, IN_PROGRESS or FAILED
          echo $status
          if [ ${status} == "SUCCESS" ];then
            echo "SONAR ANALYSIS SUCCESS";
            break
          fi
          sleep 5
      done
    - curl -k -u "$LOGIN":"$PASSWORD" "$URL" -o analysis.txt
    - export status=$(cat analysis.txt | jq -r '.task.status') #Status as SUCCESS, CANCELED or FAILED
    - export analysisId=$(cat analysis.txt | jq -r '.task.analysisId') #Get the analysis Id
    - |
      if [ "$status" == "SUCCESS" ]; then
        echo -e "SONAR ANALYSIS SUCCESSFUL...ANALYSING RESULTS";
        curl -k -u "$LOGIN":"$PASSWORD" "$SONAR_HOST_URL/api/qualitygates/project_status?analysisId=$analysisId" -o result.txt; #Analysis result like critical, major and minor issues
        export result=$(cat result.txt | jq -r '.projectStatus.status');

        if [ "$result" == "ERROR" ];then
          echo -e "91mSONAR RESULTS FAILED";
          echo "$(cat result.txt | jq -r '.projectStatus.conditions')"; #prints the critical, major and minor violations
          exit 1 #breaks the build for violations
        else
          echo -e "SONAR RESULTS SUCCESSFUL";
          echo "$(cat result.txt | jq -r '.projectStatus.conditions')";
          exit 0
        fi
      else
          echo -e "e[91mSONAR ANALYSIS FAILEDe[0m";
          exit 1 #breaks the build for failure in Step2
      fi
  tags:
    - docker

O arquivo .gitlab-ci.yml não é perfeito. Testado se as tarefas de digitalização no sonarqube terminaram com o status: "SUCESSO". Até agora não houve outros status. Assim que houver outros status, corrigirei .gitlab-ci.yml neste post.

Exibindo o status do controle de qualidade do código-fonte na página principal do projeto

Instalando o plugin para SonarQube

yum install -y sonarqube-qualinsight-badges

Vamos ao SonarQube às http://172.26.9.115:9000/
Crie um usuário regular, por exemplo "emblemas".
Faça login no SonarQube com este usuário.

Vá em “Minha conta”, crie um novo token, por exemplo com o nome “read_all_repository” e clique em “Gerar”.

Vemos que um token apareceu. Ele aparecerá apenas 1 vez.

Faça login como administrador.

Vá para Configuração -> Emblemas SVG

Copie este token no campo "Token do crachá de atividade" e clique no botão salvar.

Vá para Administração -> Segurança -> Modelos de permissão -> Modelo padrão (e outros modelos que você terá).

O usuário dos crachás deverá estar com a caixa de seleção “Navegar” marcada.

Testando.

Por exemplo, vamos pegar o projeto https://github.com/jitpack/maven-simple.

Vamos importar este projeto.

Adicione o arquivo .gitlab-ci.yml à raiz do projeto com o seguinte conteúdo.

variables:
  MAVEN_OPTS: "-Dhttps.protocols=TLSv1.2 -Dmaven.repo.local=~/.m2/repository -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=WARN -Dorg.slf4j.simpleLogger.showDateTime=true -Djava.awt.headless=true"
  MAVEN_CLI_OPTS: "--batch-mode --errors --fail-at-end --show-version -DinstallAtEnd=true -DdeployAtEnd=true"
  SONAR_HOST_URL: "http://172.26.9.115:9000"
  LOGIN: "admin" # логин sonarqube
  PASSWORD: "admin" # пароль sonarqube

cache:
  paths:
    - .m2/repository

build:
  image: maven:3.3.9-jdk-8
  stage: build
  script:
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.failure.ignore=true org.jacoco:jacoco-maven-plugin:0.8.5:prepare-agent clean verify org.jacoco:jacoco-maven-plugin:0.8.5:report
    - mvn $MAVEN_CLI_OPTS -Dmaven.test.skip=true verify sonar:sonar -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$LOGIN -Dsonar.password=$PASSWORD -Dsonar.gitlab.project_id=$CI_PROJECT_PATH -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
  tags:
    - docker

No SonarQube o projeto ficará assim:

Adicione sacolas ao README.md e elas ficarão assim:

O código de exibição dos emblemas é assim:

Analisando a string de exibição dos emblemas:

[![Quality Gate](http://172.26.9.115:9000/api/badges/gate?key=com.github.jitpack:maven-simple)](http://172.26.9.115:9000/dashboard?id=com.github.jitpack%3Amaven-simple)
[![Название](http://172.26.9.115:9000/api/badges/gate?key=Project Key)](http://172.26.9.115:9000/dashboard?id=id-проекта)
[![Coverage](http://172.26.9.115:9000/api/badges/measure?key=com.github.jitpack:maven-simple&metric=coverage)](http://172.26.9.115:9000/dashboard?id=com.github.jitpack%3Amaven-simple)
[![Название Метрики](http://172.26.9.115:9000/api/badges/measure?key=Project Key&metric=МЕТРИКА)](http://172.26.9.115:9000/dashboard?id=id-проекта)

Onde obter/verificar a chave do projeto e o ID do projeto.

A chave do projeto está no canto inferior direito. A URL contém o ID do projeto.

As opções para obter métricas podem ser veja aqui.

Todas as solicitações pull de melhorias e correções de bugs enviar para este repositório.

Bate-papo por telegrama sobre SonarQube https://t.me/sonarqube_ru
Bate-papo por telegrama sobre DevSecOps - DevOps seguro https://t.me/sec_devops

Fonte: habr.com

Exibindo o status de controle de qualidade do código-fonte no SonarQube para desenvolvedores

Instalando o SonarQube

Executando um script para verificar o status do controle de qualidade do código-fonte no SonarQube.

Exibindo o status do controle de qualidade do código-fonte na página principal do projeto

Adicionar um comentário cancelar resposta