ubuntu搭建SonarQube

2022-02-14

ubuntu搭建SonarQube

简介

SonarQube 是一个基于开源 Web 的工具，用于管理代码质量和代码分析。它最广泛地用于连续的代码检查，它会检测编程语言错误，代码味道和漏洞问题，编程语言如 PHP，C#，JavaScript，C/C++ 和 Java，检测以后还跟踪统计和创建图表，使开发人员能够快速识别代码中的问题。

预先配置

sonarqube official page 提到当前已经不支持 MySQL，安装和运行 SonarQube 前需要在当前会话终端增加如下参数的值：

sudo sysctl -w vm.max_map_count=262144
sudo sysctl -w fs.file-max=65536
ulimit -n 65536
ulimit -u 4096

初始化基本工具

1
2
3

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install wget unzip -y

安装JDK

sudo apt-get install openjdk-11-jdk -y
sudo apt-get install openjdk-11-jre -y

# 检查 JAVA 版本
java -version

安装 PostgreSQL 10

首先添加并下载 PostgreSQL 存储库，接着安装 PostgreSQL 数据库服务器，使它在启动时自启动。然后更改默认 PostgreSQL 用户的密码，切换到 PostgreSQL shell 创建新用户，为 SonarQube 数据库的新创建用户设置密码。

sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" >> /etc/apt/sources.list.d/pgdg.list'
wget -q https://www.postgresql.org/media/keys/ACCC4CF8.asc -O - | sudo apt-key add -
sudo apt-get -y install postgresql postgresql-contrib
sudo systemctl start postgresql
sudo systemctl enable postgresql
sudo passwd postgres
su - postgres
createuser sonar
psql
ALTER USER sonar WITH ENCRYPTED password 'sonar';
CREATE DATABASE sonarqube OWNER sonar;
grant all privileges on DATABASE sonarqube to sonar;

\q
exit

安装SonarQube

1
2
3

sudo wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-7.9.5.zip
sudo unzip sonarqube-7.9.5.zip -d /opt
sudo mv /opt/sonarqube-7.9.5 /opt/sonarqube

配置SonarQube

不能以 root 用户来运行 Snarqube，如果使用 root 用户运行，它会自动停止。创建 sonar 用户和组。

创建组和用户

sudo groupadd sonar
sudo useradd -c "user to run SonarQube" -d /opt/sonarqube -g sonar sonar
sudo chown sonar:sonar /opt/sonarqube -R
sudo nano /opt/sonarqube/conf/sonar.properties

配置/opt/sonarqube/conf/sonar.properties

1
2
3

sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.jdbc.url=jdbc:postgresql://localhost:5432/sonarqube

编辑 SonarQube 脚本文件

sudo nano /opt/sonarqube/bin/linux-x86-64/sonar.sh
# 增加内容
RUN_AS_USER=sonar
# 保存退出
# Ctrl + X

启动SonarQube

sudo su sonar
cd /opt/sonarqube/bin/linux-x86-64/
./sonar.sh start

# 检查 SonarQube 运行状态
./sonar.sh status
tail /opt/sonarqube/logs/sonar.log
# 启动正常，如下日志
# INFO  app[][o.s.a.SchedulerImpl] Process[ce] is up
# INFO  app[][o.s.a.SchedulerImpl] SonarQube is up

配置系统服务

cd /opt/sonarqube/bin/linux-x86-64/
./sonar.sh stop
# 切换回管理员身份
# 重新连接服务器到root用户
sudo nano /etc/systemd/system/sonar.service
# 内容
[Unit]
Description=SonarQube service
After=syslog.target network.target
 
[Service]
Type=forking
 
ExecStart=/opt/sonarqube/bin/linux-x86-64/sonar.sh start
ExecStop=/opt/sonarqube/bin/linux-x86-64/sonar.sh stop
 
User=sonar
Group=sonar
Restart=always
 
LimitNOFILE=65536
LimitNPROC=4096
 
[Install]
WantedBy=multi-user.target

# 保存退出
# Ctrl + X

# 使 SonarQube 系统服务自启动
sudo systemctl start sonar
sudo systemctl enable sonar
sudo systemctl status sonar

访问 SonarQube

使用浏览器输入服务器 IP 访问 SonarQube，端口 9000。登录 SonarQube 的默认管理员用户名和密码都是 admin。

错误解决

max virtual memory areas vm.max_map_count [65530] is too low

1	loaded plugin [org.elasticsearch.transport.Netty4Plugin] ERROR: [1] bootstrap checks failed. max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144].

解决方案：

Elasticsearch 使用 MMap FS 目录来存储其索引。mmap 计数的默认操作系统限制可能太低，这可能会导致内存异常。输入以下命令增加虚拟内存值，如果要永久设置这个值，请更新 /etc/sysctl.conf 中的 vm.max_map_count 和 fs.file-max 值，然后重启系统。

sudo sysctl -w vm.max_map_count=262144
sudo sysctl -w fs.file-max=65536
sysctl vm.max_map_count
sysctl fs.file-max

log 提示不能加载 JVM

--> Wrapper Started as Daemon
Launching a JVM...
Unable to start JVM: No such file or directory (2)
JVM exited while loading the application.
JVM Restarts disabled. Shutting down.
<-- Wrapper Stopped

解决方案：

vim /opt/sonarqube/conf/wrapper.conf

# Path to JVM executable. By default it must be available in PATH.
# Can be an absolute path, for example:
# wrapper.java.command=/path/to/my/jdk/bin/java
# wrapper.java.command=/java
# wrapper.conf 文件提示 wrapper.java.command 需要配置 java 路径，默认路径有误，配置正确路径
wrapper.java.command=/usr/lib/jvm/java-11-openjdk-amd64/bin/java

安装中文插件

以管理员身份登录管理页面，安装汉化包。

在 Administration 菜单中选中 Marketplace，输入 Chinese 搜索中文的汉化包

点击安装，安装完成之后出现 Restart Server，点击确定，SonarQube 自动重启，完成汉化。