הצגת סטטוס בקרת איכות קוד מקור ב- 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" ולחץ על "צור".

אנו רואים שהופיע אסימון. הוא יופיע רק פעם אחת.

התחבר כמנהל.

עבור אל תצורה -> תגי 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-проекта)

היכן ניתן להשיג/לבדוק את מפתח הפרויקט ומזהה הפרויקט.

מפתח הפרויקט נמצא בפינה השמאלית התחתונה. כתובת האתר מכילה את מזהה הפרויקט.

אפשרויות לקבלת מדדים יכולות להיות תסתכל כאן.

כל בקשות המשיכה לשיפורים, תיקוני באגים להגיש למאגר זה.

צ'אט בטלגרם על SonarQube https://t.me/sonarqube_ru
צ'אט בטלגרם על DevSecOps - DevOps מאובטח https://t.me/sec_devops

מקור: www.habr.com