如何用JaCoCo统计Jenkins共享Groovy库vars目录步骤的代码覆盖率？

我之前在维护Jenkins共享库的时候也碰到过一模一样的问题！vars目录下的流水线步骤因为是动态加载的“脚本式”代码，而非标准Groovy类，JaCoCo默认不会把它们纳入覆盖率统计范围。下面是我试过的几个可行方案，按推荐程度排序：

这其实是Jenkins共享库的最佳实践——让vars目录的脚本只做“门面”，把核心逻辑放到src目录下的正规Groovy类中。这样不仅JaCoCo能轻松统计src里的代码覆盖率，代码的可维护性和可测试性也会提升一大截。

举个例子：
原来的vars/deployApp.groovy可能是这样的：

def call(Map params) {
    // 一堆复杂的部署逻辑
    echo "Deploying ${params.appName} to ${params.env}"
    sh "docker build -t ${params.appName} ."
    sh "docker push ${params.appName}"
    // ... 更多逻辑
}

重构后，vars/deployApp.groovy简化成：

def call(Map params) {
    new com.myteam.pipeline.Deployer(steps).deploy(params)
}

然后把核心逻辑放到src/main/groovy/com/myteam/pipeline/Deployer.groovy：

package com.myteam.pipeline

class Deployer {
    def steps

    Deployer(steps) {
        this.steps = steps
    }

    void deploy(Map params) {
        steps.echo "Deploying ${params.appName} to ${params.env}"
        steps.sh "docker build -t ${params.appName} ."
        steps.sh "docker push ${params.appName}"
        // ... 更多逻辑
    }
}

这样你的单元测试直接针对Deployer类编写，JaCoCo会自动统计它的覆盖率，而vars里的代码只有几行，几乎不影响整体覆盖率数据。

如果不想重构代码，你可以让构建工具（比如Gradle）把vars目录当作源码目录处理，这样JaCoCo就能扫描到编译后的类文件。

以Gradle为例，修改build.gradle的sourceSets配置：

sourceSets {
    main {
        groovy {
            srcDirs = ['src/main/groovy', 'vars']
        }
    }
}

然后在测试任务中确保JaCoCo包含vars目录的类：

test {
    jacoco {
        includes = ['**/vars/**']
    }
    // 如果你用JenkinsPipelineUnit，还要确保测试能加载vars脚本
    testLogging {
        events 'PASSED', 'FAILED', 'SKIPPED'
    }
}

注意：这种方式下，vars里的脚本会被编译成类，但Jenkins共享库的vars脚本本身是基于call()方法的动态脚本，编译后可能需要调整测试代码的加载方式——比如用loadScript而不是直接import，确保测试时的执行逻辑和Jenkins实际运行时一致。

如果是直接使用JaCoCo Agent而非构建工具集成，你可以在启动测试JVM时指定要包含的目录：

-javaagent:jacocoagent.jar=includes=**/vars/**,destfile=jacoco.exec

这个参数会告诉JaCoCo Agent追踪vars目录下所有类的执行情况。如果用Gradle或Maven，也可以在对应的插件配置里设置includes参数，本质和方案2类似。

• 不管用哪种方案，测试代码必须实际调用vars里的脚本逻辑——JaCoCo是基于执行轨迹统计的，没被执行到的代码不会计入覆盖率。比如用JenkinsPipelineUnit的测试类里要这样写：

  def setup() {
      // 初始化Pipeline上下文
      binding.setVariable('steps', new MockPipelineStepExecution())
  }
  
  def "test deployApp step"() {
      when:
      def deployStep = loadScript('vars/deployApp.groovy')
      deployStep.call(appName: 'my-app', env: 'prod')
  
      then:
      // 断言逻辑
      verifyStepCalled('echo', 'Deploying my-app to prod')
  }
  

• 有些情况下，vars脚本可能会使用Jenkins的全局变量（比如env、currentBuild），测试时要确保这些变量被正确Mock，否则脚本执行会失败，自然也没法统计覆盖率。

内容的提问来源于stack exchange，提问作者Christopher