gitlab配合Sonar實(shí)現(xiàn)提交后自動(dòng)代碼檢測(cè)

0. 最終效果

本次演示通過(guò)Docker部署SonarQube和Gitlab，實(shí)現(xiàn)代碼提交gitlab后，自動(dòng)執(zhí)行CI流水線，調(diào)用sonar對(duì)代碼進(jìn)行靜態(tài)檢測(cè)分析，并將檢測(cè)結(jié)果同步到gitlab中。

結(jié)果演示.png

1. 實(shí)驗(yàn)環(huán)境

版本號(hào)很重要！
版本號(hào)很重要??！
版本號(hào)很重要！??！

1.1 Sonar GitLab Plugin 4.1.0

??Only SonarQube < 7.7, because preview mode is removed??

官方地址-GitHub

版本 >= sonar-gitlab-plugin-4.1.0-SNAPSHOT.jar

1.2 SonarQube 7.6

官方地址-GitHub

1.3 GitLab 9.1.7

因?yàn)樵摥h(huán)境已具備，后續(xù)不再演示gitlab的搭建過(guò)程。
其他版本未測(cè)試，但是gitlab的版本應(yīng)該不影響實(shí)驗(yàn)的結(jié)果。

2. 安裝軟件

2.1 通過(guò)docker部署SonarQube

docker-compose.yml

version: "2"

services:
  sonarqube:
    image: sonarqube:7.6-community
    depends_on:
      - db
    ports:
      - "7777:9000"
    networks:
      - sonarnet
    environment:
      SONARQUBE_JDBC_URL: jdbc:postgresql://db:5432/sonar
      SONARQUBE_JDBC_USERNAME: sonar
      SONARQUBE_JDBC_PASSWORD: sonar
    volumes:
      - sonarqube_data:/opt/sonarqube/data
      - sonarqube_extensions:/opt/sonarqube/extensions
      - sonarqube_logs:/opt/sonarqube/logs
      - sonarqube_temp:/opt/sonarqube/temp
  db:
    image: postgres
    networks:
      - sonarnet
    environment:
      POSTGRES_USER: sonar
      POSTGRES_PASSWORD: sonar
    volumes:
      - postgresql:/var/lib/postgresql
      - postgresql_data:/var/lib/postgresql/data

networks:
  sonarnet:
    driver: bridge

volumes:
  sonarqube_data:
  sonarqube_extensions:
  sonarqube_logs:
  sonarqube_temp:
  postgresql:
  postgresql_data:

啟動(dòng)

docker-compose up -d

訪問(wèn)

http://127.0.0.1:7777
（默認(rèn)）用戶名：admin
（默認(rèn)）密碼：admin

訪問(wèn)Sonar.png

2.1.1 安裝 Sonar GitLab Plugin

下載：sonar-gitlab-plugin-4.1.0-SNAPSHOT.jar，將jar包拷貝到sonar的plugin目錄下：

docker cp ./sonar-gitlab-plugin-4.1.0-SNAPSHOT.jar  sonar_sonarqube_1:/opt/sonarqube/extensions/plugins/

重啟sonar即可使插件生效。

重啟.png

2.1.2 關(guān)聯(lián)GitLab

切換到Administration > Configuration > GitLab功能，

  • 設(shè)置gitlab的地址
  • 設(shè)置可以訪問(wèn)gitlab的用戶的訪問(wèn)token，??該用戶必須擁有開發(fā)者權(quán)限。
關(guān)聯(lián)GitLab.png

獲取User Token

新建一個(gè)gitlab用戶：sonarQube，用該用戶登錄。

設(shè)置.png
創(chuàng)建個(gè)人訪問(wèn)令牌.png

此處的“名稱”可以隨便填，目的在于方便記憶。
將生成后的Token填入Sonar即可。

分配權(quán)限

將sonarQube用戶添加到需要檢測(cè)的項(xiàng)目中，分配“開發(fā)者”權(quán)限。

分配權(quán)限.png

2.2 Docker安裝GitLab-runner

gitlab-runner啟動(dòng)腳本：start_runner.sh

docker run -d --name gitlab-runner --restart always \
  -v /home/pay/docker/gitlab_runner/conf:/etc/gitlab-runner \
  -v /var/run/docker.sock:/var/run/docker.sock \
  gitlab/gitlab-runner:latest

gitlab-runner注冊(cè)腳本：register.sh

docker exec -it gitlab-runner gitlab-ci-multi-runner register -n \
  --url ??http://your-gitlab-com?? \
  --registration-token "??PROJECT_REGISTRATION_TOKEN??"\
  --tag-list=gitlab-pos \
  --description "gitlab-pos" \
  --docker-privileged=false \
  --docker-pull-policy="if-not-present" \
  --docker-image "maven:3.6.3-jdk-8:latest" \
  --docker-volumes /var/run/docker.sock:/var/run/docker.sock \
  --docker-volumes /home/your/path/m2:/root/.m2 \
  --docker-volumes /home/your/path/cache:/cache \
  --executor docker

點(diǎn)擊查看官網(wǎng)示例

要點(diǎn)說(shuō)明：

url：

gitlab的訪問(wèn)地址

registration-token

gitlab要注冊(cè)新的 Runner 所需要輸入后面的注冊(cè)授權(quán)碼。
管理員登錄后，在“管理區(qū)域 > Runners”菜單即可查看或者重置token

Runner Registration Token.png

docker-image

此處我們選擇maven:3.6.3-jdk-8:latest，因?yàn)槲覀兊腏ava項(xiàng)目是通過(guò)maven來(lái)管理依賴，編譯時(shí)也需要jdk環(huán)境。

docker-volumes /home/your/path/m2:/root/.m2

容器中，會(huì)將maven的settings-docker.xml配置和緩存的jar包放在/root/.m2目錄下，??我們可以修改settings-docker.xml，配置私有maven庫(kù)或者鏡像??

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <localRepository>/usr/share/maven/ref/repository</localRepository>

<mirrors>
  <!--配置私有maven鏡像-->
  <mirror>
    <id>nexus-private</id>
    <mirrorOf>central</mirrorOf>
    <name>Nexus osc</name>
    <url>http://127.0.0.1/repository/maven-central/</url>
  </mirror> 

  <mirror>
    <id>alimaven</id>
    <name>aliyun maven</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
    <mirrorOf>central</mirrorOf>        
  </mirror>
</mirrors>
</settings>
Runner管理.png

3. 開啟Gitlab CI

在項(xiàng)目根目錄添加文件：.gitlab-ci.yml

image: maven:3.6.3-jdk-8

stages:
  - scanner

example-sonar:
  stage: scanner
  tags:
    - gitlab-pos
  script:
    - mvn clean verify -Dmaven.test.skip=true
    - mvn -e -X --batch-mode sonar:sonar
        -Dsonar.host.url=http://127.0.0.1:7777
        -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA
        -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
        -Dsonar.gitlab.project_id=$CI_PROJECT_ID
        -Dsonar.issuesReport.html.enable=true
        -Dsonar.analysis.mode=preview #設(shè)置后，sonar不創(chuàng)建項(xiàng)目，只做分析

提交后，在gitlab項(xiàng)目界面，查看流水線即可查看執(zhí)行狀態(tài)。

流水線.png
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容