超详细，自动化测试接入Jenkins+Sonar质量门禁实践

大家好，我叫董鑫，一名在测试开发道路上的新手。第一阶段的学习已然结束，收获颇多，了解了很多在自己平时测试工作无法接触到的新知识，比如这次在这里分享的Sonarqube进行静态代码扫描并集成Jenkins的知识，是分享也是自我学习的总结。若有不对的地方，还请各位同行，同学，老师及时指正。

1. 什么是SonarQube

SonarQube是一个开源的代码质量管理系统，用于检测代码中的错误，漏洞和代码规范，通过插件的机制，

可以基于现有的Gitlab、Jenkins 集成、以便在项目拉取后进行连续的代码检查。

优点：

◆ 支持众多计算机编程语言

◆ 通过插件机制能集成IDE、Jenkins、Git等

◆ 内置大量常用代码检查规则

◆ 支持定制开发规则

◆ 可视化界面

◆ 支持从可靠性、安全性、可维护性、覆盖率、重复率等方面分析项目

具体的配置及文档可以访问下面的链接查看：

https://www.sonarqube.org/downloads/
https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/

2. Jenkins插件安装及配置

Sonarqube想要与Jenkins集成，需要安装相应的插件来支持。

在插件管理中搜索名为Sonarqube Scanner for Jenkins的插件并安装。

安装好插件后，还需要配置相应的服务和工具信息：

2.1. 系统设置->SonarQube servers

name：可自定义）
server url：这个地址就是你sonar服务所在的地址
token：在sonar项目中生成的token

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

2.2. 全局工具配置》SonarQube Scanner

建议不采用自动安装，使用手动下载配置好的sonar scanner

name：自定义sonar scanner名称，建议使用sonar-scanner
SONAR_RUNNER_HOME：sonar scanner所在的家目录

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

3. 自由风格的job使用sonar

3.1 配置代码仓库地址：

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

3.2 勾选sonarqube 服务并选择token:

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

3.3 在构建中添加Exeute SonarQube Sanner

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

这里可以使用两种方式：

a. 直接将sonar-project.properties配置内容写到 Analysis properties 中
b. 将配置好的sonar-project.properties文件放置在代码目录中，在 Path to project properties 配置相应的文件名

建议使用第二种方式来管理
我配置的sonar-project.properties文件如下：

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

保存好后，就可以来构建了。构建后项目页面可以直接跳转到sonarqube服务查看。

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

4. pipeline流水线使用sonar

4.1 构建一个流水线job，流水线pipeline script如下编写：

pipeline {
    agent any

    stages {
        stage('拉取代码') {
            steps {
                git credentialsId: 'gitee', url: 'https://gitee.com/dx0001/work.git'
            }
        }
        stage('静态代码静态扫描') {
            steps {
                withSonarQubeEnv('sonarqube'){
                    bat "sonar-scanner"
                }
            }
        }
    }

注意：这里的名称是在Jenkins中系统管理--sonarqube servers添加的名称
同样的，设置好job后就可以构建进行代码扫描了。

5. 接入Sonar质量门禁

通过上面的job，只是代码扫描可能无法满足日常的情况，当扫描的结构不满足时我可能就不进行后面的步骤了，这样的情况，我们就需要接入质量门禁的方式来实现。

5.1 在sonar服务端的质量阀中设置质量门禁，添加要运用的项目

质量配置->质量阀

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

这里可以添加指标来定义通过扫描的条件。然后将设置的质量阀分配给要扫描的项目。

5.2 在sonar服务端的配置里面添加网络调用hook

配置->网络调用

超详细，自动化测试接入Jenkins+Sonar质量门禁实践-LMLPHP

这里添加Jenkins调用的地址，用来回调扫描的结果。URL配置为：Jenkins地址+/sonarqube-webhook

5.3 流水线改造

pipeline {
    agent any

    stages {
        stage('拉取代码') {
            steps {
                git credentialsId: 'gitee', url: 'https://gitee.com/dx0001/work.git'
            }
        }
        stage('静态代码静态扫描') {
            steps {
                withSonarQubeEnv('sonarqube'){
                    bat "sonar-scanner"
                }
            }
        }
        stage('检查结果分析') {
            steps {
                script{
                    timeout(5){
                        def qg=waitForQualityGate()
                        echo "结果状态：${qg.status}"
                        if(qg.status!='OK')
                            error '未达到代码门禁要求！'
                    }
                }
            }
        }
    }
}

在上面的流水线的job上增加一个“检查结果分析”的步骤，使用waitForQualityDate()的方法来获取扫描是否通过质量阀的状态值。最后使用if条件来判断，不通过时则使用“error”来中断流程，实现质量门禁的功能。

6. 小结

此次分享就到这里了，更多的是自我知识沉淀的过程，第一阶段的学习虽已结束，但对于我更多的是开始，很多的知识需要自己动手搭环境来实践，我很享受这个过程。将一个个知识落实，弄清楚，是一件令我非常高兴的事情。接触并学习更多测试开发的知识，在测试的道路上越走越宽，越走越远，为此，奋力前进！

狂师