将地图变量导入 Jenkinsfile 环境阶段

Question

我的项目有许多其他项目的通用变量，所以我使用 Jenkins 共享库并创建了一个vars/my_vars.groovy文件，我在其中定义了我的变量并返回了它们的映射：

class my_vars {
    static Map varMap = [:]
    static def loadVars (Map config) {
        varMap.var1 = "val1"
        varMap.var2 = "val2"
        // Many more variables ...

        return varMap
    }
}

我在我的 Jenkinsfile 中加载共享库，并在环境项目符号中调用该函数，因为我希望这些变量作为环境变量。

詹金斯档案：

pipeline {

    environment {
        // initialize common vars
        common_vars = my_vars.loadVars()
    } // environment

    stages {
        stage('Some Stage') {
            // ...
        }
    }

    post {
        always { 
            script {
                // Print environment variables
                sh "env"
            } // script
        } // always
    } // post

} // pipeline

问题是环境项目符号是KEY=VALUE成对的，因此我的地common_vars图像字符串值一样加载（我可以在 上看到sh "env"）。

...
vars=[var1:val1, var2:val2]
...

将这些值声明为环境变量的正确方法是什么？我的目标是：

...
var1=val1
var2=val2
...

Answer 1

管道的环境变量仅存储字符串值。这就是为什么当您将映射分配给env.common_vars变量时，它会存储map.toString()等效项。

如果要将映射中的键值重写为环境变量，则可以迭代变量映射并将每个k-v对分配给类似env."$k" = v. 您可以通过在environment块内调用类方法来做到这一点- 这样您就可以确保环境变量被分配，无论您的管道从哪个阶段重新启动。考虑以下示例：

class MyVars {
    private Map config = [
        var1: "val1",
        var2: "val2"
    ]

    String initializeEnvironmentVariables(final Script script) {
        config.each { k,v ->
            script.env."$k" = v
        }

        return "Initialization of env variables completed!"
    }
}

pipeline {
    agent any

    environment {
        INITIALIZE_ENV_VARIABLES_FROM_MAP = "${new MyVars().initializeEnvironmentVariables(this)}"
    }

    stages {
        stage("Some stage") {
            steps {
                echo "env.var1 = ${env.var1}"
            }
        }
    }

    post {
        always {
            script {
                sh 'printenv | grep "var[0-9]\\+"'
            }
        }
    }
}

在这个例子中，我们使用MyVarsclass 来存储一些全局配置映射（它可以是共享库的一部分，这里为了简单起见，它是 Jenkinsfile 的一部分）。我们使用INITIALIZE_ENV_VARIABLES_FROM_MAP环境变量赋值来调用MyVars.initializeEnvironmentVariables(this)可以env从script参数访问的方法。从environment块内部调用此方法有一个显着的好处 - 即使您从任何阶段重新启动管道，它也能保证环境变量将被初始化。

这是此示例管道的输出：

Running on Jenkins in /home/wololock/.jenkins/workspace/pipeline-env-map
[Pipeline] {
[Pipeline] withEnv
[Pipeline] {
[Pipeline] stage
[Pipeline] { (Some stage)
[Pipeline] echo
env.var1 = val1
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (Declarative: Post Actions)
[Pipeline] script
[Pipeline] {
[Pipeline] sh
+ grep 'var[0-9]\+'
+ printenv
var1=val1
var2=val2
[Pipeline] }
[Pipeline] // script
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // withEnv
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS

正如你所看到的，我们将其设置env.var1和env.var2从封装在地图MyVars类。这两个变量都可以在管道步骤、脚本块甚至 shell 环境变量中访问。