🥇Zobrazení stavu kontroly kvality zdrojového kódu v SonarQube vývojářům

SonarQube je otevřená platforma pro zajištění kvality zdrojového kódu, která podporuje širokou škálu programovacích jazyků a poskytuje zprávy o metrikách, jako je duplikace kódu, dodržování standardů kódování, pokrytí testů, složitost kódu, potenciální chyby a další. SonarQube pohodlně vizualizuje výsledky analýzy a umožňuje vám sledovat dynamiku vývoje projektu v průběhu času.

Cíl: Ukázat vývojářům stav kontroly kvality zdrojového kódu v SonarQube.

Existují dvě řešení:

Spusťte skript pro kontrolu stavu kontroly kvality zdrojového kódu v SonarQube. Pokud kontrola kvality zdrojového kódu v SonarQube neprojde, sestavení se nezdaří.
Zobrazit stav kontroly kvality zdrojového kódu na hlavní stránce projektu.

Instalace SonarQube

K instalaci sonarqube z balíčků rpm použijeme úložiště https://harbottle.gitlab.io/harbottle-main.

Pojďme nainstalovat balíček s úložištěm pro CentOS 7.

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

Nainstalujeme samotný sonarqube.

yum install -y sonarqube

Během instalace se nainstaluje většina pluginů, ale musíte nainstalovat findbugs a pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Spusťte službu a přidejte ji do spuštění

systemctl start sonarqube
systemctl enable sonarqube

Pokud načítání trvá dlouho, přidejte generátor náhodných čísel /dev/./urandom na konec možností sonar.web.javaOpts

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

Spuštění skriptu pro kontrolu stavu kontroly kvality zdrojového kódu v SonarQube.

Plugin sonar-break-maven-plugin bohužel nebyl již delší dobu aktualizován. Pojďme si tedy napsat vlastní scénář.

Pro testování použijeme úložiště https://github.com/uweplonus/spotbugs-examples.

Import do Gitlabu. Přidejte soubor .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

Soubor .gitlab-ci.yml není dokonalý. Testováno, zda úlohy skenování v sonarqube skončily se stavem: "ÚSPECH". Dosud nebyly žádné jiné statusy. Jakmile budou další statusy, opravím .gitlab-ci.yml v tomto příspěvku.

Zobrazení stavu kontroly kvality zdrojového kódu na hlavní stránce projektu

Instalace pluginu pro SonarQube

yum install -y sonarqube-qualinsight-badges

Jdeme na SonarQube na http://172.26.9.115:9000/
Vytvořte si běžného uživatele, například „odznaky“.
Přihlaste se do SonarQube pod tímto uživatelem.

Přejděte na „Můj účet“, vytvořte nový token, například s názvem „read_all_repository“ a klikněte na „Genereate“.

Vidíme, že se objevil token. Objeví se pouze 1x.

Přihlaste se jako správce.

Přejděte na Konfigurace -> Odznaky SVG

Zkopírujte tento token do pole „Token odznaku aktivity“ a klikněte na tlačítko Uložit.

Přejděte do Administrace -> Zabezpečení -> Šablony oprávnění -> Výchozí šablona (a další šablony, které budete mít).

Uživatel odznaků musí mít zaškrtnuté políčko „Procházet“.

Testování.

Vezměme si například projekt https://github.com/jitpack/maven-simple.

Pojďme tento projekt importovat.

Přidejte soubor .gitlab-ci.yml do kořenového adresáře projektu s následujícím obsahem.

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

V SonarQube bude projekt vypadat takto:

Přidejte tašky do README.md a budou vypadat takto:

Kód zobrazení odznaků vypadá takto:

Analýza zobrazovaného řetězce odznaků:

[![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-проекта)

Kde získat/zkontrolovat Project Key a ID projektu.

Project Key je vpravo dole. Adresa URL obsahuje ID projektu.