បង្ហាញស្ថានភាពត្រួតពិនិត្យគុណភាពកូដប្រភពនៅក្នុង SonarQube ដល់អ្នកអភិវឌ្ឍន៍

SonarQube គឺជាវេទិកាធានាគុណភាពកូដប្រភពបើកចំហដែលគាំទ្រភាសាកម្មវិធីជាច្រើន និងផ្តល់នូវការរាយការណ៍អំពីម៉ែត្រដូចជាការចម្លងកូដ ការអនុលោមតាមស្តង់ដារការសរសេរកូដ ការគ្របដណ្តប់លើការធ្វើតេស្ត ភាពស្មុគស្មាញនៃកូដ កំហុសដែលអាចកើតមាន និងច្រើនទៀត។ SonarQube មើលឃើញលទ្ធផលវិភាគយ៉ាងងាយស្រួល និងអនុញ្ញាតឱ្យអ្នកតាមដានថាមវន្តនៃការអភិវឌ្ឍន៍គម្រោងតាមពេលវេលា។

គោលបំណង៖ បង្ហាញអ្នកអភិវឌ្ឍន៍នូវស្ថានភាពនៃការគ្រប់គ្រងគុណភាពកូដប្រភពនៅក្នុង SonarQube ។

មានដំណោះស្រាយពីរ៖

• ដំណើរការស្គ្រីបដើម្បីពិនិត្យមើលស្ថានភាពត្រួតពិនិត្យគុណភាពកូដប្រភពនៅក្នុង SonarQube ។ ប្រសិនបើការត្រួតពិនិត្យគុណភាពនៃកូដប្រភពនៅក្នុង SonarQube មិនហុច នោះការជួបប្រជុំគ្នានឹងបរាជ័យ។
• បង្ហាញស្ថានភាពត្រួតពិនិត្យគុណភាពកូដប្រភពនៅលើទំព័រគម្រោងចម្បង។

ការដំឡើង SonarQube

ដើម្បីដំឡើង sonarqube ពីកញ្ចប់ rpm យើងនឹងប្រើឃ្លាំង 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

កំឡុងពេលដំឡើង កម្មវិធីជំនួយភាគច្រើននឹងត្រូវបានដំឡើង ប៉ុន្តែអ្នកត្រូវដំឡើង 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 ។

ជាអកុសល កម្មវិធីជំនួយ sonar-break-maven-plugin មិនត្រូវបានអាប់ដេតអស់រយៈពេលជាយូរមកហើយ។ ដូច្នេះ ចូរ​យើង​សរសេរ​ស្គ្រីប​របស់​យើង។

សម្រាប់ការធ្វើតេស្តយើងនឹងប្រើឃ្លាំង 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 នៅក្នុងការប្រកាសនេះ។

ការបង្ហាញស្ថានភាពត្រួតពិនិត្យគុណភាពកូដប្រភពនៅលើទំព័រគម្រោងចម្បង

ការដំឡើងកម្មវិធីជំនួយសម្រាប់ SonarQube

yum install -y sonarqube-qualinsight-badges

យើងទៅ SonarQube នៅ http://172.26.9.115:9000/
បង្កើតអ្នកប្រើប្រាស់ធម្មតា ឧទាហរណ៍ "ផ្លាកសញ្ញា"។
ចូលទៅ SonarQube នៅក្រោមអ្នកប្រើប្រាស់នេះ។

ចូលទៅកាន់ "គណនីរបស់ខ្ញុំ" បង្កើតនិមិត្តសញ្ញាថ្មីឧទាហរណ៍ជាមួយឈ្មោះ "read_all_repository" ហើយចុច "បង្កើត" ។

យើងឃើញថានិមិត្តសញ្ញាមួយបានលេចចេញមក។ គាត់នឹងបង្ហាញខ្លួនតែ 1 ដងប៉ុណ្ណោះ។

ចូលជាអ្នកគ្រប់គ្រង។

ចូលទៅកាន់ការកំណត់រចនាសម្ព័ន្ធ -> ស្លាកសញ្ញា SVG

ចម្លងសញ្ញាសម្ងាត់នេះទៅក្នុងវាល "និមិត្តសញ្ញាផ្លាកសញ្ញាសកម្មភាព" ហើយចុចប៊ូតុងរក្សាទុក។

ចូលទៅកាន់រដ្ឋបាល -> សុវត្ថិភាព -> គំរូអនុញ្ញាត -> គំរូលំនាំដើម (និងគំរូផ្សេងទៀតដែលអ្នកនឹងមាន) ។

អ្នកប្រើប្រាស់ផ្លាកសញ្ញាត្រូវតែធីកប្រអប់ "រកមើល"។

ការសាកល្បង។

ជាឧទាហរណ៍ ចូរយើងយកគម្រោង https://github.com/jitpack/maven-simple.

ចូរយើងនាំចូលគម្រោងនេះ។

បន្ថែមឯកសារ .gitlab-ci.yml ទៅ root គម្រោងដែលមានខ្លឹមសារដូចខាងក្រោម។

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

កន្លែងដែលត្រូវទទួល/ពិនិត្យគម្រោងសោរ និងលេខសម្គាល់គម្រោង។

សោគម្រោងគឺនៅខាងស្តាំខាងក្រោម។ URL មានលេខសម្គាល់គម្រោង។

ជម្រើសសម្រាប់ការទទួលបានម៉ែត្រអាចជា មើលត្រង់នេះ។.

សំណើទាញទាំងអស់សម្រាប់ការកែលម្អ ការកែកំហុស ដាក់ស្នើទៅឃ្លាំងនេះ។.

Telegram ជជែកអំពី SonarQube https://t.me/sonarqube_ru
Telegram ជជែកអំពី DevSecOps - សុវត្ថិភាព DevOps https://t.me/sec_devops

ប្រភព: www.habr.com