博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Jenkins集成SonarQube 实现构建项目同时审查代码
阅读量:7063 次
发布时间:2019-06-28

本文共 2312 字,大约阅读时间需要 7 分钟。

hot3.png

软件版本:

     SonarQube:7.7    

     Jenkins:2.164.3

 

一、简介

     SonarQube是一个开源的代码质量分析平台,便于管理代码的质量,可检查出项目代码的漏洞和潜在的逻辑问题。同时,它提供了丰富的插件,支持多种语言的检测, 如 Java、Python、Groovy、C#、C、C++等几十种编程语言的检测。

    核心价值观:

  • 检查代码是否遵循编程标准:如命名规范,编写的规范等。

  • 检查设计存在的潜在缺陷:SonarQube通过插件Findbugs、Checkstyle等工具检测代码存在的缺陷。

  • 检测代码的重复代码量:SonarQube可以展示项目中存在大量复制粘贴的代码。

  • 检测代码中注释的程度:源码注释过多或者太少都不好,影响程序的可读可理解性。

  • 检测代码中包、类之间的关系:分析类之间的关系是否合理,复杂度情况。

 

SonarQube主要由4个组件组成:

 

  1. 一个SonarQube服务器启动3个主要流程:

    • Web服务器,供开发人员,管理人员浏览高质量快照并配置SonarQube实例
    • 基于Elasticsearch的Search Server从UI返回搜索
    • 计算引擎服务器负责处理代码分析报告并将其保存在SonarQube数据库中
  2. 一个SonarQube数据库存储:

    • SonarQube实例的配置(安全性,插件设置等)
    • 项目,视图等的质量快照
  3. 服务器上安装了多个SonarQube插件,可能包括语言,SCM,集成,身份验证和治理插件
  4. 在构建/持续集成服务器上运行一个或多个SonarScanner来分析项目

SonarQube工作流程:

 

二、安装步骤

      好了,讲了一堆概念开始进入正题了。

     1.安装jenkins

       没有安装jenkins的可以参考之前的文章。

     2.安装SonarQube

        本文为了方便测试使用Docker安装SonarQube。

        运行SonarQube:

docker run -d --name sonarqube -p 9000:9000 sonarqube

      启动后默认登录账号为admin/admin。

 

      默认情况下,镜像将使用不适合生产的嵌入式H2数据库。如需要设置数据库请参考如下设置。

      生产数据库被配置成与作为环境变量以下SonarQube属性:sonar.jdbc.usernamesonar.jdbc.passwordsonar.jdbc.url

$ docker run -d --name sonarqube \    -p 9000:9000 \    -e sonar.jdbc.username=sonar \    -e sonar.jdbc.password=sonar \    -e sonar.jdbc.url=jdbc:postgresql://localhost/sonar \    sonarqube

 

       更多高级设置可以参考文档:

     3.启动SonarQube:

81ff5011c2fd411a1cb590246dfc8d0757c.jpg

 

       安装chiese Pack中文插件,安装完记得点击页面上的Restart重启SonarQube。

        然后重要的事情来了,就是配置质量阀。像我们只想针对新提交的代码进行审计,故定制如下质量阀指标:

e71ee1ef98701b9e6f4fdee15c6751dc31f.jpg

 

          好了,到此基本配置完了。下面开始集成Jenkins

     4.集成Jenkins

         因为我们是用Jenkins做为后台的持续扫描调度服务,所以需要安装SonarQube Scanner For Jenkins插件,也就不需要安装其他的扫描器了。

e001a6a39e91ed1903cc49219318278bfb0.jpg

          在Jenkins系统设置->配置SonarQube服务器连接详细信息。

 d7e5ccb36025a9a771e80b61d6de4cdd468.jpg

 

4d227dc7d6b51f7a0d18f29fb6549a6fc2d.jpg

 

             构建项目:

    907cb537a9a4dc05d7ebc8308334ea00838.jpg

sonar.projectKey=tembin_loan_testsonar.projectName=tembin_loan_testsonar.projectVersion=1.0sonar.exclusions=*-ui/**sonar.language=javasonar.java.source=1.8sonar.sourceEncoding=UTF-8sonar.sources=$WORKSPACEsonar.java.binaries=$WORKSPACE

 

b579090feb2e4c862b0450019fd65960a37.jpg

 

                打开构建结果的链接来查看SonarQube具体的分析报告。

53deb3d97caf8b113cfd3529bdfc1796742.jpg

 

      5.质量阀状态关联构建结果

         

             我们需要在代码分析无法满足SonarQube的质量标准时,就项目构建失败。Jenkins是支持这样的,需要安装插件

      4657dd63b7b549a3ccc48a011840b6a2b18.jpg

            同时在系统设置->配置Quality Gates - Sonarqube。

           a736ebab70844c3f4f34bd0568c03edddfd.jpg

 

          然后,在项目工程中需要增加“构建后操作“。

8672f094859b1b5fa76aa4985fdf9547f6f.jpg

    

cea6ca2297e99d25aa65ebfb7763544edbb.jpg

 

aa16794c614c58fbd09d438eb9c85d9173f.jpg

 

 

   6.邮件通知commiter

            项目构建失败时,邮件通知提交代码的人。jenkins默认集成了一个挺好用的邮件插件Extended E-mail Notification。

            先进行全局设置,初始配置时建议勾选debug和watch,方便查看邮件是否发送成功。如下图

abb4aa3ba94bbdca1d8407c9d56a32284b5.jpg

ceb05fe2fd19b90a094114e973cec358f58.jpg

 

  项目配置邮件插件:

  972eec5b0b4b16dd0b4b5229f05df1dff48.jpg

 

选择右下角高级设置

 a69602e8f115db1083964177371d82376ef.jpg

 

三、整合阿里Java开发规范(p3c-pmd)

sonar-pmd 3.2.0-SNAPSHOT 集成p3c-pmd 1.3.4-pmd6.10.0

 

编译好的插件地址:

提取码:9a4i 

把sonar-pmd-plugin-3.2.0-SNAPSHOT.jar 更新到sonarqube服务器上sonarqube-7.7/extensions/plugins/sonar-pmd-plugin-3.2.0-SNAPSHOT.jar

更新后启动sonarqube

 

 

四、参考资料 

       

       

转载于:https://my.oschina.net/u/2963821/blog/3051006

你可能感兴趣的文章
oracle check if the display variable is set
查看>>
一键部署Openstack R版
查看>>
《JAVA——帮你解决高并发秒杀》
查看>>
国家级期刊发表要求注意事项
查看>>
C文件操作
查看>>
观察转小写的操作-字符函数
查看>>
Oracle查询访问同一表的两个以上索引(二)
查看>>
office 2016 下载地址
查看>>
Go语言之调试
查看>>
Go语言之 unsafe 包之内存布局
查看>>
Spring Cloud Config 入门
查看>>
rhce第二天笔记
查看>>
oneproxy中间件架构及注意事项
查看>>
phpweb解析不当加上传漏洞
查看>>
CentOS自动挂载NTFS分区的U盘或者移动硬盘
查看>>
2018-2019-1 20165226 20165310 20165315 实验二 固件程序设计
查看>>
安装windows后grub的恢复
查看>>
android学习总结(20120721)
查看>>
【吾日三省吾身】2015.6.13-涅槃行动第二十六天
查看>>
Java实现二分插入排序
查看>>