如何在Jenkinsfile引用的Groovy脚本中定义Declarative Pipeline？

问题场景 #

我有一套Jenkins环境，不同类型的测试任务对应独立的Jenkinsfile，各文件中的流水线定义高度相似。为减少代码重复，尝试将流水线定义移至Groovy脚本的函数中，通过参数区分不同流水线的差异，但未能成功运行。直接在Jenkinsfile中可正常执行的“Hello World”流水线，放到Groovy脚本函数中就报错。

Jenkinsfile代码 #

def integrationTestsModule = evaluate readTrusted("jenkins/integration_tests.groovy")
integrationTestsModule.defineTestPipeline()

jenkins/integration_tests.groovy代码 #

def defineTestPipeline() {
    pipeline {
        agent {
            node {
                label "clang11-it"
            }
        }

        options {
            disableConcurrentBuilds()
        }

        stages {
            stage('build') {
                steps {
                    sh 'echo "Hello world!"'
                }
            }
        }
    }
}

错误信息 #

21:28:13  java.lang.NoSuchMethodError: No such DSL method 'options' found among steps [...] or symbols [...] or globals [...]
21:28:13    at org.jenkinsci.plugins.workflow.cps.DSL.invokeMethod(DSL.java:219)
21:28:13    at org.jenkinsci.plugins.workflow.cps.CpsScript.invokeMethod(CpsScript.java:124)
...

问题原因 #

Jenkins声明式流水线的DSL关键字（比如pipeline、options、stages等）只能在Jenkinsfile的顶级上下文，或者被pipeline()方法直接接收的闭包中被识别。当你把pipeline {...}直接写在普通Groovy函数内部时，这段代码的执行上下文是Groovy函数的本地上下文，而非Jenkins的CPS脚本上下文，导致Jenkins无法识别这些DSL方法，从而抛出找不到options的错误。

解决办法 #

方法1：让Groovy函数返回流水线闭包，在Jenkinsfile中调用pipeline()方法 #

修改jenkins/integration_tests.groovy，让函数返回流水线的配置闭包，而不是直接定义pipeline：

def defineTestPipeline() {
    return {
        agent {
            node {
                label "clang11-it"
            }
        }

        options {
            disableConcurrentBuilds()
        }

        stages {
            stage('build') {
                steps {
                    sh 'echo "Hello world!"'
                }
            }
        }
    }
}

然后修改Jenkinsfile，调用pipeline()方法并传入这个闭包：

def integrationTestsModule = evaluate readTrusted("jenkins/integration_tests.groovy")
pipeline(integrationTestsModule.defineTestPipeline())

方法2：支持参数化的通用流水线（适配不同任务差异） #

如果需要通过参数区分不同流水线的配置（比如不同节点标签），可以在Groovy函数中添加参数，动态生成流水线闭包：

// jenkins/integration_tests.groovy
def defineTestPipeline(String nodeLabel) {
    return {
        agent {
            node {
                label nodeLabel
            }
        }

        options {
            disableConcurrentBuilds()
        }

        stages {
            stage('build') {
                steps {
                    sh 'echo "Hello world!"'
                }
            }
        }
    }
}

Jenkinsfile中传入参数调用：

def integrationTestsModule = evaluate readTrusted("jenkins/integration_tests.groovy")
pipeline(integrationTestsModule.defineTestPipeline("clang11-it"))

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