ສະແດງສະຖານະການຄວບຄຸມຄຸນະພາບລະຫັດແຫຼ່ງໃນ SonarQube ໃຫ້ກັບນັກພັດທະນາ

SonarQube ເປັນແພລະຕະຟອມການຮັບປະກັນຄຸນນະພາບລະຫັດແຫຼ່ງເປີດທີ່ສະຫນັບສະຫນູນລະດັບຄວາມກ້ວາງຂອງພາສາການຂຽນໂປລແກລມແລະລາຍງານກ່ຽວກັບ metrics ເຊັ່ນ: ການຊໍ້າຊ້ອນຂອງລະຫັດ, ການປະຕິບັດຕາມມາດຕະຖານການເຂົ້າລະຫັດ, ການຄຸ້ມຄອງການທົດສອບ, ຄວາມສັບສົນຂອງລະຫັດ, ແມງໄມ້ທີ່ອາດມີ, ແລະອື່ນໆ. SonarQube ສະ​ດວກ​ສະ​ບາຍ​ພາບ​ຜົນ​ການ​ວິ​ເຄາະ​ແລະ​ອະ​ນຸ​ຍາດ​ໃຫ້​ທ່ານ​ເພື່ອ​ຕິດ​ຕາມ​ນະ​ໂຍ​ບາຍ​ດ້ານ​ການ​ພັດ​ທະ​ນາ​ໂຄງ​ການ​ໃນ​ໄລ​ຍະ​.

ຈຸດປະສົງ: ສະແດງໃຫ້ນັກພັດທະນາເຫັນສະຖານະຂອງການຄວບຄຸມຄຸນະພາບລະຫັດແຫຼ່ງໃນ SonarQube.

ມີ​ສອງ​ວິ​ທີ​ແກ້​ໄຂ​ແມ່ນ​:

• ແລ່ນສະຄຣິບເພື່ອກວດເບິ່ງສະຖານະການຄວບຄຸມຄຸນນະພາບລະຫັດແຫຼ່ງໃນ SonarQube. ຖ້າການຄວບຄຸມຄຸນະພາບຂອງລະຫັດແຫຼ່ງໃນ SonarQube ບໍ່ຜ່ານ, ຫຼັງຈາກນັ້ນການປະກອບການລົ້ມເຫລວ.
• ສະແດງສະຖານະການຄວບຄຸມຄຸນນະພາບລະຫັດແຫຼ່ງໃນຫນ້າໂຄງການຕົ້ນຕໍ.

ການຕິດຕັ້ງ SonarQube

ເພື່ອຕິດຕັ້ງ sonarqube ຈາກຊຸດ rpm, ພວກເຮົາຈະໃຊ້ repository https://harbottle.gitlab.io/harbottle-main.

ໃຫ້ຕິດຕັ້ງຊຸດບ່ອນເກັບຂໍ້ມູນສໍາລັບ CentOS 7.

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

ພວກເຮົາຕິດຕັ້ງ sonarqube ຕົວຂອງມັນເອງ.

yum install -y sonarqube

ໃນລະຫວ່າງການຕິດຕັ້ງ, plugins ສ່ວນໃຫຍ່ຈະຖືກຕິດຕັ້ງ, ແຕ່ທ່ານຈໍາເປັນຕ້ອງຕິດຕັ້ງ findbugs ແລະ pmd

yum install -y sonarqube-findbugs sonarqube-pmd

ເປີດຕົວບໍລິການແລະເພີ່ມມັນໃສ່ການເລີ່ມຕົ້ນ

systemctl start sonarqube
systemctl enable sonarqube

ຖ້າມັນໃຊ້ເວລາດົນໃນການໂຫຼດ, ຫຼັງຈາກນັ້ນໃຫ້ເພີ່ມເຄື່ອງກໍາເນີດຕົວເລກແບບສຸ່ມ /dev/./urandom ໄປຫາຈຸດສິ້ນສຸດຂອງຕົວເລືອກ sonar.web.javaOpts.

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

ແລ່ນສະຄຣິບເພື່ອກວດສອບສະຖານະຂອງການຄວບຄຸມຄຸນນະພາບລະຫັດແຫຼ່ງໃນ SonarQube.

ແຕ່ຫນ້າເສຍດາຍ, plugin sonar-break-maven-plugin ບໍ່ໄດ້ຮັບການປັບປຸງເປັນເວລາດົນນານ. ສະນັ້ນໃຫ້ເຮົາຂຽນຕົວໜັງສືຂອງເຮົາເອງ.

ສໍາລັບການທົດສອບພວກເຮົາຈະນໍາໃຊ້ repository https://github.com/uweplonus/spotbugs-examples.

ນໍາເຂົ້າໃນ Gitlab. ເພີ່ມໄຟລ໌ .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

ໄຟລ໌ .gitlab-ci.yml ບໍ່ສົມບູນແບບ. ການ​ທົດ​ສອບ​ຖ້າ​ຫາກ​ວ່າ​ວຽກ​ງານ​ການ​ສະ​ແກນ​ໃນ sonarqube ໄດ້​ສິ້ນ​ສຸດ​ລົງ​ດ້ວຍ​ສະ​ຖາ​ນະ​ພາບ​: "ຄວາມ​ສໍາ​ເລັດ​"​. ມາຮອດປະຈຸ, ບໍ່ມີສະຖານະພາບອື່ນ. ທັນທີທີ່ມີສະຖານະພາບອື່ນໆ, ຂ້ອຍຈະແກ້ໄຂ .gitlab-ci.yml ໃນຂໍ້ຄວາມນີ້.

ສະແດງສະຖານະການຄວບຄຸມຄຸນນະພາບລະຫັດແຫຼ່ງໃນຫນ້າໂຄງການຕົ້ນຕໍ

ການຕິດຕັ້ງ plugin ສໍາລັບ SonarQube

yum install -y sonarqube-qualinsight-badges

ພວກເຮົາໄປ SonarQube ຢູ່ http://172.26.9.115:9000/
ສ້າງຜູ້ໃຊ້ປົກກະຕິ, ຕົວຢ່າງ "ປ້າຍ".
ເຂົ້າສູ່ລະບົບ SonarQube ພາຍໃຕ້ຜູ້ໃຊ້ນີ້.

ໄປທີ່ "ບັນຊີຂອງຂ້ອຍ", ສ້າງ token ໃໝ່, ຕົວຢ່າງເຊັ່ນ "read_all_repository" ແລະກົດ "ສ້າງ".

ພວກເຮົາເຫັນວ່າ token ໄດ້ປະກົດຂຶ້ນ. ລາວຈະປາກົດພຽງແຕ່ 1 ເທື່ອ.

ເຂົ້າສູ່ລະບົບເປັນຜູ້ບໍລິຫານ.

ໄປທີ່ການຕັ້ງຄ່າ -> SVG Badges

ສຳເນົາໂທເຄັນນີ້ໃສ່ໃນຊ່ອງ "ໂທເຄັນປ້າຍການເຄື່ອນໄຫວ" ແລ້ວຄລິກທີ່ປຸ່ມບັນທຶກ.

ໄປທີ່ Administration -> Security -> Permission Templates -> Default template (ແລະແມ່ແບບອື່ນໆທີ່ທ່ານຈະມີ).

ຜູ້ໃຊ້ badges ຕ້ອງມີ checkbox "Browse" checkbox.

ການທົດສອບ.

ຕົວຢ່າງ, ໃຫ້ເຮົາເອົາໂຄງການ https://github.com/jitpack/maven-simple.

ໃຫ້ນໍາເຂົ້າໂຄງການນີ້.

ເພີ່ມໄຟລ໌ .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.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

ໃນ SonarQube ໂຄງການຈະມີລັກສະນະນີ້:

ເພີ່ມຖົງໃສ່ README.md ແລະພວກມັນຈະມີລັກສະນະນີ້:

ລະຫັດສະແດງປ້າຍຊື່ເບິ່ງຄືວ່າ:

ວິເຄາະປ້າຍສະແດງສະຕຣິງ:

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

ບ່ອນທີ່ໄດ້ຮັບ / ກວດເບິ່ງລະຫັດໂຄງການແລະ ID ໂຄງການ.

ລະຫັດໂຄງການແມ່ນຢູ່ເບື້ອງຂວາລຸ່ມ. URL ປະກອບມີ ID ໂຄງການ.

ທາງເລືອກສໍາລັບການໄດ້ຮັບ metrics ສາມາດ ເບິ່ງທີ່ນີ້.

ການຮ້ອງຂໍດຶງທັງຫມົດສໍາລັບການປັບປຸງ, ແກ້ໄຂ bug ສົ່ງກັບ repository ນີ້.

Telegram ສົນທະນາກ່ຽວກັບ SonarQube https://t.me/sonarqube_ru
Telegram ສົນທະນາກ່ຽວກັບ DevSecOps - DevOps ປອດໄພ https://t.me/sec_devops

ແຫຼ່ງຂໍ້ມູນ: www.habr.com