Zobrazovanie stavu kontroly kvality zdrojového kódu v SonarQube pre vývojárov

SonarQube je platforma na zabezpečenie kvality zdrojového kódu s otvoreným zdrojovým kódom, ktorá podporuje širokú škálu programovacích jazykov a poskytuje správy o metrikách, ako je duplikácia kódu, súlad s normami kódovania, pokrytie testov, zložitosť kódu, potenciálne chyby a ďalšie. SonarQube pohodlne vizualizuje výsledky analýzy a umožňuje vám sledovať dynamiku vývoja projektu v priebehu času.

Cieľ: Ukázať vývojárom stav kontroly kvality zdrojového kódu v SonarQube.

Sú dve riešenia:

• Spustite skript na kontrolu stavu kontroly kvality zdrojového kódu v SonarQube. Ak kontrola kvality zdrojového kódu v SonarQube neprejde, zostavenie zlyhá.
• Zobrazte stav kontroly kvality zdrojového kódu na hlavnej stránke projektu.

Inštalácia SonarQube

Na inštaláciu sonarqube z balíkov rpm použijeme úložisko https://harbottle.gitlab.io/harbottle-main.

Nainštalujte balík s úložiskom pre CentOS 7.

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

Inštalujeme samotný sonarqube.

yum install -y sonarqube

Počas inštalácie sa väčšina pluginov nainštaluje, ale musíte nainštalovať findbugs a pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Spustite službu a pridajte ju do spustenia

systemctl start sonarqube
systemctl enable sonarqube

Ak načítanie trvá dlho, pridajte generátor náhodných čísel /dev/./urandom na koniec možností sonar.web.javaOpts

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

Spustenie skriptu na kontrolu stavu kontroly kvality zdrojového kódu v SonarQube.

Bohužiaľ, plugin sonar-break-maven-plugin nebol dlho aktualizovaný. Poďme si teda napísať vlastný scenár.

Na testovanie použijeme úložisko https://github.com/uweplonus/spotbugs-examples.

Import do Gitlabu. Pridajte súbor .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

Súbor .gitlab-ci.yml nie je dokonalý. Testované, či úlohy skenovania v sonarqube skončili so stavom: "ÚSPECH". Zatiaľ neboli žiadne iné statusy. Hneď ako budú ďalšie statusy, opravím .gitlab-ci.yml v tomto príspevku.

Zobrazenie stavu kontroly kvality zdrojového kódu na hlavnej stránke projektu

Inštalácia doplnku pre SonarQube

yum install -y sonarqube-qualinsight-badges

Ideme na SonarQube o http://172.26.9.115:9000/
Vytvorte si bežného používateľa, napríklad „odznaky“.
Prihláste sa do SonarQube pod týmto používateľom.

Prejdite na „Môj účet“, vytvorte nový token, napríklad s názvom „read_all_repository“ a kliknite na „Genereate“.

Vidíme, že sa objavil token. Objaví sa iba 1 krát.

Prihláste sa ako správca.

Prejdite do časti Konfigurácia -> Odznaky SVG

Skopírujte tento token do poľa „Token odznaku aktivity“ a kliknite na tlačidlo uložiť.

Prejdite do časti Správa -> Zabezpečenie -> Šablóny povolení -> Predvolená šablóna (a ďalšie šablóny, ktoré budete mať).

Používateľ odznakov musí mať začiarknuté políčko „Prehľadávať“.

Testovanie.

Zoberme si napríklad projekt https://github.com/jitpack/maven-simple.

Poďme importovať tento projekt.

Pridajte súbor .gitlab-ci.yml do koreňového adresára projektu s nasledujúcim obsahom.

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 vyzerať takto:

Pridajte tašky do README.md a budú vyzerať takto:

Kód zobrazenia odznakov vyzerá takto:

Analýza zobrazovaného reťazca odznakov:

[![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ískať/skontrolovať kľúč projektu a ID projektu.

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

Možnosti získania metrík môžu byť pozri sa sem.

Všetky žiadosti o vylepšenia, opravy chýb odovzdať do tohto úložiska.

Telegramový rozhovor o SonarQube https://t.me/sonarqube_ru
Telegramový rozhovor o DevSecOps – bezpečné DevOps https://t.me/sec_devops

Zdroj: hab.com