🥇A forráskód minőség-ellenőrzési állapotának megjelenítése a SonarQube-ban a fejlesztők számára

A SonarQube egy nyílt forráskódú minőségbiztosítási platform, amely a programozási nyelvek széles skáláját támogatja, és jelentéseket készít olyan mérőszámokról, mint a kódduplikáció, a kódolási szabványoknak való megfelelés, a tesztek lefedettsége, a kód összetettsége, a lehetséges hibák stb. A SonarQube kényelmesen megjeleníti az elemzési eredményeket, és lehetővé teszi a projektfejlesztés dinamikájának nyomon követését az idő múlásával.

Cél: Mutassa meg a fejlesztőknek a SonarQube forráskód-minőség-ellenőrzésének állapotát.

Két megoldás létezik:

Futtasson egy parancsfájlt a forráskód minőségellenőrzési állapotának ellenőrzéséhez a SonarQube-ban. Ha a SonarQube forráskódjának minőségellenőrzése nem felel meg, akkor az összeállítás sikertelen.
A forráskód minőségellenőrzési állapotának megjelenítése a projekt főoldalán.

A SonarQube telepítése

A sonarqube rpm csomagokból történő telepítéséhez a tárolót használjuk https://harbottle.gitlab.io/harbottle-main.

Telepítsük a csomagot a CentOS 7 tárházával.

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

Magát a sonarqube-t telepítjük.

yum install -y sonarqube

A telepítés során a legtöbb plugin települ, de telepítenie kell a findbugs-ot és a pmd-t

yum install -y sonarqube-findbugs sonarqube-pmd

Indítsa el a szolgáltatást, és adja hozzá az indításhoz

systemctl start sonarqube
systemctl enable sonarqube

Ha sokáig tart a betöltés, akkor adjon hozzá egy véletlenszám-generátort /dev/./urandom a sonar.web.javaOpts opciók végére

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

Szkript futtatása a SonarQube forráskód-minőség-ellenőrzésének állapotának ellenőrzésére.

Sajnos a sonar-break-maven-plugin beépülő modult sokáig nem frissítették. Tehát írjuk meg a saját forgatókönyvünket.

A teszteléshez a repository-t fogjuk használni https://github.com/uweplonus/spotbugs-examples.

Importálás a Gitlabba. Adja hozzá a .gitlab-ci.yml fájlt:

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

A .gitlab-ci.yml fájl nem tökéletes. Tesztelve, hogy a sonarqube szkennelési feladatai a következő állapottal végződtek-e: "SIKER". Eddig nem volt más státusz. Amint lesznek más állapotok, javítani fogom a .gitlab-ci.yml fájlt ebben a bejegyzésben.

A forráskód minőségellenőrzési állapotának megjelenítése a projekt főoldalán

A SonarQube bővítmény telepítése

yum install -y sonarqube-qualinsight-badges

A SonarQube-ba megyünk a http://172.26.9.115:9000/
Hozzon létre egy normál felhasználót, például "jelvényeket".
Jelentkezzen be a SonarQube-ba ezzel a felhasználóval.

Lépjen a „Fiókom” oldalra, hozzon létre egy új tokent, például „read_all_repository” néven, majd kattintson a „Létrehozás” gombra.

Látjuk, hogy megjelent egy token. Csak 1 alkalommal jelenik meg.

Jelentkezzen be rendszergazdaként.

Lépjen a Konfiguráció -> SVG jelvények menüpontra

Másolja ezt a tokent a „Tevékenységi jelvény token” mezőbe, és kattintson a mentés gombra.

Lépjen az Adminisztráció -> Biztonság -> Engedélysablonok -> Alapértelmezett sablon (és egyéb sablonok, amelyekkel rendelkezhet).

A jelvények felhasználójának be kell jelölnie a „Tallózás” jelölőnégyzetet.

Tesztelés.

Vegyük például a projektet https://github.com/jitpack/maven-simple.

Importáljuk ezt a projektet.

Adja hozzá a .gitlab-ci.yml fájlt a projekt gyökérkönyvtárához a következő tartalommal.

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

A SonarQube-ban a projekt így fog kinézni:

Adja hozzá a táskákat a README.md-hez, és így fognak kinézni:

A jelvények megjelenítési kódja így néz ki:

A jelvények megjelenítési karakterláncának elemzése:

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

Hol lehet beszerezni/ellenőrizni a projektkulcsot és a projektazonosítót.

A Project Key a jobb alsó sarokban található. Az URL tartalmazza a projektazonosítót.

A mutatók megszerzésének lehetőségei lehetnek nézz ide.

Minden fejlesztési kérés, hibajavítás küldje el ebbe az adattárba.

Telegram-csevegés a SonarQube-ról https://t.me/sonarqube_ru
Telegram-csevegés a DevSecOps-ról – biztonságos DevOps https://t.me/sec_devops

Forrás: will.com

A forráskód minőségellenőrzési állapotának megjelenítése a SonarQube-ban a fejlesztők számára

A SonarQube telepítése

Szkript futtatása a SonarQube forráskód-minőség-ellenőrzésének állapotának ellenőrzésére.

A forráskód minőségellenőrzési állapotának megjelenítése a projekt főoldalán

Hozzászólás Megszünteti a választ