സോണാർക്യൂബിൽ സോഴ്സ് കോഡ് ഗുണനിലവാര നിയന്ത്രണ നില ഡവലപ്പർമാർക്ക് പ്രദർശിപ്പിക്കുന്നു

SonarQube ഒരു ഓപ്പൺ സോഴ്‌സ് കോഡ് ക്വാളിറ്റി അഷ്വറൻസ് പ്ലാറ്റ്‌ഫോമാണ്, അത് വിപുലമായ പ്രോഗ്രാമിംഗ് ഭാഷകളെ പിന്തുണയ്ക്കുകയും കോഡ് ഡ്യൂപ്ലിക്കേഷൻ, കോഡിംഗ് സ്റ്റാൻഡേർഡ് കംപ്ലയൻസ്, ടെസ്റ്റ് കവറേജ്, കോഡ് കോംപ്ലക്‌സിറ്റി, പൊട്ടൻഷ്യൽ ബഗുകൾ എന്നിവയും അതിലേറെയും പോലുള്ള മെട്രിക്‌സുകളെക്കുറിച്ചുള്ള റിപ്പോർട്ടിംഗ് നൽകുന്നു. SonarQube വിശകലന ഫലങ്ങൾ സൗകര്യപ്രദമായി ദൃശ്യവൽക്കരിക്കുകയും കാലക്രമേണ പ്രോജക്റ്റ് വികസനത്തിന്റെ ചലനാത്മകത ട്രാക്കുചെയ്യാൻ നിങ്ങളെ അനുവദിക്കുകയും ചെയ്യുന്നു.

ലക്ഷ്യം: SonarQube-ൽ സോഴ്‌സ് കോഡ് ഗുണനിലവാര നിയന്ത്രണത്തിന്റെ നില ഡവലപ്പർമാരെ കാണിക്കുക.

രണ്ട് പരിഹാരങ്ങളുണ്ട്:

• SonarQube-ലെ സോഴ്സ് കോഡ് ഗുണനിലവാര നിയന്ത്രണ നില പരിശോധിക്കാൻ ഒരു സ്ക്രിപ്റ്റ് പ്രവർത്തിപ്പിക്കുക. SonarQube-ലെ സോഴ്‌സ് കോഡിന്റെ ഗുണനിലവാര നിയന്ത്രണം കടന്നുപോകുന്നില്ലെങ്കിൽ, അസംബ്ലി പരാജയപ്പെടുക.
• പ്രധാന പ്രോജക്റ്റ് പേജിൽ സോഴ്സ് കോഡ് ഗുണനിലവാര നിയന്ത്രണ നില കാണിക്കുക.

SonarQube ഇൻസ്റ്റാൾ ചെയ്യുന്നു

rpm പാക്കേജുകളിൽ നിന്ന് 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-ലെ സോഴ്സ് കോഡ് ഗുണനിലവാര നിയന്ത്രണത്തിന്റെ നില പരിശോധിക്കാൻ ഒരു സ്ക്രിപ്റ്റ് പ്രവർത്തിപ്പിക്കുന്നു.

നിർഭാഗ്യവശാൽ, 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 ഫയൽ തികഞ്ഞതല്ല. സോനാർക്യൂബിലെ സ്കാനിംഗ് ടാസ്‌ക്കുകൾ "വിജയം" എന്ന നിലയിലാണ് അവസാനിച്ചതെന്ന് പരിശോധിച്ചു. ഇതുവരെ മറ്റ് സ്റ്റാറ്റസുകളൊന്നും ഉണ്ടായിരുന്നില്ല. മറ്റ് സ്റ്റാറ്റസുകൾ ഉള്ളപ്പോൾ, ഈ പോസ്റ്റിൽ ഞാൻ .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 ഫയൽ ചേർക്കുക.

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-ൽ പ്രോജക്റ്റ് ഐഡി അടങ്ങിയിരിക്കുന്നു.

മെട്രിക്സ് നേടുന്നതിനുള്ള ഓപ്ഷനുകൾ ആകാം ഇവിടെ നോക്കൂ.

മെച്ചപ്പെടുത്തലുകൾക്കും ബഗ് പരിഹാരങ്ങൾക്കുമുള്ള എല്ലാ പുൾ അഭ്യർത്ഥനകളും ഈ ശേഖരത്തിലേക്ക് സമർപ്പിക്കുക.

SonarQube-നെക്കുറിച്ചുള്ള ടെലിഗ്രാം ചാറ്റ് https://t.me/sonarqube_ru
DevSecOps-നെക്കുറിച്ചുള്ള ടെലിഗ്രാം ചാറ്റ് - സുരക്ഷിത DevOps https://t.me/sec_devops

അവലംബം: www.habr.com