如何Mock Jenkins Pipeline中TestBuild类依赖的含script/sh的Jenkins对象？

针对你在Jenkinsfile中调用TestBuild类并传入Jenkins对象的场景，最靠谱的Mock方案是结合Spock框架来实现——毕竟Spock对Groovy的语法支持拉满，而且是Jenkins生态里做单元测试的主流选择，能轻松处理Jenkins对象的方法调用和闭包逻辑。

核心思路 #

你的TestBuild类依赖Jenkins对象的两个关键操作：script闭包和sh命令。Mock的核心就是模拟这两个方法的行为，同时验证它们是否被正确调用。

具体实现步骤（Spock示例） #

首先，确保你的测试环境引入了Spock依赖（如果是Jenkins共享库测试，通常在build.gradle里添加Spock的依赖）。然后编写如下测试用例：

import spock.lang.Specification
import org.jenkinsci.plugins.workflow.cps.CpsScript

class TestBuildSpec extends Specification {
    def "Verify build method executes the expected sh command"() {
        given:
        // Mock Jenkins对象（Jenkinsfile中的this本质是CpsScript实例）
        def mockJenkins = Mock(CpsScript)
        def testBuild = new TestBuild()

        when:
        testBuild.build(mockJenkins)

        then:
        // 验证script方法被调用1次，并且处理传入的闭包
        1 * mockJenkins.script(_) >> { Closure closure ->
            // 把闭包的委托设置为Mock对象，确保闭包内的sh调用指向Mock
            closure.delegate = mockJenkins
            closure.call()
        }
        // 验证sh方法被调用，参数完全匹配预期
        1 * mockJenkins.sh(returnStdout: true, script: "echo build")
    }
}

关键细节解释 #

1. Mock对象类型：Jenkinsfile中传入的“Jenkins对象”实际上是CpsScript的实例，所以我们Mock这个类型；如果你的代码里是自定义的Jenkins工具类，就Mock对应的自定义类型即可。
2. 闭包处理：script方法接收一个闭包，必须把闭包的delegate设置为Mock对象，否则闭包内调用的jenkins.sh会找不到Mock的方法，导致测试失败。
3. 交互验证：Spock的1 * mockJenkins.method()语法可以精准验证方法被调用的次数和参数，确保你的TestBuild类逻辑符合预期。

备选方案：Groovy原生MockFor #

如果不想引入Spock，也可以用Groovy自带的MockFor类，但它的交互验证能力不如Spock直观，适合简单场景：

import groovy.mock.interceptor.MockFor
import org.jenkinsci.plugins.workflow.cps.CpsScript

def testTestBuild() {
    def mockJenkins = new MockFor(CpsScript)
    
    // 定义script方法的行为
    mockJenkins.demand.script { Closure c ->
        c.delegate = mockJenkins.proxy
        c.call()
    }
    
    // 定义sh方法的行为并做断言
    mockJenkins.demand.sh { Map params ->
        assert params.returnStdout == true
        assert params.script == "echo build"
        return "build"
    }

    // 在Mock上下文里执行测试
    mockJenkins.use {
        def testBuild = new TestBuild()
        testBuild.build(mockJenkins.proxy)
    }
}

总结 #

• 优先选择Spock框架，它的语法简洁，交互验证能力强，是Jenkins Groovy代码测试的标准方案。
• 务必处理好闭包的delegate，否则闭包内的方法调用无法命中Mock对象。
• 通过方法调用次数和参数的验证，确保你的TestBuild类逻辑正确。

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