使用Docker+Jenkins+SonarQube实现自动化检测Groovy代码质量

「爱情、让人受尽委屈。」 2022-03-07 16:18 471阅读 0赞

### 文章目录 ###

*   *  前提
     *  安装SonarQube
     *  Groovy插件
     *  配置Jenkins
     *   *  配置groovy项目
     *  新建jenkins项目

## 前提 ##

不知道怎么装Docker还有Jenkins的同学可以参考我前面的博文：[使用Jenkins+Pipeline+Docker将Spring Boot应用部署到Tomcat][Jenkins_Pipeline_Docker_Spring Boot_Tomcat]，本文的关注点在于集成SonarQube，以及对项目中的**Groovy**代码进行质量检测，因为我们做的这个项目是使用Groovy开发的。。所以在集成SonarQube的时候遇到了一些问题，所以在这里做一下记录。。而且最好把你们的虚拟机的配置调高点，不然可能启动docker的时候会很慢很卡。。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 1]  
提供一些参考资料：  
[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://blog.csdn.net/u010697874/article/details/51859823][https_blog.csdn.net_u010697874_article_details_51859823]  
[https://blog.csdn.net/qq\_23589557/article/details/60141576][https_blog.csdn.net_qq_23589557_article_details_60141576]  
[https://github.com/groovy/GMavenPlus/wiki/Examples][https_github.com_groovy_GMavenPlus_wiki_Examples]  
[https://www.linuxea.com/1755.html][https_www.linuxea.com_1755.html]  
[https://www.jianshu.com/p/aaa33bac5e2e][https_www.jianshu.com_p_aaa33bac5e2e]

## 安装SonarQube ##

因为我这里项目中用的是Groovy，所以这里只针对于Groovy项目的操作。  
所以在弄Groovy项目的时候，安装的SonarQube的版本也是有要求的，sonarqube的版本要在7.3以下，6.7以上。好像是因为插件的问题不兼容还是其他的原因。  
在安装groovy的插件sonar-groovy-plugin-1.5.jar，之后启动的时候SonarQube Scanner会报如下错误：

ERROR: Error during SonarQube Scanner execution ERROR: org.sonar.plugins.groovy.codenarc.CodeNarcSensor has unsatisfied dependency 'class org.sonar.plugins.groovy.foundation.GroovyFileSystem' for constructor 'public org.sonar.plugins.groovy.codenarc.CodeNarcSensor(org.sonar.api.profiles.RulesProfile,org.sonar.plugins.groovy.foundation.GroovyFileSystem)' from org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@55b62629:110<[Immutable]:org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@64ec96c6:465<[Immutable]:org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@7af52ec7:52<|

所以我这里直接找了一个6.7的版本

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 2]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 3]

下载完成之后就可以进去sonarqube的页面，然后登陆  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 4]

用户名和密码都是admin  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 5]

## Groovy插件 ##

需要sonar-groovy-plugin-1.5.jar，可以去我的资源页上去下载https://download.csdn.net/download/cckevincyh/11029030

把下载的插件放到与windows关联的共享文件夹下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 6]

然后进入sonar的docker里面。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 7]

然后把我们的插件拷贝到sonar的插件目录下。

![在这里插入图片描述][20190317151024537.png]

复制到/opt/sonarqube/extenstions/plugins目录下，然后重启sonar。

重启完成之后进入到sonar的页面，如果看到如下界面，说明groovy插件已经集成进去了。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 8]

然后我们还需要在sonarqube里面生成一个token。。一会在集成到jenkins需要。。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 9]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 10]

## 配置Jenkins ##

下载sonarqube-scanner插件。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 11]

然后配置sonarqube-scanner  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 12]

配置你sonarqube的服务器URL地址，还有token  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 13]

### 配置groovy项目 ###

在pom.xml中需要加入jacoco的插件

<plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <executions>
              <execution>
                <id>pre-test</id>
                <goals>
                  <goal>prepare-agent</goal>
                </goals>
              </execution>
              <execution>
                <id>post-test</id>
                <phase>test</phase>
                <goals>
                  <goal>report</goal>
                </goals>
              </execution>
            </executions>
          </plugin>

还有groovy的maven插件

<plugin>
            <groupId>org.codehaus.gmavenplus</groupId>
            <artifactId>gmavenplus-plugin</artifactId>
            <version>1.5</version>
            <executions>
              <execution>
                <goals>
                  <goal>addSources</goal>
                  <goal>addTestSources</goal>
                  <goal>generateStubs</goal>
                  <goal>compile</goal>
                  <goal>testGenerateStubs</goal>
                  <goal>testCompile</goal>
                  <goal>removeStubs</goal>
                  <goal>removeTestStubs</goal>
                </goals>
              </execution>
            </executions>
          </plugin>

还有加入jacoco的依赖

<dependency>
          <groupId>org.jacoco</groupId>
          <artifactId>org.jacoco.agent</artifactId>
          <classifier>runtime</classifier>
          <version>0.7.9</version>
          <scope>test</scope>
        </dependency>

之后需要在项目的根路径加上sonar的配置文件。  
需要指定sonar.host.url，也就是sonarqube服务器的url。  
注意sonar.**groovy**.binaries=./target/classes这里的是.groovy

sonar.host.url=http://192.168.99.100:32817
    sonar.projectKey=gallery-server
    sonar.projectName=gallery-server
    sonar.projectVersion=1.0
    sonar.sources=./src/main/groovy
    sonar.sourceEncoding=UTF-8
    sonar.groovy.binaries=./target/classes
    sonar.tests=./src/test/groovy
    sonar.dynamicAnalysis=reuseReports
    sonar.groovy.coveragePlugin=jacoco
    sonar.junit.reportsPath=target/surefire-reports
    sonar.surefire.reportsPath=target/surefire-reports
    sonar.exclusions=**/com/cc/gallery/security/**/*.groovy,**/com/cc/gallery/api_versions/**/*.groovy,**/com/cc/gallery/**/*Exception.groovy,**/com/cc/gallery/GalleryApplication.groovy

## 新建jenkins项目 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 14]

我们需要指定一下之前创建的pipline项目构建好之后运行，可以参考我上一篇博文。。

进来只会点击高级按钮，配置一下自定义的工作空间  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 15]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 16]  
配置一下触发条件  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 17]  
配置sonarqube scanner  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 18]  
配置上我们项目构建好的路径  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 19]

这里说需要我们全局工具上设置一下sonarqube，然后我们在这里配一下。![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 20]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 21]

保存ok了。

只会构建一下gallery-server项目，构建玩galler-server项目就会自动跑sonarqube了。。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 22]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 23]

但是目前还存在一个问题就是测试完发现代码结尾最后的括号\}没有覆盖到。。很奇怪，希望有大神给出解决方案。。

![在这里插入图片描述][20190317174559128.png]

[Jenkins_Pipeline_Docker_Spring Boot_Tomcat]: https://blog.csdn.net/cckevincyh/article/details/88584238
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70]: /images/20220307/df9c8eec92bd46dd860abfd095f0ef93.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 1]: /images/20220307/0584e68e15a74b15881ee2a07fcc4b8b.png
[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_blog.csdn.net_u010697874_article_details_51859823]: https://blog.csdn.net/u010697874/article/details/51859823
[https_blog.csdn.net_qq_23589557_article_details_60141576]: https://blog.csdn.net/qq_23589557/article/details/60141576
[https_github.com_groovy_GMavenPlus_wiki_Examples]: https://github.com/groovy/GMavenPlus/wiki/Examples
[https_www.linuxea.com_1755.html]: https://www.linuxea.com/1755.html
[https_www.jianshu.com_p_aaa33bac5e2e]: https://www.jianshu.com/p/aaa33bac5e2e
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 2]: /images/20220307/ad199151eb784f2e8c9a3936c7e6529c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 3]: /images/20220307/ac4943f12cf54436a476c0c619c405b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 4]: /images/20220307/7ae0ff7b2f0b463eb8f4dd72ecb54e8e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 5]: /images/20220307/d062dab78cb2450e9a725f7ca551b12c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 6]: /images/20220307/76b634b814f641888df71cc484a3ca66.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 7]: /images/20220307/c71bc5cf4fcc4c578091ab8bcddbda91.png
[20190317151024537.png]: /images/20220307/be9b08e8f5fd4e09b5b32810308b1381.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 8]: /images/20220307/e8ffe6bcd74b4dd6a7c6393beb805d39.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 9]: /images/20220307/e0846265bf9d4e599736b5697ef6e3ba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 10]: /images/20220307/27dfd6cc6c2b4541a7066ddd1b8f83ed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 11]: /images/20220307/ed0d830182df49aab194988e879aa38a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 12]: /images/20220307/f2263629811a40dd8d6a8e0c66182424.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 13]: /images/20220307/737c42f2cfb840038d7efe8594120a78.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 14]: /images/20220307/32da908e990f405e93a19d5986f608fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 15]: /images/20220307/5a1c56622cf54fc0a9a7ed969dc59541.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 16]: /images/20220307/5b2d10144cb6461cb77417b7b0f78494.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 17]: /images/20220307/f45e4c73789247a9a295c9606ee839f5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 18]: /images/20220307/fd46e384bd314acfbc20de562adeb6a9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 19]: /images/20220307/426f64f8a88a42c1bc7e69a1f0ad0746.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 20]: /images/20220307/40c22d6e27624ad19f3a34896e489173.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 21]: /images/20220307/5f51c92a26ce4febbb95bcaa26bd7fa2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 22]: /images/20220307/dd12720dcfd7469090b6ac760e98b946.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 23]: /images/20220307/24349373fcf1409c9f894e97b2c5f163.png
[20190317174559128.png]: /images/20220307/7415528564ec4213a9a6f7e8c9722f4e.png