使用Jenkins流水线集成SonarQube做代码质量分析

分手后的思念是犯贱 2022-01-26 23:51 813阅读 0赞

### 文章目录 ###

*  使用Jenkins集成SonarQube做代码质量分析
 *   *  前置条件
     *  安装SonarQube
     *  生成SonarQube token
     *  在Jenkins上配置SonarQube token
     *  本地Maven项目运行SonarQube扫描
     *  在Jenkins freestyle job中使用SonarQube Maven插件
     *   *  方法1: 在\`mvn sonar:sonar\`中指定SonarQube Server配置
         *  方法2: 在Jenkins job中使用加密变量
         *  方法3: 在Maven pom.xml中指定SonarQube Server配置
     *  在Jenkins上安装SonarScanner插件
     *  在Jenkins上配置SonarQube server
     *  在Jenkins流水线中使用SonarQube做代码质量检查
     *   *  普通Jenkins流水线
         *  Jenkins in Kubernetes流水线
     *  参考文档

# 使用Jenkins集成SonarQube做代码质量分析 #

## 前置条件 ##

*  已安装Jenkins

如果还没有安装Jenkins请参见：

*  [CentOS7安装Jenkins][CentOS7_Jenkins]

## 安装SonarQube ##

参见：

*  [使用Docker Compose在线安装SonarQube][Docker Compose_SonarQube]

## 生成SonarQube token ##

使用`admin`账号登录SonarQube，打开My account，找到Tokens

在Generate New Token中输入一个token名称，比如`sonarqube`，点击Generate按钮生成SonarQube token。

复制并保存生成的Token（只复制`:`后面的Hash值），后续在Jenkins上配置指向SonarQube将会用到这个Token。

## 在Jenkins上配置SonarQube token ##

在Jenkins上，打开Credentials，添加一个Global的Credential，选择Credential类型为Secret text。

输入Secret为上面生成的SonarQube token

输入一个有意义的ID，比如`sonarqube`

输入一个有意义的描述

## 本地Maven项目运行SonarQube扫描 ##

示例：

mvn sonar:sonar \
      -s settings.xml \
      -Dsonar.host.url=http://192.168.87.154:9000 \
      -Dsonar.login=7c4b5baf2e96a565d27fe062c11baa05b5eb2f2a

参见：

*  [https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-maven/][https_docs.sonarqube.org_latest_analysis_scan_sonarscanner-for-maven]

## 在Jenkins freestyle job中使用SonarQube Maven插件 ##

### 方法1: 在`mvn sonar:sonar`中指定SonarQube Server配置 ###

参见上面的本地Maven项目运行SonarQube扫描

### 方法2: 在Jenkins job中使用加密变量 ###

在Jenkins job的Build Environment中勾选“Use Secret text(s) or file(s)”，然后在下方添加一个Secret Text的Binding，填写Variable为`SONAR_LOGIN`，选择之前在Jenkins上配置好的SonarQube的Token。

在Jenkins job的Execute Shell中运行Maven命令：

mvn clean verify sonar:sonar -Dsonar.host.url=http://192.168.87.154:9000 -Dsonar.login=${SONAR_LOGIN} -s settings.xml -U -B

参见：

*  [https://support.cloudbees.com/hc/en-us/articles/203802500-Injecting-Secrets-into-Jenkins-Build-Jobs][https_support.cloudbees.com_hc_en-us_articles_203802500-Injecting-Secrets-into-Jenkins-Build-Jobs]
 *  [https://stackoverflow.com/questions/34815482/accessing-credentials-in-jenkins-with-the-credentials-parameter-plugin][https_stackoverflow.com_questions_34815482_accessing-credentials-in-jenkins-with-the-credentials-parameter-plugin]

### 方法3: 在Maven pom.xml中指定SonarQube Server配置 ###

在`pom.xml`中配置SonarQube Server信息：

在Jenkins freestyle job中通过Execute shell执行Maven命令：

mvn sonar:sonar

> 这种方法会导致SonarQube Server的配置和项目代码耦合在一起，不推荐。

可选在`pom.xml`中指定SonarQube Maven插件的版本号:

<plugin>
        <groupId>org.sonarsource.scanner.maven</groupId>
        <artifactId>sonar-maven-plugin</artifactId>
        <version>3.6.0.1398</version>
    </plugin>

## 在Jenkins上安装SonarScanner插件 ##

在Jenkins上安装[SonarScanner][]插件，参见：

*  [http://redirect.sonarsource.com/plugins/jenkins.html][http_redirect.sonarsource.com_plugins_jenkins.html]

如果只能离线安装Jenkins插件，参见：

*  [没有外网安装Jenkins插件][Jenkins]

## 在Jenkins上配置SonarQube server ##

在Jenkins上，打开Manage Jenkins / Configure System，找到SonarQube servers

点击“Add SonarQube”

勾选" Enable injection of SonarQube server configuration as build environment variables"

输入SonarQube server名称，比如 `sonarqube`

输入Server URL，比如 `http://sonarqube_server_ip:9000`

选择上面配置的SonarQube token

## 在Jenkins流水线中使用SonarQube做代码质量检查 ##

下面给出的Jenkins流水线例子是用SonarQube的Maven插件的例子。

如果是用SonarScanner或SonarQube的Gradle插件的例子，参见：

*  [https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Jenkins][https_docs.sonarqube.org_display_SCAN_Analyzing_with_SonarQube_Scanner_for_Jenkins]

### 普通Jenkins流水线 ###

def projectName = "demo"
    
    stage('Code Analysis') { 
        withSonarQubeEnv('sonarqube') { 
            sh "mvn sonar:sonar -Dsonar.projectKey=${projectName} -Dsonar.projectName=${projectName} -D=sonar.java.coveragePlugin=jacoco -D=sonar.junit.reportsPath=target/surefire-reports -Dsonar.surefire.reportsPath=target/surefire-reports -Dsonar.analysis.mode="
        }
    }

说明：

*  使用`withSonarQubeEnv`来使用上面在Jenkins上配置SonarQube server的信息，不用再指定`sonar.host.url`和`sonar.login`
 *  `mvn sonar:sonar`后可以添加代码质量分析的参数，分析参数说明参见：
    
    [https://docs.sonarqube.org/latest/analysis/analysis-parameters/][https_docs.sonarqube.org_latest_analysis_analysis-parameters]

上面的流水线例子中`mvn sonar:sonar`跟着很多代码质量分析参数，为了简化命令，也可以将这些分析参数保存在**项目根目录**下的一个`sonar-project.properties`文件中，再在流水线中传入这个配置文件：

stage('Code Analysis') { 
       withSonarQubeEnv('sonarqube') { 
           sh "mvn sonar:sonar -Dproject.settings=sonar-project.properties"
       }
    }

`sonar-project.properties`文件示例：

sonar.projectKey=demo
    
    sonar.sourceEncoding=UTF-8
    sonar.sources=src/main
    sonar.tests=src/test/java
    sonar.java.binaries=target/classes
    
    sonar.exclusions=
    
    sonar.java.coveragePlugin=jacoco
    sonar.jacoco.itReportPath=jacoco.exec
    sonar.junit.reportsPath=target/surefire-reports
    sonar.surefire.reportsPath=target/surefire-reports

### Jenkins in Kubernetes流水线 ###

stage('Code Analysis') { 
        container("maven") { 
            withSonarQubeEnv('sonarqube') { 
                sh "mvn sonar:sonar -Dproject.settings=sonar-project.properties"
            }
        }
    }

和上面的普通Jenkins流水线类似，不同的地方是要在`maven`容器中运行`mvn sonar:sonar`命令。

Jenkins in Kubernetes流水线的相关介绍，参见：

*  [Jenkins in Kubernetes 在Kubernetes上动态运行Jenkins build agent][Jenkins in Kubernetes _Kubernetes_Jenkins build agent]

## 参考文档 ##

*  [https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Jenkins][https_docs.sonarqube.org_display_SCAN_Analyzing_with_SonarQube_Scanner_for_Jenkins]
 *  [https://jenkins.io/doc/pipeline/steps/sonar/][https_jenkins.io_doc_pipeline_steps_sonar]
 *  [https://github.com/SonarSource/sonar-scanning-examples/blob/master/sonarqube-scanner/sonar-project.properties][https_github.com_SonarSource_sonar-scanning-examples_blob_master_sonarqube-scanner_sonar-project.properties]
 *  [https://blog.csdn.net/flysqrlboy/article/details/80525727][https_blog.csdn.net_flysqrlboy_article_details_80525727]

[CentOS7_Jenkins]: https://blog.csdn.net/nklinsirui/article/details/89382092
[Docker Compose_SonarQube]: https://blog.csdn.net/nklinsirui/article/details/90405159
[https_docs.sonarqube.org_latest_analysis_scan_sonarscanner-for-maven]: https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-maven/
[https_support.cloudbees.com_hc_en-us_articles_203802500-Injecting-Secrets-into-Jenkins-Build-Jobs]: https://support.cloudbees.com/hc/en-us/articles/203802500-Injecting-Secrets-into-Jenkins-Build-Jobs
[https_stackoverflow.com_questions_34815482_accessing-credentials-in-jenkins-with-the-credentials-parameter-plugin]: https://stackoverflow.com/questions/34815482/accessing-credentials-in-jenkins-with-the-credentials-parameter-plugin
[SonarScanner]: https://plugins.jenkins.io/sonar
[http_redirect.sonarsource.com_plugins_jenkins.html]: http://redirect.sonarsource.com/plugins/jenkins.html
[Jenkins]: https://blog.csdn.net/nklinsirui/article/details/90407734
[https_docs.sonarqube.org_display_SCAN_Analyzing_with_SonarQube_Scanner_for_Jenkins]: https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Jenkins
[https_docs.sonarqube.org_latest_analysis_analysis-parameters]: https://docs.sonarqube.org/latest/analysis/analysis-parameters/
[Jenkins in Kubernetes _Kubernetes_Jenkins build agent]: https://blog.csdn.net/nklinsirui/article/details/90403311
[https_jenkins.io_doc_pipeline_steps_sonar]: https://jenkins.io/doc/pipeline/steps/sonar/
[https_github.com_SonarSource_sonar-scanning-examples_blob_master_sonarqube-scanner_sonar-project.properties]: https://github.com/SonarSource/sonar-scanning-examples/blob/master/sonarqube-scanner/sonar-project.properties
[https_blog.csdn.net_flysqrlboy_article_details_80525727]: https://blog.csdn.net/flysqrlboy/article/details/80525727