ProHoster > Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

SonarQube është një platformë e hapur për të siguruar kontrollin e vazhdueshëm të cilësisë së kodit burimor, që mbështet një gamë të gjerë gjuhësh programimi dhe lejon raportimin mbi metrika të tilla si dyfishimi i kodit, përputhshmëria me standardet e kodimit, mbulimi me teste, kompleksiteti i kodit, gabimet potenciale, etj. SonarQube vizualizon lehtësisht rezultatet e analizës dhe lejon ndjekjen e dinamikës së zhvillimit të projektit në kohë.

Detyra: Të tregohet zhvilluesve statusi i kontrollit të cilësisë së kodit burimor në SonarQube.

Ekzistojnë dy mënyra për ta zgjidhur:

  • TĂ« ekzekutohet njĂ« skenar pĂ«r kontrollin e statusit tĂ« cilĂ«sisĂ« sĂ« kodit burimor nĂ« SonarQube. NĂ«se kontrolli i cilĂ«sisĂ« sĂ« kodit burimor nĂ« SonarQube dĂ«shton, atĂ«herĂ« ndalohet ndĂ«rtimi.
  • TĂ« tregojĂ« nĂ« faqen kryesore tĂ« projektit statusin e cilĂ«sisĂ« sĂ« kodit burimor.

Instalimi i SonarQube

Për të instaluar SonarQube nga paketat rpm, do të përdorim repositorin https://harbottle.gitlab.io/harbottle-main.

Do të instalojmë paketën me repositorin për CentOS 7.

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

Të instalojmë vetë SonarQube.

yum install -y sonarqube

Gjatë instalimit do të instalohen shumica e plugjineve, por ne duhet të instalojmë përveç kësaj findbugs dhe pmd.

yum install -y sonarqube-findbugs sonarqube-pmd

Të aktivizojmë shërbimin dhe ta shtojmë në ngarkimin automatik

systemctl start sonarqube
systemctl enable sonarqube

Nëse ngarkohet gjatë, shtoni në fund të opsioneve sonar.web.javaOpts gjeneratorin e numrave të rastit /dev/. /urandom.

sonar.web.javaOpts=parametra të tjerë -Djava.security.egd=file:/dev/urandom

Ekzekutimi i skenarit për kontrollin e statusit të cilësisë së kodit burimor në SonarQube.

Fatkeqësisht, plugjini sonar-break-maven-plugin nuk është përditësuar për një kohë të gjatë. Prandaj, do të shkruajmë skenarin tonë.

Për testimin do të përdorim repositorin https://github.com/uweplonus/spotbugs-examples.

Imporojmë në Gitlab. Shtojmë skedarin .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 login
  PASSWORD: "admin" # sonarqube password

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

Skema .gitlab-ci.yml nuk është ideale. U testua nëse detyrat e verifikimit në sonarqube përfundojnë me statusin: "SUCCESS". Deri tani nuk ka pasur statusesh të tjera. Kur të ketë statuset e tjera, do ta rregulloj .gitlab-ci.yml në këtë post.

Shfaqja në faqen kryesore të projektit të statusit të kontrollit të cilësisë së kodit burimor

Instalojmë plugin për SonarQube

yum install -y sonarqube-qualinsight-badges

Hyni në SonarQube në adresën http://172.26.9.115:9000/
Krijojmë një përdorues të zakonshëm, për shembull "badges".
Hyni me këtë përdorues në SonarQube.

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Hyni në "My account", krijoni një token të ri, për shembull me emrin "read_all_repository" dhe klikoni "Genereate".

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Shihni që tokeni u shfaq. Ai do të shfaqet vetëm 1 herë.

Hyni si administrator.

Shkoni në Configuration -> SVG Badges

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Kopjojmë këtë token në fushën "Activity badge token" dhe klikojmë butonin e ruaj.

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Hyni në Administration -> Security -> Permission Templates -> Default template (dhe të tjerat që keni).

Përdoruesit badges i nevojitet të vendoset shenja "Browse".

Testimi.

Për shembull, le të marrim projektin https://github.com/jitpack/maven-simple.

Importojmë këtë projekt.

Shtojmë skedarin .gitlab-ci.yml në rrënjën e projektit me përmbajtjen e mëposhtme.

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" # login sonarqube
  PASSWORD: "admin" # fjalëkalimi 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

Në SonarQube projekti do të duket kështu:

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Shtojmë bages në README.md dhe ato do të duken kështu:

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Kodi i shfaqjes së badges duket kështu:

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Analiza e vargut të shfaqjes së 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.jitpackmaven-simple)
[![Emri](http://172.26.9.115:9000/api/badges/gate?key=Project Key)](http://172.26.9.115:9000/dashboard?id=id-projekti)
[![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.jitpackmaven-simple)
[![Emri i Metrikës](http://172.26.9.115:9000/api/badges/measure?key=Project Key&metric=METRIKA)](http://172.26.9.115:9000/dashboard?id=id-projekti)

Ku të gjejmë/kontrollojmë Projektin Key dhe id-projektit.

Projektin Key është poshtë në të djathtë. Në URL është id-projektit.

Shfaqja për zhvilluesit e statusit të kontrollit të cilësisë së kodit burimor në SonarQube

Opsionet për marrjen e metrikeve mund të shihen këtu.

Të gjitha kërkesat pull për përmirësime, rregullime gabimesh dërgoni në këtë depo.

Grupi në Telegram për SonarQube https://t.me/sonarqube_ru
Grupi nĂ« Telegram pĂ«r DevSecOps — DevOps tĂ« sigurt https://t.me/sec_devops

Burimi: habr.com

Bleni hostim tĂ« besueshĂ«m pĂ«r faqe me mbrojtje nga DDoS, serverĂ« VPS VDS đŸ”„ Bleni hostim tĂ« besueshĂ«m pĂ«r faqe me mbrojtje nga DDoS, serverĂ« VPS VDS | ProHoster