Jacoco覆盖率工具使用

迈不过友情╰ 2022-08-26 13:23 154阅读 0赞

# Jacoco介绍 #

Jacoco是一个开源的覆盖率工具。Jacoco可以嵌入到Ant 、Maven中，并提供了EclEmma Eclipse插件,也可以使用JavaAgent技术监控Java程序。很多第三方的工具提供了对Jacoco的集成，如sonar、Jenkins等。

官网地址：[http://www.eclemma.org/jacoco/][http_www.eclemma.org_jacoco]

# Java Counters #

Jacoco包含了多种尺度的覆盖率计数器,包含指令级(Instructions,C0coverage)，分支（Branches,C1coverage）、圈复杂度(CyclomaticComplexity)、行(Lines)、方法(non-abstract methods)、类(classes)。

![Image 1][]

![SouthEast][]

如上图所示，**标示绿色的为分支覆盖充分**，**标黄色的为部分分支覆盖**，**标红色的为未执行该分支**。

# 支持的集成工具 #

Jacoco团队提供了如下的一些集成工具的支持：

Java API

http://www.eclemma.org/jacoco/trunk/doc/api/index.html

Command Line

http://www.eclemma.org/jacoco/trunk/doc/agent.html

Apache Ant

http://www.eclemma.org/jacoco/trunk/doc/ant.html

Apache Maven

http://www.eclemma.org/jacoco/trunk/doc/maven.html

Eclipse EclDmma Plugin

[http://www.eclemma.org/][http_www.eclemma.org]

下面介绍使用ant工具的方法，将使用一个web工程做完示例讲解。

# Apache Ant的使用 #

## web工程图 ##

![Image 1][]

![SouthEast 1][]

## 执行ant  file task：all-report ##

![SouthEast 2][]

![Image 1][]

执行ant file后生成报告report目录如图所示：

![Image 1][]![SouthEast 3][]

## 测试报告 ##

可以单独运行命令：anttest-report生成测试报告；

执行之后会在build/report/html生成测试报告，其中打开index.html如下所示。![SouthEast 4][]下

单击：![Image 1][] ![SouthEast 5][]进入：

![SouthEast 6][]

展示测试类名称、测试方法名称 、测试状态 success or fail 、类型及执行时间：

![Image 1][]

## 测试用例覆盖率 ##

可以单独执行命令：antcoverreport；

执行之后会在build/report/coverage下生成覆盖报告，其中打开index.html如下所示：

![Image 1][]![SouthEast 7][]

单击包名称一层一层单击进入：

![SouthEast 8][]

![Image 1][]

**具体颜色定义查看上面的介绍**。

# Jacoco与jenkins，sonar集成 #

## Jenkins中构建简单配置 ##

![Image 1][]![SouthEast 9][]

![SouthEast 10][]

![SouthEast 11][]

![Image 1][]

图仅供参考。

## Jacoco与jenkins集成 ##

首先jenkins安装jacoco插件，如图所示：

![Image 1][]![SouthEast 12][]

建议使用jenkins插件管理进行安装；

对应的Jenkins插件见[https://wiki.jenkins-ci.org/display/JENKINS/JaCoCo+Plugin][https_wiki.jenkins-ci.org_display_JENKINS_JaCoCo_Plugin]

配置jacoco插件

在“Addpost-build action”中选择“![SouthEast 13][]![Image 1][]”，如图所示：

![Image 1][]![SouthEast 14][]

![SouthEast 15][]

配置如下部分：

![Image 1][]![SouthEast 16][]

**第一个部分：代码覆盖率统计文件位置；**

**第二个部分：classes文件位置；**

**第三个部分：源码文件位置；**

** ![Image 1][]![SouthEast 17][]**

**根据需要填写百分比；**

** **

## Jacoco 与sonar集成 ##

在项目跟目录下面新建一个sonar-project.properties，如web图所示。

编辑此文件：

![Image 1][]![SouthEast 18][]

## 执行sonar，配置jenkins部分 ##

![SouthEast 19][]

![Image 1][]

只需要执行sonar-runner即可，前提是将jenkins与sonar-runner集成在一起；

# 运行jenkins，执行构建任务 #

![SouthEast 20][]

![Image 1][]

看到类似结果，表示构建结束。

至此，可以通过jenkins查看代码覆盖率等信息。

单击进入测试项目：

![Image 1][]![SouthEast 21][]

![SouthEast 22][]

![Image 1][]

单击“CodeCoverage Trend“部分，进入详细页面：

![SouthEast 23][]

![Image 1][]

单击进入详细的覆盖率文件：

![SouthEast 24][]

# SonarQube展示 #

进入sonarqube项目：[http://172.16.XXX.XXX9000/][http_172.16.XXX.XXX9000]

单击工程jacoco\_test\_project：

![SouthEast 25][]

![Image 1][]

进入详细页面：

![SouthEast 26][]

![Image 1][]

**其中圈中左边为单元测试覆盖率，右边为单元测试统计；**

** **

**单击![SouthEast 27][]![Image 1][]进入**

**![SouthEast 28][]**

**![Image 1][]**

**通过下拉框选择查看行覆盖情况，未覆盖行情况，分支覆盖情况，未覆盖分支情况；**

** ![Image 1][]![SouthEast 29][]**

** **

**单击**![SouthEast 30][]![Image 1][] **进入测试情况信息页面：**

![Image 1][]

** ![SouthEast 31][]**

**如果存在错误，此部分会展示错误情况。**

[http_www.eclemma.org_jacoco]: http://www.eclemma.org/jacoco/
[Image 1]: 
[SouthEast]: /images/20220824/3061f57d62bd4b86bd24843f976bcd98.png
[http_www.eclemma.org]: http://www.eclemma.org/
[SouthEast 1]: /images/20220824/456d8c365dd24fe698d74a3c44282404.png
[SouthEast 2]: /images/20220824/5411110780434b9db76a1f6eed6bca47.png
[SouthEast 3]: /images/20220824/a9381e4ceaa1483187df67fa9d64b082.png
[SouthEast 4]: /images/20220824/6a1bc18a311a4fa5b28ca74596b69b57.png
[SouthEast 5]: /images/20220824/6d4b47f3fb6948d7b7f9f8d4365d62c5.png
[SouthEast 6]: /images/20220824/10e4a893ced946c7bf4c3c359192be56.png
[SouthEast 7]: /images/20220824/85fed49f4ba34196bd7351768a57ec7d.png
[SouthEast 8]: /images/20220824/5fd4a1a5062b4abdb06031a4ecf0cd50.png
[SouthEast 9]: /images/20220824/4715988dd9244c3cbc4ae3843f9e9ce1.png
[SouthEast 10]: /images/20220824/1ce3e3d21171468d9e66198c1c1270d2.png
[SouthEast 11]: /images/20220824/6e3effc9b6a34e7f9b76b18e54cdad9f.png
[SouthEast 12]: /images/20220824/b48c2fe915d74dafa5774523b6891fcc.png
[https_wiki.jenkins-ci.org_display_JENKINS_JaCoCo_Plugin]: https://wiki.jenkins-ci.org/display/JENKINS/JaCoCo+Plugin
[SouthEast 13]: https://img-blog.csdn.net/20140411170656609?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvd2FuZ211bWluZw==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast
[SouthEast 14]: /images/20220824/8e0054f74d8f45bcaccb1da39a7d86b5.png
[SouthEast 15]: /images/20220824/cea80d4005264bf1a211b51a0bceb691.png
[SouthEast 16]: /images/20220824/381d192662b946b0a7fa9e6e18fb6ee3.png
[SouthEast 17]: /images/20220824/4ceb60278d044683943149bc713161f8.png
[SouthEast 18]: /images/20220824/fbe9a0c5e5f040afb524ff8cecdc47a9.png
[SouthEast 19]: /images/20220824/5eea8fd9e1354013aea86a5c6d283cfd.png
[SouthEast 20]: /images/20220824/daf1e33775554bc0bbdf740f29849b46.png
[SouthEast 21]: /images/20220824/1ba87c670a194ecebf9fd710b34cff91.png
[SouthEast 22]: /images/20220824/5e49ca3c522345b8b3a01b10c2f61b24.png
[SouthEast 23]: /images/20220824/27e6112b33f54007b53e86dd7ed62984.png
[SouthEast 24]: /images/20220824/3e3448280acf41ddb8966297fbcf43f7.png
[http_172.16.XXX.XXX9000]: http://172.16.39.149:9000/
[SouthEast 25]: /images/20220824/9abacd0a08de45e9bd56f7a5cfe43a31.png
[SouthEast 26]: /images/20220824/872d2d4f4315454996cbdee7a3eca977.png
[SouthEast 27]: https://img-blog.csdn.net/20140411171459359?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvd2FuZ211bWluZw==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast
[SouthEast 28]: /images/20220824/901046ae93fa436cb844eefebbfd4bea.png
[SouthEast 29]: /images/20220824/eff3a514408140a198083c8a09ca17a0.png
[SouthEast 30]: https://img-blog.csdn.net/20140411171603875?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvd2FuZ211bWluZw==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast
[SouthEast 31]: /images/20220824/37b85610564d45a1a11c20262f4ab518.png