🥇Prikaz stanja nadzora kakovosti izvorne kode v SonarQube razvijalcem

SonarQube je platforma za zagotavljanje kakovosti odprtokodne kode, ki podpira široko paleto programskih jezikov in zagotavlja poročanje o meritvah, kot so podvajanje kode, skladnost s standardi kodiranja, pokritost s testi, kompleksnost kode, morebitne hrošče in drugo. SonarQube priročno vizualizira rezultate analize in vam omogoča sledenje dinamiki razvoja projekta skozi čas.

Cilj: pokazati razvijalcem stanje nadzora kakovosti izvorne kode v SonarQube.

Rešitvi sta dve:

Zaženite skript za preverjanje stanja nadzora kakovosti izvorne kode v SonarQube. Če nadzor kakovosti izvorne kode v SonarQube ne prestane, potem sestavljanje ne uspe.
Pokaži status nadzora kakovosti izvorne kode na glavni strani projekta.

Namestitev SonarQube

Za namestitev sonarqube iz paketov rpm bomo uporabili repozitorij https://harbottle.gitlab.io/harbottle-main.

Namestimo paket z repozitorijem za CentOS 7.

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

Namestimo sam sonarqube.

yum install -y sonarqube

Med namestitvijo bo večina vtičnikov nameščenih, vendar morate namestiti findbugs in pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Zaženite storitev in jo dodajte v zagon

systemctl start sonarqube
systemctl enable sonarqube

Če nalaganje traja dolgo, dodajte generator naključnih števil /dev/./urandom na konec možnosti sonar.web.javaOpts

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

Zagon skripta za preverjanje stanja nadzora kakovosti izvorne kode v SonarQube.

Na žalost vtičnik sonar-break-maven-plugin že dolgo ni bil posodobljen. Torej napišimo svoj scenarij.

Za testiranje bomo uporabili repozitorij https://github.com/uweplonus/spotbugs-examples.

Uvažanje v Gitlab. Dodajte datoteko .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

Datoteka .gitlab-ci.yml ni popolna. Preizkušeno, če so se opravila skeniranja v sonarqube končala s statusom: "USPEH". Do sedaj ni bilo drugih statusov. Takoj ko bodo drugi statusi, bom v tej objavi popravil .gitlab-ci.yml.

Prikaz statusa nadzora kakovosti izvorne kode na glavni strani projekta

Namestitev vtičnika za SonarQube

yum install -y sonarqube-qualinsight-badges

Gremo v SonarQube na http://172.26.9.115:9000/
Ustvarite običajnega uporabnika, na primer "značke".
Prijavite se v SonarQube pod tem uporabnikom.

Pojdite na »Moj račun«, ustvarite nov žeton, na primer z imenom »read_all_repository« in kliknite »Genereate«.

Vidimo, da se je pojavil žeton. Pojavil se bo samo 1-krat.

Prijavite se kot skrbnik.

Pojdite na Konfiguracija -> Značke SVG

Kopirajte ta žeton v polje "Žeton značke dejavnosti" in kliknite gumb za shranjevanje.

Pojdite na Administracija -> Varnost -> Predloge dovoljenj -> Privzeta predloga (in druge predloge, ki jih boste imeli).

Uporabnik značk mora imeti označeno polje »Prebrskaj«.

Testiranje

Za primer vzemimo projekt https://github.com/jitpack/maven-simple.

Uvozimo ta projekt.

Dodajte datoteko .gitlab-ci.yml v koren projekta z naslednjo vsebino.

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 bo projekt videti takole:

Dodajte vrečke v README.md in izgledale bodo takole:

Prikazna koda značk je videti takole:

Razčlenjevanje niza prikaza značk:

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

Kje dobiti/preveriti ključ projekta in ID projekta.

Ključ projekta je spodaj desno. URL vsebuje ID projekta.