Jenkins共享库Helper类无法打印控制台及调用error方法问题

问题背景 #

我有一个Jenkins共享库，在src/org/helpers路径下存在Groovy文件ErrorHolder.groovy，代码如下：

package org.helpers

class ErrorHolder {
    private String message = ""

    def echo_error(String msg) {
        println "[\033[91;1mError\033[0m] ${msg}"
    }

    def emit_error(String msg) {
        echo_error(msg)
        message = msg
        error(msg)
    }

    def getMessage() {
        return message
    }
}

流水线中初始化该类并调用emit_error方法的代码：

import org.helpers.*

void call () {
    currentBuild.result = 'SUCCESS'
    ErrorHolder errorHolder = new ErrorHolder()

    pipeline {
        agent any
        options { ansiColor('xterm') }

        stages {
            stage ('Clean Workspace') {
                steps {
                    script {
                        println "Debug: $errorHolder"
                        errorHolder.emit_error("Test Error")
                    }
                }
            }
        }
    }
}

实际运行时，调试打印语句println "Debug: $errorHolder"能正常输出，但echo_error方法中的println无控制台输出，同时报错：

hudson.remoting.ProxyException: groovy.lang.MissingMethodException: No signature of method: org.helpers.ErrorHolder.error() is applicable for argument types

需要解决两个问题：

1. 如何在该自定义类中调用Jenkins内置的error函数？
2. 如何让echo_error方法中的打印语句生效？

解决方案 #

问题1：调用Jenkins内置error函数 #

Jenkins的内置步骤（如error、echo）属于流水线上下文对象，自定义类默认无法直接访问。解决方式是将流水线上下文传递给自定义类：

1. 修改ErrorHolder类，添加构造函数接收并保存流水线上下文：

package org.helpers

class ErrorHolder {
    private String message = ""
    private def pipelineContext

    // 构造函数接收流水线上下文
    ErrorHolder(def context) {
        this.pipelineContext = context
    }

    def echo_error(String msg) {
        println "[\033[91;1mError\033[0m] ${msg}"
    }

    def emit_error(String msg) {
        echo_error(msg)
        message = msg
        // 通过上下文调用Jenkins内置error方法
        pipelineContext.error(msg)
    }

    def getMessage() {
        return message
    }
}

2. 在流水线的script块中初始化类时，传入当前上下文（this）：

script {
    println "Debug: $errorHolder"
    // 传入当前script块的上下文
    ErrorHolder errorHolder = new ErrorHolder(this)
    errorHolder.emit_error("Test Error")
}

问题2：让echo_error中的打印语句生效 #

自定义类中的println默认输出到Jenkins系统日志，而非流水线控制台。要让输出显示在控制台，需使用Jenkins内置的echo步骤，通过传递的上下文调用：

修改ErrorHolder的echo_error方法：

def echo_error(String msg) {
    // 使用流水线上下文的echo方法输出到控制台
    pipelineContext.echo "[\033[91;1mError\033[0m] ${msg}"
}

修改完成后，错误信息会直接显示在流水线控制台，同时error方法可正确触发流水线失败。

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