डेवलपर्स को सोनारक्यूब में स्रोत कोड गुणवत्ता नियंत्रण की स्थिति दिखाएं

सोनारक्यूब एक खुला स्रोत कोड निरंतर गुणवत्ता आश्वासन मंच है जो बड़ी संख्या में प्रोग्रामिंग भाषाओं का समर्थन करता है और कोड दोहराव, कोडिंग मानकों के अनुपालन, परीक्षण कवरेज, कोड जटिलता, संभावित बग और बहुत कुछ जैसे मेट्रिक्स पर रिपोर्टिंग प्रदान करता है। सोनारक्यूब आसानी से विश्लेषण के परिणामों की कल्पना करता है और आपको समय के साथ परियोजना विकास की गतिशीलता को ट्रैक करने की अनुमति देता है।

उद्देश्य: डेवलपर्स को सोनारक्यूब में स्रोत कोड की गुणवत्ता नियंत्रण स्थिति दिखाएं।

हल करने के दो तरीके हैं:

• सोनारक्यूब में स्रोत कोड गुणवत्ता नियंत्रण स्थिति की जांच करने के लिए स्क्रिप्ट चलाएँ। यदि सोनारक्यूब में स्रोत कोड का गुणवत्ता नियंत्रण विफल हो जाता है, तो निर्माण विफल हो जाता है।
• मुख्य परियोजना पृष्ठ पर स्रोत कोड गुणवत्ता नियंत्रण स्थिति दिखाएं।

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

आरपीएम पैकेज से सोनारक्यूब स्थापित करने के लिए, रिपॉजिटरी का उपयोग करें 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

इंस्टॉलेशन के दौरान, अधिकांश प्लगइन्स इंस्टॉल हो जाएंगे, लेकिन आपको फाइंडबग्स और पीएमडी इंस्टॉल करना होगा

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

सोनारक्यूब में स्रोत कोड गुणवत्ता नियंत्रण स्थिति की जांच करने के लिए स्क्रिप्ट चलाएँ।

दुर्भाग्य से, सोनार-ब्रेक-मेवेन-प्लगइन को लंबे समय से अपडेट नहीं किया गया है। तो चलिए अपनी स्क्रिप्ट खुद लिखते हैं।

परीक्षण के लिए, हम रिपॉजिटरी का उपयोग करेंगे https://github.com/uweplonus/spotbugs-examples.

गिटलैब में आयात करें. .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 को सही कर दूंगा।

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

सोनारक्यूब के लिए प्लगइन इंस्टॉल करना

yum install -y sonarqube-qualinsight-badges

हम सोनारक्यूब पर जाते हैं http://172.26.9.115:9000/
हम एक सामान्य उपयोगकर्ता बनाते हैं, उदाहरण के लिए "बैज"।
हम SonarQube में इस उपयोगकर्ता के अंतर्गत जाते हैं।

हम "मेरा खाता" पर जाते हैं, एक नया टोकन बनाते हैं, उदाहरण के लिए "read_all_repository" नाम से और "जेनरेट" पर क्लिक करते हैं।

हम देखते हैं कि एक टोकन प्रकट हुआ है। यह केवल एक बार ही प्रकट होता है.

हम प्रशासक के अधीन जाते हैं।

कॉन्फ़िगरेशन -> एसवीजी बैज पर जाएं

इस टोकन को "एक्टिविटी बैज टोकन" फ़ील्ड में कॉपी करें और सेव बटन दबाएँ।

प्रशासन -> सुरक्षा -> अनुमति टेम्प्लेट -> डिफ़ॉल्ट टेम्प्लेट (और अन्य टेम्प्लेट जो आपके पास होंगे) पर जाएँ।

बैज उपयोगकर्ता को "ब्राउज़ करें" चेकबॉक्स को जांचना होगा।

परीक्षण।

आइए प्रोजेक्ट को एक उदाहरण के रूप में लें। 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-проекта)

प्रोजेक्ट कुंजी और प्रोजेक्ट आईडी कहां से प्राप्त/जांचें।

प्रोजेक्ट कुंजी नीचे दाईं ओर है। यूआरएल में प्रोजेक्ट आईडी है।

मेट्रिक्स प्राप्त करने के विकल्प हो सकते हैं यहाँ देखो.

सुधार, बग फिक्स के लिए सभी पुल अनुरोध इस रिपॉजिटरी में सबमिट करें.

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

स्रोत: www.habr.com