持续集成之代码质量管理-Sonar

原文:http://blog.csdn.net/abcdocker/article/details/53840582

Sonar介绍

  Sonar 是一个用于代码质量管理的开放平台。经过插件机制,Sonar 能够集成不一样的测试工具,代码分析工具,以及持续集成工具。与持续集成工具(例如 Hudson/Jenkins 等)不一样,Sonar 并非简单地把不一样的代码检查工具结果(例如 FindBugs,PMD 等)直接显示在 Web 页面上,而是经过不一样的插件对这些结果进行再加工处理,经过量化的方式度量代码质量的变化,从而能够方便地对不一样规模和种类的工程进行代码质量管理。 
  在对其余工具的支持方面,Sonar 不只提供了对 IDE 的支持,能够在 Eclipse和 IntelliJ IDEA 这些工具里联机查看结果;同时 Sonar 还对大量的持续集成工具提供了接口支持,能够很方便地在持续集成中使用 Sonar。 
  此外,Sonar 的插件还能够对 Java 之外的其余编程语言提供支持,对国际化以及报告文档化也有良好的支持。javascript

Sonar部署

  Sonar的相关下载和文档能够在下面的连接中找到:http://www.sonarqube.org/downloads/。须要注意最新版的Sonar须要至少JDK 1.8及以上版本。php

 上篇文章咱们已经能够成功的使用Git进行拉去,Sonar的功能就是来检查代码是否有BUG。除了检查代码是否有bug还有其余的功能,好比说:你的代码注释率是多少,代码有一些建议,编写语法的建议。因此咱们叫质量管理java

Sonar还能够给代码打分,而且引用了技术宅的功能(告诉你有不少地方没改)node

Sonar部署python

[root@linux-node1 ~]# yum install -y java-1.8.0 [root@linux-node1 ~]# cd /usr/local/src 软件包咱们经过wget或者下载,rz上传到服务器 #软件包下载:https://sonarsource.bintray.com/Distribution/sonarqube/sonarqube-5.6.zip [root@linux-node1 src]# unzip sonarqube-5.6.zip [root@linux-node1 src]# mv sonarqube-5.6 /usr/local/ [root@linux-node1 src]# ln -s /usr/local/sonarqube-5.6/ /usr/local/sonarqube

准备Sonar数据库 
若是没有数据库请执行yum install -y mariadb mariadb-servermysql

[root@linux-node1 ~]# systemctl start mariadb [root@linux-node1 ~]# systemctl enable mariadb Created symlink from /etc/systemd/system/multi-user.target.wants/mariadb.service to /usr/lib/systemd/system/mariadb.service. [root@linux-node1 ~]# mysql_secure_installation [root@linux-node1 ~]# mysql -uroot -p123456

特别提示: 
image_1b4i40r9q13m916p9jqke68au39.png-106.4kBlinux

sonar好像不支持MySQL 5.5,因此若是看日志出现以上error 请安装mysql5.6 或者更高版本 
http://blog.csdn.net/onothing12345/article/details/49910087nginx

执行sql语句git

mysql> CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci; mysql> GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar@pw'; mysql> GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar@pw'; mysql> FLUSH PRIVILEGES;

配置Sonargithub

[root@linux-node1 ~]# cd /usr/local/sonarqube/conf/ [root@linux-node1 conf]# ls sonar.properties wrapper.conf

编写配置文件,修改数据库配置

[root@linux-node1 conf]# vim sonar.properties #咱们只须要去配置文件里面修改数据库的认证便可 14 sonar.jdbc.username=sonar #数据库用户 15 sonar.jdbc.password=sonar@pw #数据库密码 23 sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&character Encoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance

 

配置Java访问数据库驱动(可选) 
  默认状况Sonar有自带的嵌入的数据库,那么你若是使用类是Oracle数据库,必须手动复制驱动类到${SONAR_HOME}/extensions/jdbc-driver/oracle/目录下,其它支持的数据库默认提供了驱动。其它数据库的配置能够参考官方文档: 
http://docs.sonarqube.org/display/HOME/SonarQube+Platform

启动Sonar 
  你能够在Sonar的配置文件来配置Sonar Web监听的IP地址和端口,默认是9000端口。

[root@linux-node1 conf]# vim sonar.properties 99 #sonar.web.host=0.0.0.0 106 #sonar.web.port=9000

启动命令以下:

[root@linux-node1 ~]# /usr/local/sonarqube/bin/linux-x86-64/sonar.sh start Starting SonarQube... Started SonarQube.

若是有什么问题能够看一下日志[/usr/local/sonarqube/logs/sonar.log]

检查是否有相应的端口

[root@linux-node1 ~]# netstat -lntup Active Internet connections (only servers) Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name tcp 0 0 127.0.0.1:8080 0.0.0.0:* LISTEN 2239/unicorn master tcp 0 0 0.0.0.0:80 0.0.0.0:* LISTEN 505/nginx: master p tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN 569/sshd tcp 0 0 127.0.0.1:25 0.0.0.0:* LISTEN 971/master tcp 0 0 127.0.0.1:43163 0.0.0.0:* LISTEN 5205/java tcp 0 0 0.0.0.0:8060 0.0.0.0:* LISTEN 505/nginx: master p tcp 0 0 127.0.0.1:32000 0.0.0.0:* LISTEN 4925/java tcp 0 0 0.0.0.0:43044 0.0.0.0:* LISTEN 4952/java tcp 0 0 0.0.0.0:33350 0.0.0.0:* LISTEN 5205/java tcp 0 0 0.0.0.0:9000 0.0.0.0:* LISTEN 5011/java tcp 0 0 0.0.0.0:33385 0.0.0.0:* LISTEN 5011/java tcp 0 0 127.0.0.1:9001 0.0.0.0:* LISTEN 4952/java tcp6 0 0 :::3306 :::* LISTEN 4658/mysqld tcp6 0 0 :::34993 :::* LISTEN 2348/java tcp6 0 0 :::8081 :::* LISTEN 2348/java tcp6 0 0 :::22 :::* LISTEN 569/sshd tcp6 0 0 ::1:25 :::* LISTEN 971/master udp6 0 0 :::33848 :::* 2348/java udp6 0 0 :::5353 :::* 2348/java

#端口是9000哦!

Web登录:IP:9000 
image_1b4i4e3gkdp51k4t1poe16ul1ec4m.png-113.5kB

提示: 
sonar跟jenkins相似,也是以插件为主 
sonar安装插件有2种方式:第一种将插件下载完存放在sonar的插件目录,第二种使用web界面来使用安装 
存放插件路径[/usr/local/sonarqube/extensions/plugins/]

安装中文插件 
登录:用户名:admin 密码:admin 
image_1b4i53iocg3i1npe1kfb1u6dti413.png-85.8kB 
image_1b4i53qtans06132qg1go31pmj1g.png-80.5kB 
image_1b4i540lu22s1rmr1j6jf6e1b6u1t.png-48.2kB 
image_1b4i546qf3mjfnk1i7b1rloo642a.png-51.5kB 
须要重启才会生效

生效后以下图: 
image_1b4i56q1okim5d8l6mh2nflp34.png-109.5kB

咱们在安装一个PHP语言 
image_1b4i54ot26j61hcme15t213ue2n.png-49.9kB

舒适提示:若是下载不下来咱们直接去github进行下载,由于咱们这个插件都是使用wget进行下载的 
image_1b4i596mfft08f01nu01t1uqkv3h.png-88.9kB 
咱们如今只能使用java的jar包和php,由于咱们只安装了java和php的语言插件。若是想使用Python的程序,就须要安装Python的语言插件

Sonar 插件--->语言插件 (分析什么语言,你就须要安装什么语言的插件)

Sonar经过SonarQube Scanner(扫描器)来对代码进行分析 
官方文档:http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner

下载扫描器插件

[root@linux-node1 ~]# wget https://sonarsource.bintray.com/Distribution/sonar-scanner-cli/sonar-scanner-2.8.zip [root@linux-node1 ~]# unzip sonar-scanner-2.8.zip [root@linux-node1 ~]# mv sonar-scanner-2.8 /usr/local/ [root@linux-node1 ~]# ln -s /usr/local/sonar-scanner-2.8/ /usr/local/sonar-scanner

 

咱们要将扫描器和sonar关联起来

[root@linux-node1 ~]# cd /usr/local/sonar-scanner [root@linux-node1 sonar-scanner]# ls bin conf lib [root@linux-node1 sonar-scanner]# cd conf/ [root@linux-node1 conf]# ls sonar-scanner.properties [root@linux-node1 conf]# vim sonar-scanner.properties sonar.host.url=http://localhost:9000 #sonar地址 sonar.sourceEncoding=UTF-8 #字符集 sonar.jdbc.username=sonar #数据库帐号 sonar.jdbc.password=sonar@pw #数据库密码 sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8 #数据库链接地址 #打开注释便可

咱们如今须要找一个代码进行分析。

sonar插件提供了一个代码的库 
github:https://github.com/SonarSource/sonar-examples 
咱们下载软件包:https://github.com/SonarSource/sonar-examples/archive/master.zip

解压

[root@linux-node1 src]# unzip sonar-examples-master.zip [root@linux-node1 php]# cd sonar-examples-master/projects/languages/php [root@linux-node1 php]# cd php-sonar-runner-unit-tests/ [root@linux-node1 php-sonar-runner-unit-tests]# ll total 8 -rw-r--r-- 1 root root 647 Dec 14 09:57 README.md drwxr-xr-x 2 root root 51 Dec 14 09:57 reports -rw-r--r-- 1 root root 346 Dec 14 09:57 sonar-project.properties drwxr-xr-x 3 root root 31 Dec 14 09:57 src drwxr-xr-x 2 root root 25 Dec 14 09:57 tests #这里就是PHP的目录

配置文件解释: 
若是你想让我扫描,就须要在代码路径下放一个配置文件

[root@linux-node1 php-sonar-runner-unit-tests]# cat sonar-project.properties sonar.projectKey=org.sonarqube:php-ut-sq-scanner #Key sonar.projectName=PHP :: PHPUnit :: SonarQube Scanner #这里的名称会显示在一会的web界面上 sonar.projectVersion=1.0 #版本,这里的版本一会也会显示在web界面上 sonar.sources=src #软件包存放路径 sonar.tests=tests sonar.language=php #语言 sonar.sourceEncoding=UTF-8 #字体 # Reusing PHPUnit reports sonar.php.coverage.reportPath=reports/phpunit.coverage.xml sonar.php.tests.reportPath=reports/phpunit.xml

#也就是说在项目里面必须有这个配置文件才能够进行扫描

扫描 
#提示:须要在项目文件里面进行执行

[root@linux-node1 php-sonar-runner-unit-tests]# /usr/local/sonar-scanner/bin/sonar-scanner
INFO: Scanner configuration file: /usr/local/sonar-scanner/conf/sonar-scanner.properties
INFO: Project root configuration file: /usr/local/src/sonar-examples-master/projects/languages/php/php-sonar-runner-unit-tests/sonar-project.properties
INFO: SonarQube Scanner 2.8
INFO: Java 1.8.0_111 Oracle Corporation (64-bit)
INFO: Linux 3.10.0-514.2.2.el7.x86_64 amd64
INFO: User cache: /root/.sonar/cache
INFO: Load global repositories INFO: Load global repositories (done) | time=211ms WARN: Property 'sonar.jdbc.url' is not supported any more. It will be ignored. There is no longer any DB connection to the SQ database. WARN: Property 'sonar.jdbc.username' is not supported any more. It will be ignored. There is no longer any DB connection to the SQ database. WARN: Property 'sonar.jdbc.password' is not supported any more. It will be ignored. There is no longer any DB connection to the SQ database. INFO: User cache: /root/.sonar/cache INFO: Load plugins index INFO: Load plugins index (done) | time=3ms INFO: Download sonar-csharp-plugin-5.0.jar INFO: Download sonar-java-plugin-3.13.1.jar INFO: Download sonar-l10n-zh-plugin-1.11.jar INFO: Plugin [l10nzh] defines 'l10nen' as base plugin. This metadata can be removed from manifest of l10n plugins since version 5.2. INFO: Download sonar-scm-git-plugin-1.2.jar INFO: Download sonar-php-plugin-2.9.1.1705.jar INFO: Download sonar-scm-svn-plugin-1.3.jar INFO: Download sonar-javascript-plugin-2.11.jar INFO: SonarQube server 5.6 INFO: Default locale: "en_US", source code encoding: "UTF-8" INFO: Process project properties INFO: Load project repositories ................................................. .................................................

提示:咱们什么都不指定就会在当面目录下扫描sonar-project.properties文件,根据配置文件进行扫描工做。扫描以后咱们在web界面上就能够看到代码的扫描结果

这里的名字,版本 都是在sonar-project.properties文件中定义的 
image_1b4i615kfc791t2u2261tae11n3u.png-89.7kB 
质量阈帮咱们设定好一个阈值,超过相应的阈值就算有bug 
image_1b4i61htufea1l9n1voe1r8pgqn4b.png-75.4kB

为了让jenkins能够在构建项目的时候执行sonar,因此咱们须要在jenkins上安装插件 
image_1b4i6426o4sb18mp16ob4vl1evd4o.png-121.8kB

如今就能够进行配置,让jenkins和sonar结合在一块儿。这样咱们构建项目的时候就会进行代码检测

image_1b4i64e6l199910vo1u3d1tsh148k55.png-140.1kB

image_1b4i64kf41vglnbr4m11rl51t3r5i.png-62kB

点击保存

image_1b4i650bnnp2n7v1idt1f9o6vu5v.png-125.7kB

配置 
image_1b4i65f50euu1beq19ki1bkf13ti6c.png-86.9kB 
编辑咱们的项目,选择最下放。找到构建 
image_1b4i65rj31qufmou16u417q914hn6p.png-27.2kB 
对PHP文件进行复制

[root@linux-node1 php-sonar-runner-unit-tests]# cat /usr/local/src/sonar-examples-master/projects/languages/php/php-sonar-runner-unit-tests/sonar-project.properties sonar.projectKey=org.sonarqube:php-ut-sq-scanner sonar.projectName=PHP :: PHPUnit :: SonarQube Scanner sonar.projectVersion=1.0 sonar.sources=src sonar.tests=tests sonar.language=php sonar.sourceEncoding=UTF-8 # Reusing PHPUnit reports sonar.php.coverage.reportPath=reports/phpunit.coverage.xml sonar.php.tests.reportPath=reports/phpunit.xml

image_1b4i66hd316vq1i5g11k8v0j1rcq76.png-60.6kB 
Analysis properties 分析的参数

填写完毕后,咱们点击保存 
image_1b4i66u061lhp1qkjvk6124a1k497j.png-90.1kB 
咱们选择当即构建 
image_1b4i678mn1bl4qsf10buddqmvq80.png-93.5kB

提示:此时的SonarQube是没法点击的

点击Console Output能够查看构建输出的内容 
image_1b4i67mp06ltar5im11s6thvk8d.png-171.4kB

#提示:只要没有error就能够

image_1b4i6c8qj1pjf1c281billo51sgr8q.png-119.1kB 
构建完成后,咱们发现这里的SonarQube能够点击,咱们点击SonarQube就会连接到192.168.56.11:9000 就是代码查看器的地址 
image_1b4i6ci8r1bl9124r12ok19kq7mt97.png-86.1kB

如今咱们已经作到了能够在git上进行拉取代码。并进行检测

咱们还能够配置一个构建失败发送邮箱: 
image_1b4i6cva0hl4l8amdq1htu9m19k.png-63.5kB 
在咱们项目里面设置构建后操做,选择E-mail Notification 
image_1b4i6d6t717evijk1oa6int195fa1.png-40kB 
舒适提示:使用163邮箱发送的通知被163服务器退回了,所以我将设置在jenkins的邮箱改为了QQ邮箱

QQ:邮箱须要设置以下: 
image_1b4i6doeh28e1nukrg2l6tid8ae.png-47kB

**一、须要开启POPE3/SMTP服务 
二、在jenkins上配置的密码咱们须要点击生成受权码进行使用**

QQ邮件默认会收到以下提示: 
image_1b4i6efuj187n1ib516gs5rg1n45ar.png-80.9kB 
当再次构件成功时,邮件内容以下: 
image_1b4i6eptgcpb46a1070196t1bmnb8.png-32kB

相关文章
相关标签/搜索