一、sonarqube简介
- SonarQube是管理代码质量的一个开放平台,可以快速定位代码中潜在的或者明显的错误。支持Java, C#, C/C++, PL/SQL, Cobol, JavaScrip, Groovy 等二十几种编程语言的代码质量管理与检测。
二、安装postgresql数据库
- 官网上已经声明 sonarQube 7.9 版本以上不再支持 mysql 了,所以我们使用 postgresql
1、配置挂载数据库目录。
mkdir -p /home/test/postgres/{postgresql,data}
2、拉取数据库镜像,我们这里用到的是11版本。
docker pull postgres:11
3、 创建容器并启动:
docker run -itd --name postgres -p 5432:5432 \
-v /home/test/postgres/postgresql:/var/lib/postgresql \
-v /home/test/postgres/data:/var/lib/postgresql/data \
-v /etc/localtime:/etc/localtime:ro \
-e POSTGRES_USER=sonar \
-e POSTGRES_PASSWORD=sonar123456 \
-e POSTGRES_DB=sonar \
-e TZ=Asia/Shanghai \
--restart always \
--privileged=true \
postgres:11
4、postgres基本操作:
# 进入docker容器
docker exec -it postgres /bin/bash
# 用户登录(sonar)
psql -U username
# 创建新用户
create user admin with password '123456';
# 创建数据库,指定用户
create database testDB with owner admin;
# 退出
\q
# 查看用户
\du
# 列出数据库
\l
# 删除用户
drop user admin;
# 删除数据库
drop database dbtest;
三、sonarqube安装
1、安装镜像
docker pull sonarqube:8.9.2-community
2、新建目录
mkdir -p /home/apps/sonarqube/{extensions,logs,data}
3、创建并启动
docker run -d --name sonarqube -p 6005:9000 \
--link postgres \
-v /home/test/sonarqube/extensions:/opt/sonarqube/extensions \
-v /home/test/sonarqube/logs:/opt/sonarqube/logs \
-v /home/test/sonarqube/data:/opt/sonarqube/data \
-e SONAR_JDBC_URL=jdbc:postgresql://postgres:5432/sonar \
-e SONAR_JDBC_USERNAME=sonar \
-e SONAR_JDBC_PASSWORD=sonar123456 \
--restart always \
--privileged=true \
sonarqube:lts-community
4、修改内核参数
不修改启动会报错:ERROR: Elasticsearch did not exit normally - check the logs at /opt/sonarqube/logs/sonarqube.log
vim /etc/sysctl.conf
# 增加以下配置
vm.max_map_count=262144
fs.file-max=65536
# 使配置生效
sysctl -p
5、查看日志
docker logs sonarqube
6、开放6005端口
# 添加6005端口
firewall-cmd --zone=public --add-port=6005/tcp --permanent
# 重新载入
firewall-cmd --reload
7、页面访问
http://ip:6005,默认账号:admin,密码:admin
8、sonar安装中文插件
方式一:Administration->Marketplace->搜索chinese pack,进行相应版本的安装,如下图
方式二:下载地址:https://github.com/xuhuisheng/sonar-l10n-zh/tags ,找到自己版本对应的中文包,将 jar 包放入 /home/apps/sonarqube/extensions/plugins ,重启 sonarqube
9、sonar安装多分支扫描插件。
因社区版是免费开源的,所以不提供扫描项目切换分支的功能,但适合真正生产环境的项目会具有多个分支,只能扫描主分支的SonarQube社区版显然很不满足你的需求,而开发者版和企业版支持但是需要大量的欧元。别担心,插件市场提供了一款可以切换分支的插件,sonarqube-community-branch-plugin,Let’s go!
中文插件地址https://github.com/mc1arke/sonarqube-community-branch-plugin 。
1.进入页面滚轮往下,查看和你SonarQube对应的版本:
2.点击进入超链接挑选下载版本:
SonarQube:9.9对应的jar包:sonarqube-community-branch-plugin-1.14.0.jar。
3.下载完后和setp 6一样放入挂载目录/usr/sonarqube/extensions/plugins。
4.需要同官网描述修改SonarQube的配置文件:sonar.properties
docker exec -it sonarqbue8.9.2 /bin/bash 进入容器内部找到配置文件。
进入conf文件夹,使用vim命令修改sonar.properties,在文件末尾加入两行:
sonar.web.javaAdditionalOpts=-javaagent:./extensions/plugins/sonarqube-community-branch-plugin-1.7.0.jar=web
sonar.ce.javaAdditionalOpts=-javaagent:./extensions/plugins/sonarqube-community-branch-plugin-1.7.0.jar=ce
1.7.0:你所下载的jar包的版本,本文因SonarQube版本为9.9所以是填入1.14.0。
保存退出。
若你的容器里没用vim命令,先尝试apt-get update + apt-get install vim两句命令,若还是不行可以看看有没有yum -y install vim命令,若都没有可以尝试先将容器内部文件拷出来,修改完再拷回去,参考命令如下:
docker cp sonarqube:/opt/sonarqube/conf/sonar.properties /opt/sonar.properties
docker cp /opt/sonar.properties sonarqube:/opt/sonarqube/conf/sonar.properties
4.重启SonarQube。
5.登录页面后若弹出检测到插件风险,点击忽略就好。
显示这样的页面,master分支有个蓝底白色加号的按钮就说明你成功了。
6.先扫描master分支后,再切换如sonar.branch.name=xxx分支扫描后就能看到。
评论区