如何Mock Jenkins自定义Groovy步骤调用的内置方法且不修改原脚本？

核心原理 #

通过GroovyShell.parse()加载.groovy脚本得到的是Groovy内置Script类的实例，Groovy支持动态给实例注入方法（即猴子补丁），不需要修改原脚本代码，就能覆盖Jenkins运行时的内置方法。

最初报错的原因 #

你在测试类中直接定义echo方法不生效，是因为脚本执行时只会在自身的命名空间查找方法，不会自动继承测试类的上下文方法。

全局统一Mock的实现方案 #

你最终调整的实例声明顺序和@Before绑定逻辑是正确的：需要先在测试类全局声明脚本实例，再在@Before方法（每个测试用例执行前都会触发）中统一注入Mock方法，所有测试用例都可以复用，不需要每个用例重复定义。

完整可用的测试代码示例 #

class MyCustomStepTest {
    // 先在测试类全局实例化自定义step脚本
    def myCustomStep = new GroovyShell().parse( new File( 'vars/myCustomStep.groovy' ) )

    // 每个测试用例执行前都会执行该方法，统一注入所有需要Mock的Jenkins方法
    @Before
    public void setUp() throws Exception {
        // Mock echo方法
        myCustomStep.echo = { String message -> 
            println "Mock echo: $message"
            // 这里还可以加断言逻辑，比如验证输出的内容是否符合预期
        }
        // 如果有其他需要Mock的Jenkins内置方法，比如sh、readFile等，都可以在这里统一添加
        myCustomStep.sh = { String command ->
            println "Mock sh执行命令: $command"
            return "mock返回值"
        }
    }

    @Test
    public void "测试自定义step参数传递正常"() throws Exception {
        // 直接调用，不需要再单独定义Mock方法
        myCustomStep paramOne: "测试参数"
    }

    @Test
    public void "其他测试用例"() throws Exception {
        // 同样可以直接调用，复用setUp里的Mock逻辑
        myCustomStep paramOne: "另一个测试参数"
    }
}

进阶：批量Mock所有Jenkins方法（可选） #

如果你需要Mock的Jenkins内置方法非常多，还可以通过修改脚本实例的元类一次性批量注入，避免重复赋值：

@Before
public void setUp() throws Exception {
    def mockMethods = [
        echo: { String msg -> println "Mock echo: $msg" },
        sh: { String cmd -> "mock sh返回" },
        readFile: { String path -> "mock文件内容" }
    ]
    myCustomStep.metaClass {
        mockMethods.each { methodName, impl ->
            "$methodName" impl
        }
    }
}

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