🥇সোনারকিউবে ডেভেলপারদের কাছে সোর্স কোডের মান নিয়ন্ত্রণের অবস্থা প্রদর্শন করা

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

আমরা নিজেই সোনারকিউব ইনস্টল করি।

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-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

আমরা SonarQube এ যাই http://172.26.9.115:9000/
একটি নিয়মিত ব্যবহারকারী তৈরি করুন, উদাহরণস্বরূপ "ব্যাজ"।
এই ব্যবহারকারীর অধীনে সোনারকিউবে লগ ইন করুন।

"আমার অ্যাকাউন্ট" এ যান, একটি নতুন টোকেন তৈরি করুন, উদাহরণস্বরূপ "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

সোনারকিউবে প্রকল্পটি দেখতে এইরকম হবে:

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

প্রোজেক্ট কী এবং প্রোজেক্ট আইডি কোথায় পাবেন/চেক করবেন।

প্রজেক্ট কী নীচে ডানদিকে রয়েছে। ইউআরএলে প্রোজেক্ট আইডি রয়েছে।