Jenkins集成SonarQube 实现构建项目同时审查代码


    一、简介

     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的可以参考之前的文章。Linux -- 集成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

 

       更多高级设置可以参考文档:Docker安装SonarQube

     3.启动SonarQube:

 

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

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

 

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

     4.集成Jenkins

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

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

 

 

 

             构建项目:

    

 

 

 

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

 

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

         

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

      

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

           

 

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

    

 

三、参考资料

       SonarQube官方文档

       SonarQube插件下载地址

本文发表于2019年05月17日 18:00
(c)注:本文转载自https://my.oschina.net/u/2963821/blog/3051006,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。如有侵权行为,请联系我们,我们会及时删除.

阅读 40 讨论 0 喜欢 0

讨论

周娱

君子和而不同
按照自己的方式,去度过人生

6409 2086618
抢先体验

扫码体验
趣味小程序
文字表情生成器

加入组织

扫码添加周娱微信
备注“加入组织”
邀请进开发群

闪念胶囊

这个世界上,别人只会看你现在的样子而不是以后的样子。你以后的样子只有自己才相信。如果没有执行力,一切都是虚妄。

对普通人来说,人和人相处其实最重要的是感觉。感觉不好,你说什么都没用,怎么解释都没用,越说越错,反正最后不好的锅都往你身上扣。所谓“说你行你就行,不行也行。说你不行,你就不行,行也不行”就是这个意思。狼要吃人根本不需要理由,你也同样叫不醒装睡的人。遇到这种情况,早点闪人才是上策。不过大部分人的问题是没有闪人的心态,能力,和资源。

考985不牛逼,考上才牛逼。创业不牛逼,创业成功才牛逼。这个社会上很多人把目标当成牛逼的资本,牛逼哄哄的,死活不听劝,然后做的一塌糊涂,给别人添麻烦,让别人帮他料理后事,对此只能呵呵。

当你尝到用生气解决问题的甜头后,你就懒得再用其他方式了。你却忽略了,生气是鸩毒啊,剂量用够了,你的关系也玩完了。

年轻的时候你只搞事业不谈恋爱,等你事业有成了,钱相对自由了,你可能已经没有荷尔蒙了。

如果你经常雇佣比你矮小的人,将来我们就会变成矮人国,变成一家侏儒公司。相反,如果你每次都雇用比你高大的人,日后我们必能成为一家巨人公司。

如果一个人有充裕的时间去完成一项工作,那么他就会放慢节奏或者增加其他不必要的工作,直到花光所有的时间。

天空不是人类休息的地方,人类应该去亲近海洋。

一个人的正直程度,取决于他肯为原则付出的牺牲。

Copyright © 2016 - 2018 Cion.
All Rights Reserved.
备案:鲁ICP备16007319号.