Sonar介绍
Sonar 是一个用于代码质量管理的开放平台。通过插件机制,Sonar 可以集成不同的测试工具,代码分析工具,以及持续集成工具。与持续集成工具(例如 Hudson/Jenkins 等)不同,Sonar 并不是简单地把不同的代码检查工具结果(例如 FindBugs,PMD 等)直接显示在 Web 页面上,而是通过不同的插件对这些结果进行再加工处理,通过量化的方式度量代码质量的变化,从而可以方便地对不同规模和种类的工程进行代码质量管理。
在对其他工具的支持方面,Sonar 不仅提供了对 IDE 的支持,可以在 Eclipse 和 IntelliJ IDEA 这些工具里联机查看结果;同时 Sonar 还对大量的持续集成工具提供了接口支持,可以很方便地在持续集成中使用 Sonar。
此外,Sonar 的插件还可以对 Java 以外的其他编程语言提供支持,对国际化以及报告文档化也有良好的支持。
需要注意最新版的 Sonar 需要至少 JDK 1.8 及以上版本。
Sonar 的功能就是来检查代码是否有 BUG。除了检查代码是否有 bug 还有其他的功能,比如说:你的代码注释率是多少,代码有一些建议,编写语法的建议。所以我们叫质量管理
Sonar 还可以给代码打分,并且引用了技术宅的功能(告诉你有很多地方没改)
Sonar部署
[root@localhost ~]# unzip sonarqube-5.6.zip
[root@localhost ~]# mv sonarqube-5.6 /usr/local/
[root@localhost ~]# ln -s /usr/local/sonarqube-5.6/ /usr/local/sonarqube
安装数据库
sonar 好像不支持 mysql 5.5,所以如果看日志出现以上 error 请安装 mysql5.6 或者更高版本
执行sql语句
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;
配置sonar
[root@localhost ~]# cd /usr/local/sonarqube/conf/
[root@localhost conf]# vim sonar.properties
启动sonar
[root@localhost conf]# ln -s /usr/local/sonarqube/bin/linux-x86-64/sonar.sh /usr/local/bin/
[root@localhost conf]# sonar.sh start
浏览器访问端口9000
提示:
sonar 跟 jenkins 类似,也是以插件为主
sonar 安装插件有 2 种方式:第一种将插件下载完存放在 sonar 的插件目录,第二种使用 web 界面来使用安装 存放插件路径[/usr/local/sonarqube/extensions/plugins/]
默认账号admin,密码admin登录
[root@localhost ~]# cd /usr/local/sonarqube/extensions/plugins/
在此目录下上传了中文包和php语言包
重启sonar
[root@localhost ~]# sonar.sh restart
代码分析,sonar扫描仪
[root@localhost ~]# unzip sonar-scanner-cli-3.3.0.1492-linux.zip
[root@localhost ~]# mv sonar-scanner-3.3.0.1492-linux/ /usr/local/sonar-scanner
[root@localhost ~]# ln -s /usr/local/sonar-scanner/bin/sonar-scanner /usr/local/bin/
[root@localhost ~]# ln -s /usr/local/sonar-scanner/bin/sonar-scanner /usr/bin/
将扫描仪和sonar关联起来
[root@localhost ~]# cd /usr/local/sonar-scanner/conf/
[root@localhost conf]# vim sonar-scanner.properties
内容同sonarqube配置一样
配置完成后下载测试的代码包
[root@localhost ~]# unzip testalyzer-master.zip
[root@localhost ~]# cd testalyzer-master/
[root@localhost testalyzer-master]# cd projects/languages/php/php-sonar-runner-unit-tests/
[root@localhost php-sonar-runner-unit-tests]# cat sonar-project.properties
sonar.projectKey=org.sonarqube:php-ut-sq-scanner ##密钥
sonar.projectName=PHP :: PHPUnit :: SonarQube Scanner ##web页面显示名称
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
##也就是说在项目里面必须有这个配置文件才可以进行扫描
扫描
##提示:需要在项目文件里面进行执行
[root@localhost php-sonar-runner-unit-tests]# sonar-scanner
在web页面看到的结果
Jenkins开启sonar代码扫描
在jenkins服务器上选择上传插件
然后点击保存
Analysis properties 这一栏填入
sonar.projectKey=web
sonar.projectName=web
sonar.projectVersion=1.0
sonar.sources=src
sonar.tests=tests
sonar.language=php
sonar.sourceEncoding=UTF-8
sonar.php.coverage.reportPath=reports/phpunit.coverage.xml
sonar.php.tests.reportPath=reports/phpunit.xml
设置jenkins邮件报警
qq邮箱默认收到一份邮件