SonarQube માં સોર્સ કોડ ગુણવત્તા નિયંત્રણ સ્થિતિ વિકાસકર્તાઓને પ્રદર્શિત કરી રહ્યું છે

SonarQube એક ઓપન સોર્સ કોડ ગુણવત્તા ખાતરી પ્લેટફોર્મ છે જે પ્રોગ્રામિંગ ભાષાઓની વિશાળ શ્રેણીને સમર્થન આપે છે અને કોડ ડુપ્લિકેશન, કોડિંગ ધોરણોનું પાલન, પરીક્ષણ કવરેજ, કોડ જટિલતા, સંભવિત ભૂલો અને વધુ જેવા મેટ્રિક્સ પર રિપોર્ટિંગ પ્રદાન કરે છે. SonarQube સરળતાથી વિશ્લેષણ પરિણામોની કલ્પના કરે છે અને તમને સમયાંતરે પ્રોજેક્ટ વિકાસની ગતિશીલતાને ટ્રૅક કરવાની મંજૂરી આપે છે.

ઉદ્દેશ્ય: વિકાસકર્તાઓને 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

ઇન્સ્ટોલેશન દરમિયાન, મોટાભાગના પ્લગઇન્સ ઇન્સ્ટોલ કરવામાં આવશે, પરંતુ તમારે ફાઇન્ડબગ્સ અને પીએમડી ઇન્સ્ટોલ કરવાની જરૂર છે

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

અમે 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 માં પ્રોજેક્ટ id છે.

મેટ્રિક્સ મેળવવા માટેના વિકલ્પો હોઈ શકે છે અહીં જુઓ.

સુધારાઓ, બગ ફિક્સેસ માટે તમામ પુલ વિનંતીઓ આ રીપોઝીટરીમાં સબમિટ કરો.

SonarQube વિશે ટેલિગ્રામ ચેટ https://t.me/sonarqube_ru
DevSecOps વિશે ટેલિગ્રામ ચેટ - સુરક્ષિત DevOps https://t.me/sec_devops

સોર્સ: www.habr.com