Jenkins共享库实例化util类并在workflowscript中使用

Question

我正在创建自己的Jenkins共享库，以便在管道之间重用一些代码。我知道如何创建步骤（确实很容易），但是当我想在jenkinsfile中访问我的“utils类”（或者如Jenkins在日志中所说的工作流脚本）时，我有一个问题。我叫"Util类"位于文件夹src/我的/域/...，有很多方法，例如，我想创建一个日志类，这样：

# src/my/domain/group

package my.domain.group

class Console implements Serializable {

    def log(msg) {
        spit(msg, '\033[34m')
    }

    def error(msg) {
        spit(msg, '\033[31m')
    }

    def warning(msg){
        spit(msg, '\033[33m')
    }

    def success(msg){
        spit(msg, '\033[32m')
    }

    private def spit(msg, color){
        ansiColor('xterm') {
            echo color + msg + '\033[0m'
        }
    }

}

然后我尝试在/vars/library中的一个文件中实例化。groovy so可以通过一些代码从Jenkins文件访问，例如：

node("mynode"){
   console.log("Hello World!")
} 

这个想法是为了避免在所有脚本中实例化控制台并自动执行，我已经尝试了一些事情，比如

# vars/library.groovy

import my.domain.group.Console
import groovy.transform.Field

@Field String console = new Console() 

或者

# vars/library.groovy

import my.domain.group.Console

def load(){
    this.console = new Console() 
    // And also
    console = new Console()
}

但是当试图从jenkins文件访问时，我总是会得到一个错误：groovy。lang.MissingPropertyException:没有此类属性：类的控制台：WorkflowScript

我知道这意味着实例不在正确的范围内，所以脚本不能直接看到，但是我怎么做呢？

谢谢

Answer 1

看起来您在Jenkins文件中错误地使用了vars脚本，但我将尝试解决一些困惑：）

>

vars目录中定义的Groovy脚本在您的Jenkins文件中以文件名作为“自定义”步骤调用。假设您的脚本名保留在库中。groovy，您的Jenkins文件应该如下所示

node ("mynode") {
     library("Hello World!")
} 

或者（因为括号是可选的）

node ("mynode") {
     library "Hello World!"
}

此外，vars脚本应该只包含一个名为call的函数和必要的导入。由于您希望将日志消息作为字符串传递，因此call函数还需要一个参数。所以你的library.groovy脚本在vars中可以看起来像这样

# vars/library.groovy

import my.domain.group.Console

def call(msg){
    Console console = new Console(steps) 
    console.log(msg)
}

在call函数中，您可以像在Jenkins文件中一样使用所有基本Jenkins步骤（sh，bat，等等），以及通过import导入的任何Groovy/Java类（如控制台类）。

您可能已经注意到，我还添加了一个步骤变量（不需要手动声明或实例化）到您的控制台类的构造函数中。这是必要的，因为您不能直接在src目录中定义的任何类中使用任何Jenkins步骤。结果，方法

private def spit(msg, color){           
    ansiColor('xterm') {
        echo color + msg + '\033[0m'
    }
}

不起作用，因为echo是詹金斯步骤。为了在类中使用echo，可以将步骤变量传递给构造函数，并将其存储在类中的另一个变量中。然后可以调用所有Jenkins步骤，如步骤。回显“Hello World”

# src/my/domain/group

package my.domain.group

class Console implements Serializable {

     def steps

     Console(steps) {
         this.steps = steps
     }

     def log(msg) {
         spit(msg, '\033[34m')
     }

     def error(msg) {
         spit(msg, '\033[31m')
     }

     def warning(msg){
         spit(msg, '\033[33m')
     }

     def success(msg){
         spit(msg, '\033[32m')
     }

     private def spit(msg, color){
         ansiColor('xterm') {
             steps.echo color + msg + '\033[0m'
         }
     }
}

这应该会让它起作用。

您应该考虑重命名库。groovyinsidevarsthough（例如myLog.groovy）。那么你的Jenkins文件可能是这样的

node ("mynode") {
    myLog "Hello World!"
}

为了使用控制台类的其他方法，您可以在变量中创建其他脚本。使用它们可能看起来像这样

node ("mynode") {
    myLog "Hello World!"
    myWarning "Hello World!"
    myError "Hello World!"
    mySuccess "Hello World!"
}

（im使用my前缀以避免与已存在的Jenkins步骤发生名称冲突。例如，错误步骤已经存在，在Jenkinsfile中调用它将取消您的构建）

有关共享库的更多信息，请查看Jenkins留档https://jenkins.io/doc/book/pipeline/shared-libraries/

您可以在https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/找到所有基本Jenkins步骤的完整列表

让Jenkins和管道工作可能是一个巨大的麻烦，但最终它是值得的。我希望这段文字能对你有所帮助。祝你好运和快乐：）