SonarQube (终) Gitlab提交代码自动化测试

SonarQube系列 目录

• SonarQube (1) 基本环境搭建
• SonarQube (2) sonar runner安装配置
• SonarQube (3) C++插件安装与规则配置
• SonarQube (4) 运行一个Sample
• SonarQube (5) 集成至Jenkins
• SonarQube (终) Gitlab提交代码自动化测试

---

整体架构图

架构图.png

1. 软件开发工程师提交代码至Gitlab；
2. 触发Gitlab-CI，启动gitlab-runner Docker镜像准备运行测试；
3. Gitlab-CI触发sonar_runner Docker镜像启动，并进行代码分析；
4. 代码分析结果在commit记录作一次comment；
5. Gitlab管理员合并代码至develop或master分支；
6. 触发Gitlab-CI，启动gitlab-runner Docker镜像准备运行测试；
7. Gitlab-CI触发sonar_runner Docker镜像启动，并进行代码分析；
8. 代码分析结果保存至SonarQube平台数据库中；
9. 测试/开发组等用户访问SonarQube网页，查看分析的具体结果。

具体配置过程

sonar-scanner Docker镜像配置

sonar-scanner Docker镜像主要工作：

1. 拉取代码；
2. 运行sonar-scanner。

因此需要先下载sonar-scanner并配置环境变量等，保证sonar-scanner能够运行，并能将结果提交至SonarQube平台。

sonar-scanner安装

此处假设已有一个基础镜像

• 启动基础镜像

• 下载sonar-scanner压缩包： SonarQube Scanner

• 解压至目标目录（如 /etc）

• 更新 /conf/sonar-scanner.properties 文件中如下内容

#----- Default SonarQube server
#sonar.host.url=http://localhost:9000

如：

#----- Default SonarQube server
sonar.host.url=http://192.168.2.465:9000

• 将/bin添加到PATH中

export PATH=/bin:PATH

• 保存docker镜像，并命名为sonar-scanner

docker commit ID sonar-scanner

gitlab-runner Docker镜像配置

• 拉取gitlab-runner Docker镜像

docker pull gitlab/gitlab-runner:latest

• 启动gitlab-runner

docker run -d --name gitlab-runner --restart always \
  -v /srv/gitlab-runner/config:/etc/gitlab-runner \
  -v /var/run/docker.sock:/var/run/docker.sock \
  gitlab/gitlab-runner:latest

• 注册runner

# docker exec -it gitlab-runner gitlab-ci-multi-runner register

填写内容说明：
gitlab-ci coordinator URL: 期望设置的gitlab-ci URL；
gitlab-ci token: 从“目标Gitlab项目>setting>CI/CD Pipelines>Specific Runners”获取；

获取gitlab-ci token.png

gitlab-ci tag: runner的标识，在yaml文件中注明所选择的runner时需要用到（实例：yx-46）；
executor: 此处gitlab-runner安装于docker镜像中，因此选择doker；
default Docker image: gitlab-ci触发时默认拉取的docker镜像，此处可以填写sonar-scanner

• 填写如下内容:

Please enter the gitlab-ci coordinator URL:
# http://192.168.2.46/ci
Please enter the gitlab-ci token for this runner:
# 项目的 token
Please enter the gitlab-ci description for this runner:
# Runner 的 description
Please enter the gitlab-ci tags for this runner (comma separated):
# Runner 的 tag
Whether to run untagged builds [true/false]:
# true
Please enter the executor: docker, parallels, shell, kubernetes, docker-ssh, ssh, virtualbox, docker+machine, docker-ssh+machine:
# docker
Please enter the default Docker image (e.g. ruby:2.1):
# 填入构建 Docker image 时填写的 image 名称

若无意关闭gitlab-runner，再次启动前需要移除原来容器记录

docker stop gitlab-runner && docker rm gitlab-runner

再执行启动镜像的操作即可

docker run -d --name gitlab-runner --restart always \
 -v /srv/gitlab-runner/config:/etc/gitlab-runner \
 -v /var/run/docker.sock:/var/run/docker.sock \
 gitlab/gitlab-runner:latest

sonar gitlab-plugin配置

插件安装

admin 登录 SonarQube，点击 配置 —> 系统 —> 更新中心 —> Available —> Search，输入 GitLab，在列表中点击 install 安装，安装完毕后重启 SonarQube 即可

获取Gitlab帐户 Private token

建议新建一个SonarQube用户并赋读权限，对测试结果的评论由此账户发出更为直观

登录Gitlab帐号，点击 setting > Account，复制Private token

配置sonar gitlab-plugin

admin 登录 SonarQube，点击 配置 —> 通用配置 —> GitLab —> Reporting —> 设置 GitLab User Token 以及 GitLab url

配置gitlab插件.png

创建gitlab-ci.yml配置文件

以下为实现两种Pipline流程的yml文件：

1. Sonar_Analyze流程，执行sonar-scanner操作，直接将分析结果保存至SonarQube server中；
2. Sonar_Preview流程，执行sonar-scanner操作，模式为preview，在分析结束后将结果评论在commit记录中。

.gitlab-ci.yml内容：

image: sonar
Sonar_Analyze:
  script:  
  - source /etc/profile.d/sonarrc.sh
  - sonar-scanner
  only:
  - develop
  tags:
  - yx-gitlab-runner
Sonar_Preview:
  script:
  - source /etc/profile.d/sonarrc.sh
  - sonar-scanner -Dsonar.analysis.mode=preview -Dsonar.gitlab.commit_sha=$CI_BUILD_REF -Dsonar.gitlab.ref_name=$CI_BUILD_REF_NAME -Dsonar.gitlab.project_id=$CI_PROJECT_ID
  except:
  - develop
  tags:
  - yx-gitlab-runner

运行结果

非develop/master分支的代码修改触发的分析

提交代码结果1.png

develop/master分支的代码修改触发的分析

提交代码结果2.png

参考

https://docs.gitlab.com/runner/register/
https://docs.gitlab.com/ee/ci/yaml/README.html
https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner
http://blog.csdn.net/aixiaoyang168/article/details/72168834
http://blog.csdn.net/aixiaoyang168/article/details/78115646