Docker 安装 sonarQube 并在项目工使用sonar进行扫描

一时失言乱红尘 2022-11-10 10:38 304阅读 0赞

# 1. 安装Mysql #

sonar扫描出来的缺陷等信息需要存入数据库，数据库选择可以有很多，我这里以mysql作为演示

**1.1. 安装mysql**  
略，需要注意的是我这里安装的sonarQube的版本是7.4-community，mysql的版本不能低于5.6。

**1.2 创建mysql sonar数据库用.户**.

create database sonar;
    CREATE USER 'sonar'@'%' IDENTIFIED BY 'sonar'; grant all on sonar.* to 'sonar'@'%';
    flush privileges;

# 2. Docker安装sonarQube #

**2.1 拉取镜像**

docker pull sonarqube:7.4-community

**2.2 创建工作目录**

mkdir -p /data/sonarqube

**2.3 修改系统参数**

echo "vm.max_map_count=262144" > /etc/sysctl.conf
    sysctl -p

**2.4 运行一个test容器**

docker run -d --name sonartest sonarqube:7.4-community

**2.5 将容器内重要文件复制到宿主机**

docker cp sonartest:/opt/sonarqube/conf /data/sonarqube
    docker cp sonartest:/opt/sonarqube/data /data/sonarqube
    docker cp sonartest:/opt/sonarqube/logs /data/sonarqube
    docker cp sonartest:/opt/sonarqube/extensions /data/sonarqube

**2.6 删除这个test容器**

docker rm -f sonartest

**2.7 修改文件夹权限**

chmod -R 777 /data/sonarqube/

**2.8 创建容器并运行**

docker run -d --name sonar -p 9090:9000 \
     -e ALLOW_EMPTY_PASSWORD=yes \
     -e SONARQUBE_DATABASE_USER=sonar \
     -e SONARQUBE_DATABASE_NAME=sonar \
     -e SONARQUBE_DATABASE_PASSWORD=sonar \
     -e SONARQUBE_JDBC_URL="jdbc:mysql://mysql:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false" \
     --net sonarqube-tier \ --privileged=true \
     -v /data/sonarqube/logs:/opt/sonarqube/logs \
     -v /data/sonarqube/conf:/opt/sonarqube/conf \
     -v /data/sonarqube/data:/opt/sonarqube/data \
     -v /data/sonarqube/extensions:/opt/sonarqube/extensions\
     sonarqube:7.4-community

# 3. 使用sonar扫描代码 #

浏览器输入http://ip:9090，随便输入一个用户名用以生成token，选择自己的项目是gradle还是maven。好了后会有一个命令显示在页面上

mvn sonar:sonar -Dsonar.host.url=http://192.168.85.130:9090 -Dsonar.login=017f727c51f303c689ddb9ca9133b5c640ebb5fd

去项目的根目录或者在IDEA的终端中执行这个命令  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]  
到显示`BUILD SUCCESS`说明已经扫描完成  
![在这里插入图片描述][20210316205442305.png]  
浏览器输入http://ip:9090，账号：admin 密码：admin  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 1]

# 4. 使用sonarQube #

**4.1 配置中文**  
新版本sonaqube可以去市场搜索中文语言包如下。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 2]  
可以看到这个中文包的版本并不支持我们现在安装的sonaqube的版本，需要去github上下载中文包  
[中文语言包下载地址][Link 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 3]  
将 jar 包放入 /data/sonarqube/extensions/plugins ，重启 sonarqube。再次访问就看到中文了.然后会在首页显示前面扫出来的项目缺陷有哪些  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 4]

# 5. 单元测试覆盖率一直是0的解决办法 #

![在这里插入图片描述][20210316210540600.png]

先确认下单元测试的代码目录是否正确，正确的目录如下，需要在`test/java`下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 5]  
**如果目录没有问题尝试如下解决方案**

在pom.xml中添加jacoco插件

<build>
    	<plugins>
    		<plugin>
    			<groupId>org.jacoco</groupId>
    			<artifactId>jacoco-maven-plugin</artifactId>
    			<version>0.7.8</version>
    			<executions>
    				<execution>
    					<goals>
    						<goal>prepare-agent</goal>
    						<goal>report</goal>
    					</goals>
    				</execution>
    			</executions>
    		</plugin>
    	</plugins>
    </build>

添加测试支持包

<dependency>
        <groupId>org.junit.platform</groupId>
        <artifactId>junit-platform-runner</artifactId>
        <version>1.5.1</version>
    </dependency>

在测试代码的类上加注解

@RunWith(JUnitPlatform.class)

整个文件如下

@RunWith(JUnitPlatform.class)
    public class TestMyHashSet { 
        @Test
        void contextLoads() { 
            MyHashSet myHashSet = new MyHashSet();
            myHashSet.add(1);
            myHashSet.remove(1);
            myHashSet.contains(1);
            System.out.println("+++++"+myHashSet.contains(1));
        }
    }

再次执行扫描命令，就可以看到单侧有覆盖率了  
![在这里插入图片描述][20210316210444195.png]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]: /images/20221023/bbb7d0bbabe44957ab94f99c8f845e45.png
[20210316205442305.png]: /images/20221023/c72695cf3e2546a481e8bf1248b66bbd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 1]: /images/20221023/5fb469450834460a91e1af6ba8b08516.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 2]: /images/20221023/33d87edd2a1a40298dfe190e7be6b484.png
[Link 1]: https://github.com/SonarQubeCommunity/sonar-l10n-zh/tags
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 3]: /images/20221023/bd55c10a3a7e4edaaa77565b3b6d9feb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 4]: /images/20221023/aceb11f0b49b4c8d9a48c13da531201b.png
[20210316210540600.png]: /images/20221023/7d4bfb0df6ed47ee9f66eb58c636d3d8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 5]: /images/20221023/7a0bfea8c9504c5989a88589c4d8bef9.png
[20210316210444195.png]: /images/20221023/1538c4dbd88d41c18c437addea726b40.png