踩坑日记之Gradle自定义JacocoReport跟Test task

最新推荐文章于 2024-10-11 08:11:58 发布

穹柏

最新推荐文章于 2024-10-11 08:11:58 发布

阅读量3.7k

点赞数 5

CC 4.0 BY-SA版权

分类专栏：源码分析 framework 踩坑日记文章标签：单元测试 gradle unittest

本文链接：https://blog.youkuaiyun.com/scientificCommunity/article/details/120365100

本文记录了在Gradle中配置Jacoco单元测试覆盖率报告时遇到的问题，包括自定义test任务为何被SKIPPED，如何使用onlyIf条件，以及解决test.exec文件不存在和默认包含的问题。通过分析源码和调整配置，实现了预期的测试报告目标。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

起因
1. 为什么`JacocoTestReport`总是被SKIPPED
2. `task`里的`onlyIf`
3. `jacocoTestReport`的`onlyIf`为什么"默认"是`false`
4. `jacocoTestReport`的`executionData`为什么会默认包含"test.exec"
5. 怎么实现最初的目标
- 5.1 清空并重新设置
- 5.2 自定义一个干净的`JacocoReport`
一些唠叨(没什么营养，可跳过)
总结
github

起因

最近新写了一个项目，为了更好的保证项目输出的质量，引入了单元测试覆盖率统计框架Jacoco。由于gradle官网上的案例只有几个默认的task(test、JacocoTestReport等)的设置，而我希望能够额外为不同的层提供单独的test，也就发生了接下来这些有趣的事儿。

1. 为什么`JacocoTestReport`总是被SKIPPED

首先，我写了一个自定义的test。并且通过将finalizedBy指定为JacocoTestReport来让test执行完毕后自动执行JacocoTestReport。自定义test以及JacocoTestReport 如下：

//自定义test
task serviceTest(type: Test) {
   
   
    useTestNG()
    useJUnitPlatform()

	finalizedBy jacocoTestReport

    jacoco {
   
   
        enabled = true
        //指定原始数据文件位置
        destinationFile = layout.buildDirectory.file("jacoco/${taskName}.exec").get().asFile
        includes = ['xxxservice']
        excludeClassLoaders = []
        includeNoLocationClasses = false
        sessionId = "<auto-generated value>"
        output = JacocoTaskExtension.Output.FILE
    }
}

jacocoTestReport {
   
   
    // tests are required to run before generating the report
    dependsOn serviceTest
		
	//指定覆盖率统计数据文件。
	executionData(layout.buildDirectory.file("jacoco/${serviceTest.name}.exec").get().asFile)

    afterEvaluate {
   
   
        classDirectories.setFrom(files(classDirectories.files.collect {
   
   
            fileTree(dir: it, include: ['xxxservice'])
        }))
    }
    reports {
   
   
        xml.required = false
        csv.required = false
        html.outputLocation = layout.buildDirectory.dir('jacocoReport')
    }
}

看起来似乎没啥问题，该做的都做了。但是执行的时候程序却跳过了jacocoTestReport。当时特别纳闷，就去网上提了个问题。最后gradle官方的工作人员给了答复，大概意思是executionData对应的文件不存在，在jacocoTestReport里加上onlyIf = {true} 可以保证jacocoTestReport会执行，并且执行最终会报出test.exec文件不存在的错误。ok，有方向了，那就一个一个来分析。

2. `task`里的`onlyIf`

事实上，onlyIf决定了task是否被执行。同时，onlyIf可以设置多个规则判断，如果所有的规则判断都返回为true，才会执行task。否则，跳过task。

2.1 `SkipOnlyIfTaskExecuter`

让我们进入SkipOnlyIfTaskExecuter一探究竟：

public class SkipOnlyIfTaskExecuter implements TaskExecuter {
   
   
	@Override
    public TaskExecuterResult execute(TaskInternal task, TaskStateInternal state, TaskExecutionContext context) {
   
   
        boolean skip = !task.getOnlyIf().isSatisfiedBy(task);
				
		//跳过task
        if (skip) {
   
   
            return TaskExecuterResult.WITHOUT_OUTPUTS;
        }
				
		//执行task
        return executer.execute(task, state, context);
    }

	//遍历所有规则
	public boolean isSatisfiedBy(T object) {
   
   
        Spec<? super T>[] specs = getSpecsArray();
        for (Spec<? super T> spec : specs)