🥇 SonarQube मध्ये सोर्स कोड गुणवत्ता नियंत्रण स्थिती विकसकांना दाखवत आहे

सोनारक्यूब हे ओपन सोर्स कोड क्वालिटी अॅश्युरन्स प्लॅटफॉर्म आहे जे प्रोग्रामिंग भाषांच्या विस्तृत श्रेणीचे समर्थन करते आणि कोड डुप्लिकेशन, कोडिंग मानकांचे पालन, चाचणी कव्हरेज, कोड जटिलता, संभाव्य बग आणि बरेच काही यासारख्या मेट्रिक्सवर अहवाल प्रदान करते. SonarQube सोयीस्करपणे विश्लेषण परिणामांची कल्पना करते आणि तुम्हाला कालांतराने प्रकल्प विकासाच्या गतीशीलतेचा मागोवा घेण्यास अनुमती देते.

उद्दिष्ट: विकसकांना सोनारक्यूबमधील स्त्रोत कोड गुणवत्ता नियंत्रणाची स्थिती दर्शवा.

दोन उपाय आहेत:

SonarQube मध्ये स्त्रोत कोड गुणवत्ता नियंत्रण स्थिती तपासण्यासाठी स्क्रिप्ट चालवा. SonarQube मधील स्त्रोत कोडचे गुणवत्ता नियंत्रण पास होत नसल्यास, असेंब्ली अयशस्वी करा.
मुख्य प्रकल्प पृष्ठावर स्त्रोत कोड गुणवत्ता नियंत्रण स्थिती दर्शवा.

सोनारक्यूब स्थापित करत आहे

आरपीएम पॅकेजेसमधून सोनारक्यूब स्थापित करण्यासाठी, आम्ही रेपॉजिटरी वापरू https://harbottle.gitlab.io/harbottle-main.

CentOS 7 साठी रेपॉजिटरीसह पॅकेज स्थापित करूया.

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

आम्ही सोनारक्यूब स्वतः स्थापित करतो.

yum install -y sonarqube

स्थापनेदरम्यान, बहुतेक प्लगइन स्थापित केले जातील, परंतु आपल्याला findbugs आणि pmd स्थापित करणे आवश्यक आहे

yum install -y sonarqube-findbugs sonarqube-pmd

सेवा लाँच करा आणि ती स्टार्टअपमध्ये जोडा

systemctl start sonarqube
systemctl enable sonarqube

लोड होण्यास बराच वेळ लागल्यास, sonar.web.javaOpts पर्यायांच्या शेवटी एक यादृच्छिक क्रमांक जनरेटर /dev/./urandom जोडा.

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

SonarQube मध्ये स्त्रोत कोड गुणवत्ता नियंत्रणाची स्थिती तपासण्यासाठी स्क्रिप्ट चालवणे.

दुर्दैवाने, सोनार-ब्रेक-मावेन-प्लगइन प्लगइन बर्याच काळापासून अद्यतनित केले गेले नाही. चला तर मग स्वतःची स्क्रिप्ट लिहूया.

चाचणीसाठी आम्ही रेपॉजिटरी वापरू 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 फाइल परिपूर्ण नाही. सोनारक्यूबमधील स्कॅनिंग कार्ये या स्थितीसह समाप्त झाली असल्यास चाचणी केली: "यशस्वी". आतापर्यंत इतर कोणत्याही स्थिती नाहीत. इतर स्टेटस येताच, मी या पोस्टमध्ये .gitlab-ci.yml दुरुस्त करेन.

मुख्य प्रकल्प पृष्ठावर स्त्रोत कोड गुणवत्ता नियंत्रण स्थिती प्रदर्शित करणे

SonarQube साठी प्लगइन स्थापित करत आहे

yum install -y sonarqube-qualinsight-badges

आम्ही सोनारक्यूब येथे जातो http://172.26.9.115:9000/
नियमित वापरकर्ता तयार करा, उदाहरणार्थ "बॅज".
या वापरकर्त्याच्या अंतर्गत सोनारक्यूबमध्ये लॉग इन करा.

“माझे खाते” वर जा, एक नवीन टोकन तयार करा, उदाहरणार्थ “read_all_repository” नावाने आणि “generate” वर क्लिक करा.

आम्ही पाहतो की एक टोकन दिसले आहे. तो फक्त 1 वेळा दिसेल.

प्रशासक म्हणून लॉग इन करा.

कॉन्फिगरेशन -> SVG बॅजेस वर जा

हे टोकन "क्रियाकलाप बॅज टोकन" फील्डमध्ये कॉपी करा आणि सेव्ह बटणावर क्लिक करा.

प्रशासन -> सुरक्षा -> परवानगी टेम्पलेट -> डीफॉल्ट टेम्पलेट (आणि तुमच्याकडे असलेले इतर टेम्पलेट) वर जा.

बॅज वापरकर्त्याने "ब्राउझ" चेकबॉक्स चेक केलेला असणे आवश्यक आहे.

चाचणी

उदाहरणार्थ, प्रकल्प घेऊ 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

सोनारक्यूबमध्ये प्रकल्प असे दिसेल:

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

प्रोजेक्ट की आणि प्रोजेक्ट आयडी कुठे मिळेल/तपासा.

प्रोजेक्ट की तळाशी उजवीकडे आहे. URL मध्ये प्रकल्प आयडी आहे.

मेट्रिक्स मिळविण्यासाठी पर्याय असू शकतात येथे पहा.

सुधारणा, दोष निराकरणासाठी सर्व पुल विनंत्या या भांडारात सबमिट करा.

सोनारक्यूबबद्दल टेलिग्राम चॅट https://t.me/sonarqube_ru
DevSecOps बद्दल टेलीग्राम चॅट - सुरक्षित DevOps https://t.me/sec_devops

स्त्रोत: www.habr.com

SonarQube मध्ये सोर्स कोड गुणवत्ता नियंत्रण स्थिती विकसकांना दाखवत आहे

सोनारक्यूब स्थापित करत आहे

SonarQube मध्ये स्त्रोत कोड गुणवत्ता नियंत्रणाची स्थिती तपासण्यासाठी स्क्रिप्ट चालवणे.

मुख्य प्रकल्प पृष्ठावर स्त्रोत कोड गुणवत्ता नियंत्रण स्थिती प्रदर्शित करणे

एक टिप्पणी जोडा Отменить ответ