本文介绍了如何利用JaCoCo生成单元测试及覆盖率报告并在Jenkins显示测试报告结果。
本文首发:http://yuweiguocn.github.io/
新浪微博:@于卫国
《西江月·夜行黄沙道中》
明月别枝惊鹊,清风半夜鸣蝉。
稻花香里说丰年。听取蛙声一片。
七八个星天外,两三点雨山前。
旧时茅店社林边,路转溪桥忽见。
—宋,辛弃疾
集成JaCoCo
Jacoco的全称为Java Code Coverage(Java代码覆盖率),可以生成java的单元测试代码覆盖率报告。
新建一个jacoco.gradle
文件,并输入以下内容:
apply plugin: 'jacoco'
jacoco {
toolVersion = "0.7.7.201606060606" //指定jacoco的版本
reportsDir = file("$buildDir/JacocoReport") //指定jacoco生成报告的文件夹
}
//依赖于testDebugUnitTest任务
task jacocoTestReport(type: JacocoReport, dependsOn: 'testDebugUnitTest') {
group = "reporting" //指定task的分组
reports {
xml.enabled = true //开启xml报告
html.enabled = true //开启html报告
}
def debugTree = fileTree(dir: "${buildDir}/intermediates/classes/debug",
includes: ["**/*Presenter.*"],
excludes: ["*.*"])//指定类文件夹、包含类的规则及排除类的规则,这里我们生成所有Presenter类的测试报告
def mainSrc = "${project.projectDir}/src/main/java" //指定源码目录
sourceDirectories = files([mainSrc])
classDirectories = files([debugTree])
executionData = files("${buildDir}/jacoco/testDebugUnitTest.exec")//指定报告数据的路径
}
然后在应用Module下的build.gradle
文件中引用刚新建的gradle文件:
apply from: 'jacocotest.gradle'
同步sync工程之后可以在任务列表看到新增加的任务:
图 jacocoTestReport任务
双击执行任务后可以在Build文件夹找到生成的覆盖率报告:
图 单元测试结果目录结构
其中testDebugUnitTest任务会生成单元测试结果报告,包含xml及html格式分别对应test-results和reports文件夹;jacocoTestReport任务会生成单元测试覆盖率报告,结果存放在jacoco和JacocoReport文件夹。
图 单元测试HTML报告结果
图 单元测试覆盖率报告概览
图 单元测试覆盖率类报告概览
图 单元测试覆盖率类覆盖情况
可以看到覆盖情况被不同的颜色标识出来,其中绿色表示代码被单元测试覆盖到,黄色表示部分覆盖,红色则表示完全没有覆盖到。
Jenkins配置
在Jenkins上配置好仓库地址及分支,然后通过shell执行gradle任务生成测试报告:
./gradlew clean jacocoTestReport --info
在增加构建后操作步骤添加发布单元测试报告及JaCoCo覆盖率报告:
图 增加构建后操作步骤
注:如果没有JaCoCo覆盖率功能,请先安装JaCoCo插件,插件地址:https://wiki.jenkins.io/display/JENKINS/JaCoCo+Plugin
图 单元测试报告及覆盖率配置
构建成功后可以在状态页面看到最新测试结果、测试结果趋势及代码覆盖率趋势:
图 Jenkins工程页面
点击趋势图表可以看到更详细的和本地生成的报告类似的页面。
常见问题
1.本地生成的单元测试覆盖率报告正常,但在Jenkins显示的单元测试覆盖率全是0%。
解决方案:此为JaCoCo的一个bug,请尝试更新JaCoCo版本解决此问题。遇到有问题的版本号是0.7.4.201502262128,更新为0.7.7.201606060606版本后解决此问题。如果没能解决请参考stackoverflow中的解决方案。