🥇Visualizà u statutu di cuntrollu di qualità di u codice fonte in SonarQube à i sviluppatori

SonarQube hè una piattaforma di garanzia di qualità di codice fonte aperta chì supporta una larga gamma di linguaggi di prugrammazione è furnisce rapporti nantu à metriche cum'è duplicazione di codice, conformità di i standard di codificazione, copertura di teste, cumplessità di codice, bug potenziali, è più. SonarQube visualizeghja convenientemente i risultati di l'analisi è vi permette di seguità a dinamica di u sviluppu di u prugettu in u tempu.

Obiettivu: Mostra à i sviluppatori u statutu di u cuntrollu di qualità di u codice fonte in SonarQube.

Ci sò dui suluzioni:

Eseguite un script per verificà u statutu di cuntrollu di qualità di u codice fonte in SonarQube. Se u cuntrollu di qualità di u codice fonte in SonarQube ùn passa micca, allora falla l'assemblea.
Mostra u statutu di cuntrollu di qualità di u codice fonte nantu à a pagina principale di u prughjettu.

Installazione di SonarQube

Per installà sonarqube da i pacchetti rpm, useremu u repository https://harbottle.gitlab.io/harbottle-main.

Stallà u pacchettu cù u repository per CentOS 7.

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

Installemu u sonarqube stessu.

yum install -y sonarqube

Durante a stallazione, a maiò parte di i plugins seranu stallati, ma avete bisognu di installà findbugs è pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Lanciate u serviziu è aghjunghje à l'iniziu

systemctl start sonarqube
systemctl enable sonarqube

Se ci vole assai tempu per carica, aghjunghje un generatore di numeri aleatorii /dev/./urandom à a fine di l'opzioni sonar.web.javaOpts

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

Eseguisce un script per verificà u statutu di u cuntrollu di qualità di u codice fonte in SonarQube.

Sfortunatamente, u plugin sonar-break-maven-plugin ùn hè micca aghjurnatu per un bellu pezzu. Allora scrivemu u nostru propiu script.

Per pruvà useremu u repository https://github.com/uweplonus/spotbugs-examples.

Importazione in Gitlab. Aghjunghjite u schedariu .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

U schedariu .gitlab-ci.yml ùn hè micca perfettu. Pruvatu se i travaglii di scanning in sonarqube finiscinu cù u statutu: "SUCCESS". Finu a ora ùn ci sò stati altri statuti. Appena ci sò altri stati, correggeraghju .gitlab-ci.yml in questu post.

Visualizà u statutu di cuntrollu di qualità di u codice fonte in a pagina principale di u prughjettu

Installazione di u plugin per SonarQube

yum install -y sonarqube-qualinsight-badges

Andemu à SonarQube à http://172.26.9.115:9000/
Crea un utilizatore regulare, per esempiu "badge".
Accedi à SonarQube sottu stu utilizatore.

Andà à "U mo contu", crea un novu token, per esempiu cù u nome "read_all_repository" è cliccate "Generate".

Avemu vistu chì un token hè apparsu. Apparirà solu 1 volta.

Andà à Configurazione -> Badges SVG

Copia stu token in u campu "Attività badge token" è cliccate u buttone di salvezza.

Andate à Administration -> Security -> Permission Templates -> Default template (è altri mudelli chì avete).

L'utilizatori di badge deve avè a casella di spunta "Browse".

Pruvenza.

Per esempiu, andemu à piglià u prugettu https://github.com/jitpack/maven-simple.

Impurtà stu prughjettu.

Aghjunghjite u schedariu .gitlab-ci.yml à a radica di u prughjettu cù u cuntenutu seguente.

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

In SonarQube u prughjettu sarà cusì cusì:

Aghjunghjite i sacchetti à README.md è seranu cusì:

U codice di visualizazione di i badges hè cusì:

Analizendu a stringa di visualizazione di badge:

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

Induve uttene / verificate Chjave di Prughjettu è ID di prughjettu.

Chjave di u Prughjettu hè in fondu à diritta. L'URL cuntene l'id di u prugettu.

Opzioni per ottene metriche ponu esse fighjate quì.

Tutte e richieste di pull per migliurà, correzioni di bug sottumette à stu repository.

Chat Telegram nantu à SonarQube https://t.me/sonarqube_ru
Chat di Telegram nantu à DevSecOps - DevOps sicuru https://t.me/sec_devops

Source: www.habr.com

Visualizà u statutu di cuntrollu di qualità di u codice fonte in SonarQube à i sviluppatori

Installazione di SonarQube

Eseguisce un script per verificà u statutu di u cuntrollu di qualità di u codice fonte in SonarQube.

Visualizà u statutu di cuntrollu di qualità di u codice fonte in a pagina principale di u prughjettu

Add a comment annuler risponde