Pipeline-环境变量

环境变量可以被看作是pipeline与Jenkins交互的媒介。比如，可以在pipeline中通过BUILD_ NUMBER变量知道构建任务的当前构建次数。环境变量可以分为Jenkins内置变量和自定义变量。

Jenkins内置变量

在pipeline执行时，Jenkins通过一个名为env的全局变量，将Jenkins内置环境变量暴露出来。其使用方法有多种，示例如下:

pipeline {
  agent any
  stages {
    stage('Example') {
      steps {
         echo "Running ${env.BUILDNUMBER} on ${env.JENKINS_URL}" # 方法1
         echo "Running $env.BUILDNUMBER on $env.JENKINS_URL"  # 方法2
         echo "Running ${BUILDNUMBER} on ${JENKINS_URL}"   # 方法3 不推荐，难排查      }
    }
  }}

默认env的属性可以直接在pipeline中引用。所以以上方法都是合法的。但是不推荐方法三，因为出现变量冲突时，非常难查问题。

那么，env变量都有哪些可用属性呢? 通过访问<Jenkins master的地址>/pipeline-syntax/globals#env来获取完整列表。在列表中，当一个变量被声明为"For a multibranch project"时，代表只有多分支项目才会有此变量。

下面我们简单介绍几个在实际工作中经常用到的变量:

BUILD_ NUMBER：构建号，累加的数字。在打包时，它可作为制品名称的一部分，比如server-2.jar。
BRANCH_ NAME：多分支pipeline项目支持。当需要根据不同的分支做不同的事情时就会用到，比如通过代码将release分支发布到生产环境中、master分支发布到测试环境中。
BUILD_ URL：当前构建的页面URL。如果构建失败，则需要将失败的构建链接放在邮件通知中，这个链接就可以是BUILD _URL。
GIT BRANCH：通过git拉取的源码构建的项目才会有此变量。

在使用env变量时，需要注意不同类型的项目，env变量所包含的属性及其值是不一样的。比如普通pipeline任务中的GIT BRANCH变量的值为origin/master，而在多分支pipeline任务中GIT BRANCH变量的值为master。

所以，在pipeline中根据分支进行不同行为的逻辑处理时，需要留意。

自定义变量

1. pipeline提供的environment指令中定义

pipeline {
    agent any
    environment {
        // 覆盖默认的PATH变量值
        PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
        name='jack'
    }
    stages {
        stage("test env") {
          steps {
            sh "printenv"  #调试，打印所有env变量
            echo "${name}"  # jack
            echo "${env.name}"  # jack          }
        }
     }
  }

environment指令可以用在pipeline中定义，作用域就是整个pipeline，当定义在stage阶段，只在当前stage有效。

2. 环境变量的互相引用

environment {
  __server_name = 'email-server'
  __version = "${BUILD_NUMBER}"
  __artifact_name = "${__server_name}-${__version}.jar"
}

在调试pipeline时，可以再开始阶段加一句 sh 'printenv' 将所有env变量打印出来。
自定义变量时，为避免命名冲突，可根据项目或公司加上统一前缀，如__server_name，__就是前缀。

3. 自定义全局环境变量

定义全局环境变量可以跨pipeline使用进入Jenkins -- 系统管理 -- 系统配置 -- 全局属性

pipeline {
    agent any

    stages {
        stage('debug') {
            steps {
                echo "-----------------输出---------------"
                sh "printenv"
                echo "-----------------end---------------"
            }
        }
    }
    
    post {
        success {
          script {
          echo "-----------------输出---------------"
            echo "输出:${env.my_test_key}"
          }
        }
  }
}

4.访问预定义的凭证

environment支持一个特殊的助手方法 credentials() ，该方法可用于在Jenkins环境中通过标识符访问预定义的凭证。对于类型为 "Secret Text"的凭证, credentials() 将确保指定的环境变量包含秘密文本内容。对于类型为 "SStandard username and password"的凭证, 指定的环境变量指定为 username:password ，并且两个额外的环境变量将被自动定义 :分别为 MYVARNAME_USR 和 MYVARNAME_PSW 。

pipeline {
    agent any
    environment {
        my_account = credentials('my_account')
    }

    stages {
        stage('debug') {
            steps {
                echo "-----------------输出---------------"
                sh "printenv"
                echo "-----------------end---------------"
            }
        }
    }
    
    post {
        success {
          script {
          echo "-----------------输出---------------"
            // 输出 **** ，即在console中看不到真实信息
            echo "输出:${env.my_account}"
            echo "-----------------end---------------"
            echo "输出凭据Username:${env.my_account_USR}"
            echo "输出凭Password:${env.my_account_PSW}"
          }
        }
  }
}