🥇Wiri l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors f'SonarQube lill-iżviluppaturi

SonarQube hija pjattaforma ta’ assigurazzjoni tal-kwalità tal-kodiċi ta’ sors miftuħ li tappoġġja firxa wiesgħa ta’ lingwi ta’ programmar u tipprovdi rappurtar dwar metriċi bħad-duplikazzjoni tal-kodiċi, konformità mal-istandards tal-kodifikazzjoni, kopertura tat-test, kumplessità tal-kodiċi, bugs potenzjali, u aktar. SonarQube b'mod konvenjenti viżwalizza r-riżultati tal-analiżi u jippermettilek issegwi d-dinamika tal-iżvilupp tal-proġett maż-żmien.

Għan: Uri lill-iżviluppaturi l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors f'SonarQube.

Hemm żewġ soluzzjonijiet:

Mexxi script biex tivverifika l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors f'SonarQube. Jekk il-kontroll tal-kwalità tal-kodiċi tas-sors f'SonarQube ma jgħaddix, imbagħad ifalli l-assemblaġġ.
Uri l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors fuq il-paġna ewlenija tal-proġett.

Installazzjoni ta' SonarQube

Biex tinstalla sonarqube minn pakketti rpm, se nużaw ir-repożitorju https://harbottle.gitlab.io/harbottle-main.

Ejja ninstallaw il-pakkett mar-repożitorju għal CentOS 7.

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

Aħna ninstallaw sonarqube innifsu.

yum install -y sonarqube

Waqt l-installazzjoni, il-biċċa l-kbira tal-plugins se jiġu installati, iżda trid tinstalla findbugs u pmd

yum install -y sonarqube-findbugs sonarqube-pmd

Niedi s-servizz u żidu mal-istartjar

systemctl start sonarqube
systemctl enable sonarqube

Jekk tieħu żmien twil biex titgħabba, imbagħad żid ġeneratur ta' numru każwali /dev/./urandom fl-aħħar tal-għażliet sonar.web.javaOpts

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

Tmexxi b'kitba biex tiċċekkja l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors f'SonarQube.

Sfortunatament, il-plugin sonar-break-maven-plugin ma ġiex aġġornat għal żmien twil. Mela ejja niktbu l-iskrittura tagħna stess.

Għall-ittestjar se nużaw ir-repożitorju https://github.com/uweplonus/spotbugs-examples.

Importazzjoni f'Gitlab. Żid il-fajl .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

Il-fajl .gitlab-ci.yml mhuwiex perfett. Ittestjat jekk il-kompiti tal-iskannjar fis-sonarqube spiċċaw bl-istatus: "SUĊĊESS". S'issa ma kien hemm l-ebda status ieħor. Hekk kif ikun hemm statuses oħra, se nikkoreġi .gitlab-ci.yml f'din il-kariga.

Li juri l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors fuq il-paġna ewlenija tal-proġett

Installazzjoni tal-plugin għal SonarQube

yum install -y sonarqube-qualinsight-badges

Immorru SonarQube fi http://172.26.9.115:9000/
Oħloq utent regolari, pereżempju "badges".
Idħol f'SonarQube taħt dan l-utent.

Mur fuq "Il-kont tiegħi", oħloq token ġdid, pereżempju bl-isem "read_all_repository" u kklikkja "Generate".

Naraw li deher token. Huwa se jidher darba biss.

Idħol bħala amministratur.

Mur fil-Konfigurazzjoni -> Badges SVG

Ikkopja dan it-token fil-qasam "Activity badge token" u kklikkja l-buttuna ħlief.

Mur Amministrazzjoni -> Sigurtà -> Mudelli ta 'Permess -> Mudell default (u mudelli oħra li ser ikollok).

L-utent tal-badges irid ikollu l-kaxxa ta' kontroll "Ibbrawżja" iċċekkjata.

Ittestjar.

Per eżempju, ejja nieħdu l-proġett https://github.com/jitpack/maven-simple.

Ejja nimportaw dan il-proġett.

Żid il-fajl .gitlab-ci.yml mal-għerq tal-proġett bil-kontenut li ġej.

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

F'SonarQube il-proġett se jidher bħal dan:

Żid basktijiet ma’ README.md u se jidhru bħal dawn:

Il-kodiċi tal-wiri tal-badges jidher bħal dan:

L-analiżi tas-sekwenza tal-wiri tal-badges:

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

Fejn tikseb/iċċekkja Project Key u project id.

Iċ-ċavetta tal-proġett tinsab fin-naħa t'isfel tal-lemin. Il-URL fih l-id tal-proġett.

Għażliet għall-kisba tal-metriċi jistgħu jkunu ħarsa hawn.

It-talbiet kollha tal-ġibda għal titjib, bug fixes tissottometti lil dan ir-repożitorju.

Telegram chat dwar SonarQube https://t.me/sonarqube_ru
Telegram chat dwar DevSecOps - DevOps sigur https://t.me/sec_devops

Sors: www.habr.com

Wiri l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors f'SonarQube lill-iżviluppaturi

Installazzjoni ta' SonarQube

Tmexxi b'kitba biex tiċċekkja l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors f'SonarQube.

Li juri l-istatus tal-kontroll tal-kwalità tal-kodiċi tas-sors fuq il-paġna ewlenija tal-proġett

Żid kumment Ikkanċella risposta