JaCoCo集成SonarQube和Jenkins检查代码测试覆盖率

刺骨的言语ヽ痛彻心扉 2021-11-22 14:28 824阅读 0赞

### 文章目录 ###

*  JaCoCo集成SonarQube和Jenkins检查代码测试覆盖率
 *   *  参考文档
     *  引入JaCoCo插件
     *  集成JaCoCo和SonarQube
     *  集成JaCoCo和Jenkins

# JaCoCo集成SonarQube和Jenkins检查代码测试覆盖率 #

## 参考文档 ##

*  [https://www.eclemma.org/jacoco/trunk/index.html][https_www.eclemma.org_jacoco_trunk_index.html]
 *  [https://www.mkyong.com/maven/maven-jacoco-code-coverage-example/][https_www.mkyong.com_maven_maven-jacoco-code-coverage-example]
 *  [https://tech.asimio.net/2019/04/23/Reporting-Code-Coverage-using-Maven-and-JaCoCo-plugin.html][https_tech.asimio.net_2019_04_23_Reporting-Code-Coverage-using-Maven-and-JaCoCo-plugin.html]

## 引入JaCoCo插件 ##

在`pom.xml`中引入JaCoCo插件：

<plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>0.8.2</version>
        <executions>
            <execution>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
            </execution>
            
            <execution>
                <id>report</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

当运行`mvn clean test`时，`jacoco-maven-plugin`插件会依次运行：

1.  首先运行`prepare-agent` goal（默认phase是`initialize`）收集`maven-surefire-plugin`插件运行测试产生的测试覆盖率信息，并写入`target/jacoco.exec`文件
2.  运行`report`goal（默认phase是`verfiry`，这里指定phase为`test`）读取`target/jacoco.exec`中的测试覆盖率信息，并生成测试覆盖率报告到`target/site/jacoco`目录，包括html, xml和csv格式。

参见：

*  [https://www.eclemma.org/jacoco/trunk/doc/prepare-agent-mojo.html][https_www.eclemma.org_jacoco_trunk_doc_prepare-agent-mojo.html]
 *  [https://www.eclemma.org/jacoco/trunk/doc/report-mojo.html][https_www.eclemma.org_jacoco_trunk_doc_report-mojo.html]

查看`mvn clean test`运行日志，关键步骤的执行顺序如下：

1. maven-clean-plugin:clean # delete target folder
    2. jacoco-maven-plugin:prepare-agent # prepare and run JaCoCo agent
    3. maven-compiler-plugin:compile # compile source code
    4. maven-compiler-plugin:testCompile # compile test code
    5. maven-surefire-plugin:test # run tests
    6. jacoco-maven-plugin:report # generate code test coverage reports

如果在Maven项目中区分了单元测试(Unit Test）和集成测试（Integration Test），需要将`jacoco:report`的phase改为`post-integration-test`，或使用默认的`verify`phase，这样JaCoCo插件才能生成集成测试部分的测试覆盖率。

参见：

*  [https://tech.asimio.net/2019/04/08/Splitting-Unit-and-Integration-Tests-using-Maven-and-Surefire-plugin.html\#controller-unit-integration-tests][https_tech.asimio.net_2019_04_08_Splitting-Unit-and-Integration-Tests-using-Maven-and-Surefire-plugin.html_controller-unit-integration-tests]

还可以在`pom.xml`中使用`jacoco:check`来强制检查测试覆盖率：

<execution>
        <id>jacoco-check</id>
        <goals>
            <goal>check</goal>
        </goals>
        <configuration>
            <rules>
                <rule>
                    <element>PACKAGE</element>
                    <limits>
                        
                        <limit>
                            <counter>LINE</counter>
                            <value>COVEREDRATIO</value>
                            <minimum>0.8</minimum>
                        </limit>
                    </limits>
                </rule>
            </rules>
        </configuration>
    </execution>

因为`jacoco:check`的默认phase是`verify`，因此当运行`mvn clean verify`时JaCoCo插件会检查代码测试覆盖率是否达到要求。

参见：

*  [https://www.eclemma.org/jacoco/trunk/doc/check-mojo.html][https_www.eclemma.org_jacoco_trunk_doc_check-mojo.html]

> 也可以通过集成JaCoCo和SonarQube，利用SonarQube的QualityGate功能强制检查代码测试覆盖率。

## 集成JaCoCo和SonarQube ##

参见：

*  [使用Jenkins流水线集成SonarQube做代码质量分析][Jenkins_SonarQube]

除了可以在本地查看JaCoCo生成的代码测试覆盖率报告外，还可以将JaCoCo收集到的代码测试覆盖率信息（`target/jacoco.exec`)文件送给SonarQube来生成和展示代码测试覆盖率报告。

命令示例：

mvn sonar:sonar \
      -s settings.xml \
      -Dsonar.host.url=http://192.168.87.154:9000 \
      -Dsonar.login=7c4b5baf2e96a565d27fe062c11baa05b5eb2f2a

> 注意：由于算法不尽相同，本地JaCoCo测试覆盖率报告(`target/site/jacoco/index.html`)和SonarQube上的代码测试覆盖率报告（Coverage)的测试覆盖率可能有细微差异。

使用SonarQube的QualityGate功能检查代码测试覆盖率是否符合要求。

## 集成JaCoCo和Jenkins ##

在Jenkins上安装[JaCoCo插件][JaCoCo] 。

新增一个“Post-build actions"步骤“Record JaCoCo coverage report“用来记录和分析JaCoCo代码测试覆盖率。

查看Jenkins job的JaCoCo代码测试覆盖率报告。

编辑Jenkins view，增加显示JaCoCo代码测试覆盖率列。

使用Jenkins的Snippet Generator功能查看Jenkins Pipeline的`jacoco`语法。

[https_www.eclemma.org_jacoco_trunk_index.html]: https://www.eclemma.org/jacoco/trunk/index.html
[https_www.mkyong.com_maven_maven-jacoco-code-coverage-example]: https://www.mkyong.com/maven/maven-jacoco-code-coverage-example/
[https_tech.asimio.net_2019_04_23_Reporting-Code-Coverage-using-Maven-and-JaCoCo-plugin.html]: https://tech.asimio.net/2019/04/23/Reporting-Code-Coverage-using-Maven-and-JaCoCo-plugin.html
[https_www.eclemma.org_jacoco_trunk_doc_prepare-agent-mojo.html]: https://www.eclemma.org/jacoco/trunk/doc/prepare-agent-mojo.html
[https_www.eclemma.org_jacoco_trunk_doc_report-mojo.html]: https://www.eclemma.org/jacoco/trunk/doc/report-mojo.html
[https_tech.asimio.net_2019_04_08_Splitting-Unit-and-Integration-Tests-using-Maven-and-Surefire-plugin.html_controller-unit-integration-tests]: https://tech.asimio.net/2019/04/08/Splitting-Unit-and-Integration-Tests-using-Maven-and-Surefire-plugin.html#controller-unit-integration-tests
[https_www.eclemma.org_jacoco_trunk_doc_check-mojo.html]: https://www.eclemma.org/jacoco/trunk/doc/check-mojo.html
[Jenkins_SonarQube]: https://blog.csdn.net/nklinsirui/article/details/90518618
[JaCoCo]: https://wiki.jenkins.io/display/JENKINS/JaCoCo+Plugin

发表评论取消回复

表情：

评论列表（有 0 条评论，824人围观）

还没有评论，来说两句吧...

相关阅读

相关 jacoco代码覆盖率浅析

1. jacoco简述 1. 一个开源的覆盖率工具 2. 很多第三方的工具提供了对JaCoCo的集成，如sonar、Jenkins等 3. 目前只支持JDK 1...

淡淡的烟草味﹌/ 2024年04月18日 10:39/ 0 赞/ 106 阅读

相关 Maven – JaCoCo代码覆盖率示例

![format_png][]![format_png 1][] 在本文中，我们将向您展示如何使用[JaCoCo Maven插件][JaCoCo Maven]生成Java项目

一时失言乱红尘/ 2023年02月15日 05:18/ 0 赞/ 75 阅读

相关 Jacoco获取集成测试覆盖率

一、Jacoco简介 Jacoco是专门用来统计单元测试覆盖率和集成测试覆盖率的十分常用的工具。二、Jacoco插桩主流代码覆盖率工具都采用字节码插桩模式，通

朱雀/ 2022年11月29日 05:56/ 0 赞/ 700 阅读

相关 spring cloud + jenkins + jacoco代码覆盖率报告

1. 添加maven依赖  <plugin> <groupId>org.jacoco</

系统管理员/ 2022年11月27日 12:24/ 0 赞/ 326 阅读

相关 Jacoco覆盖率工具使用(已测试)

1两种方式 1.1 eclipse直接安装插件测试 ![image][] install new soft 安装插件 eclemma java code cove

Bertha 。/ 2022年06月06日 06:18/ 0 赞/ 409 阅读

相关使用dropwizard(4)-加入测试-jacoco代码覆盖率

![dropwizard-hat.png][] 前言 dropwizard提供了一个简单的测试框架。这里简单集成并加入jacoco测试。作者：@Ryan-Miao

阳光穿透心脏的1/2处/ 2022年06月03日 23:17/ 0 赞/ 299 阅读

相关 springboot集成sonar+jacoco检查代码和覆盖率

1.配置本地maven的settings.xml的maven地址。 <pluginGroups> <pluginGroup>org.son

亦凉/ 2022年01月22日 08:07/ 0 赞/ 1357 阅读

相关 Jenkins Jacoco Sonar 代码覆盖率及质量扫描

Jenkins Jacoco Sonar 整合使用Jenkins部署项目，Sonar进行代码质量扫描，Jacoco做单元测试覆盖率扫描本文主要参考 > [http

刺骨的言语ヽ痛彻心扉/ 2022年01月14日 12:39/ 0 赞/ 1137 阅读

相关 JaCoCo集成SonarQube和Jenkins检查代码测试覆盖率

文章目录 JaCoCo集成SonarQube和Jenkins检查代码测试覆盖率参考文档引入JaCoCo插件集成JaCo

刺骨的言语ヽ痛彻心扉/ 2021年11月22日 14:28/ 0 赞/ 825 阅读

相关 Jacoco代码覆盖率测试工具

文章目录 Jacoco代码覆盖率测试工具介绍什么是Jacoco 什么是代码覆盖率代码覆盖率

「爱情、让人受尽委屈。」/ 2021年06月10日 20:37/ 0 赞/ 842 阅读