Question

我正在做一个简单的管道：

构建 - ＆gt;分期 - ＆gt;生产

我需要不同的环境变量用于登台和制作，所以我正在尝试源变量。

sh 'source $JENKINS_HOME/.envvars/stacktest-staging.sh'

但它返回未找到

[Stack Test] Running shell script
+ source /var/jenkins_home/.envvars/stacktest-staging.sh
/var/jenkins_home/workspace/Stack Test@tmp/durable-bcbe1515/script.sh: 2: /var/jenkins_home/workspace/Stack Test@tmp/durable-bcbe1515/script.sh: source: not found

路径是正确的，因为我在通过ssh登录时运行相同的命令，并且工作正常。

以下是管道理念：

node {
    stage name: 'Build'
    // git and gradle build OK
    echo 'My build stage'

    stage name: 'Staging'
    sh 'source $JENKINS_HOME/.envvars/stacktest-staging.sh' // PROBLEM HERE
    echo '$DB_URL' // Expects http://production_url/my_db
    sh 'gradle flywayMigrate' // To staging
    input message: "Does Staging server look good?"    

    stage name: 'Production'
    sh 'source $JENKINS_HOME/.envvars/stacktest-production.sh'
    echo '$DB_URL' // Expects http://production_url/my_db
    sh 'gradle flywayMigrate' // To production
    sh './deploy.sh'
}

我该怎么办？

我在考虑不使用管道（但我无法使用我的Jenkins文件）。
使用EnvInject插件为舞台和制作制作不同的作业（但我丢失了舞台视图）
或者使用Env（但代码变大了，因为今天我正在使用12个env vars）

Answer 1

从文件加载环境变量的一种方法是加载Groovy文件。

例如：

我们假设您在$ JENKINS_HOME / .envvars＆＃39;中有一个groovy文件。叫做'stacktest-staging.groovy＆＃39;。
在此文件中，您可以定义要加载的2个环境变量
```
env.DB_URL="hello"
env.DB_URL2="hello2"
```

然后您可以使用

加载它

load "$JENKINS_HOME/.envvars/stacktest-staging.groovy"

然后您可以在后续的echo / shell步骤中使用它们。

例如，这是一个简短的管道脚本：

node {
   load "$JENKINS_HOME/.envvars/stacktest-staging.groovy"
   echo "${env.DB_URL}"
   echo "${env.DB_URL2}"
}

Answer 2

从评论到accepted answer

不要使用全局'env'，而是使用'withEnv'构造，例如：问题＃9：不要在top 10 best practices jenkins pipeline plugin

中设置带有全局环境的env变种

在下面的例子中：VAR1是一个普通的java字符串（没有groovy变量扩展），VAR2是一个groovy字符串（所以变量'someGroovyVar'被展开）。

传递的脚本是一个普通的java字符串，因此$ VAR1和$ VAR2按字面传递给shell，而echo正在访问环境变量VAR1和VAR2。

stage('build') {
    def someGroovyVar = 'Hello world'
    withEnv(['VAR1=VALUE ONE',
             "VAR2=${someGroovyVar}"
            ]) {
        def result = sh(script: 'echo $VAR1; echo $VAR2', returnStdout: true)
        echo result
    }
}

对于秘密/密码，您可以使用credentials binding plugin

示例：

注意：CREDENTIALS_ID1是Jenkins设置上注册的用户名/密码。

stage('Push') {
    withCredentials([usernamePassword(
                         credentialsId: 'CREDENTIALS_ID1',
                         passwordVariable: 'PASSWORD',
                         usernameVariable: 'USER')]) {
        echo "User name: $USER"
        echo "Password:  $PASSWORD"
    }
}

jenkisn控制台日志输出隐藏了实际值：

[Pipeline] echo
User name: ****
[Pipeline] echo
Password:  ****

Jenkins和凭据是个大问题，可能会看到：credentials plugin

为了完整性：大多数时候，我们需要环境变量中的秘密，因为我们在shell脚本中使用它们，所以我们将withCredentials和withEnv结合起来如下：

stage('Push') {
    withCredentials([usernamePassword(
                         credentialsId: 'CREDENTIALS_ID1',
                         passwordVariable: 'PASSWORD',
                         usernameVariable: 'USER')]) {
        withEnv(["ENV_USERNAME=${USER}",
                 "ENV_PASSWORD=${PASSWORD}"
            ]) {
                def result = sh(script: 'echo $ENV_USERNAME', returnStdout: true)
                echo result

        }
    }
}

Answer 3

使用声明性管道，您可以在一行中完成此操作（将path更改为您的值）：

script {
  readProperties(file: path).each {key, value -> env[key] = value }
}

Answer 4

解决此安装“ Pipeline Utility Steps”插件的另一种方法，为我们提供了readProperties方法（有关参考，请转到链接https://jenkins.io/doc/pipeline/steps/pipeline-utility-steps/#pipeline-utility-steps）在示例中，我们可以看到它们将键存储在数组中，并使用键来检索值。但是在那种情况下，生产中的问题就像是我们稍后在属性文件中添加任何变量一样，该变量也需要添加到Jenkins文件数组中。为了摆脱这种紧密的联系，我们可以这样编写代码，以便Jenkins构建环境可以自动获取有关Property文件中当前存在的所有现有键的信息。这是参考的示例

def loadEnvironmentVariables(path){
    def props = readProperties  file: path
    keys= props.keySet()
    for(key in keys) {
        value = props["${key}"]
        env."${key}" = "${value}"
    }
}

客户端代码类似于

path = '\\ABS_Output\\EnvVars\\pic_env_vars.properties'
loadEnvironmentVariables(path)

Answer 5

使用withEnv（）传递文件中的环境变量，该文件由新行分割并转换为列表：

writeFile file: 'version.txt', text: 'version=6.22.0'
withEnv(readFile('version.txt').split('\n') as List) {
    sh "echo ${version}"
}

Answer 6

如果您使用的是Jenkins 2.0，则可以加载属性文件（该文件包含所有必需的环境变量及其对应的值），并自动读取其中列出的所有环境变量，并将其注入Jenkins提供的env实体中。

这是一种执行上述操作的方法。

def loadProperties(path) {
    properties = new Properties()
    File propertiesFile = new File(path)
    properties.load(propertiesFile.newDataInputStream())
    Set<Object> keys = properties.keySet();
    for(Object k:keys){
    String key = (String)k;
    String value =(String) properties.getProperty(key)
    env."${key}" = "${value}"
    }
}

要调用此方法，我们需要将属性文件的路径作为字符串变量传递。例如，在groovy脚本的Jenkins文件中，我们可以这样调用

path = "${workspace}/pic_env_vars.properties"
loadProperties(path)

请问我是否有疑问

Answer 7

这是外部化环境变量并将其加载到Jenkins管道执行中的完整示例。管道是用declarative style编写的。

stage('Reading environment variable defined in groovy file') {
            steps {
                script {
                    load "./pipeline/basics/extenvvariable/env.groovy"
                    echo "${env.env_var1}"
                    echo "${env.env_var2}"
                }
            }
        }

完整的代码示例： https://github.com/dhruv-bansal/jenkins-pipeline-exploration/blob/master/pipeline/basics/extenvvariable/Jenkinsfile

仅从带有管道代码的groovy文件中加载变量。 https://github.com/dhruv-bansal/jenkins-pipeline-exploration/blob/master/pipeline/basics/extenvvariable/env.groovy

当您创建可在团队之间使用的通用管道时，此模式非常方便。您可以在此类常规文件中外部化因变量，每个团队都可以根据其生态系统定义其值。

Answer 8

另一种解决方案是使用自定义方法而不允许使用诸如new Properties()之类的额外权限，这会在允许之前导致此错误：

org.jenkinsci.plugins.scriptsecurity.sandbox.RejectedAccessException: Scripts not permitted to use new java.util.Properties

或添加额外的插件方法，例如readProperties。

这是一种以以下格式读取名为env_vars的简单文件的方法：

FOO=bar
FOO2=bar

pipeline {
<... skipped lines ...>
    script {
        loadEnvironmentVariablesFromFile("env_vars")

        echo "show time! ${BAR} ${BAR2}"
    }
<... skipped lines ...>
}

private void loadEnvironmentVariablesFromFile(String path) {
    def file = readFile(path)
    file.split('\n').each { envLine ->
        def (key, value) = envLine.tokenize('=')
        env."${key}" = "${value}"
    }
}

使用环境变量Jenkins Pipeline加载文件

8 个答案: