如何访问参数化构建中的参数？

Question

如何parameters在"工作流"Jenkins作业的"此构建参数化"部分中访问set？

测试用例

1. 创建一个WORKFLOW作业.
2. 启用"此构建已参数化".
3. 添加foo具有默认值的STRING PARAMETER bar text.

4. 将以下代码添加到Workflow Script:

   node()
   {
        print "DEBUG: parameter foo = ${env.foo}"
   }
   

5. 跑步工作.

结果

DEBUG: parameter foo = null

Answer 1

我认为在使用Workflow插件时,变量可以直接使用,而不是通过env.尝试:

node()
{
    print "DEBUG: parameter foo = ${foo}"
}

Answer 2

我从这个帖子中尝试了一些解决方案.它似乎有效,但我的价值观总是如此,我也遇到了以下问题: JENKINS-40235

我设法使用jenkinsfile以下语法在groovy中使用参数:params.myVariable

这是一个有效的例子:

解

print 'DEBUG: parameter isFoo = ' + params.isFoo
print "DEBUG: parameter isFoo = ${params.isFoo}"

一个更详细(和工作)的例子:

node() {
   // adds job parameters within jenkinsfile
   properties([
     parameters([
       booleanParam(
         defaultValue: false,
         description: 'isFoo should be false',
         name: 'isFoo'
       ),
       booleanParam(
         defaultValue: true,
         description: 'isBar should be true',
         name: 'isBar'
       ),
     ])
   ])

   // test the false value
   print 'DEBUG: parameter isFoo = ' + params.isFoo
   print "DEBUG: parameter isFoo = ${params.isFoo}"
   sh "echo sh isFoo is ${params.isFoo}"
   if (params.isFoo) { print "THIS SHOULD NOT DISPLAY" }

   // test the true value
   print 'DEBUG: parameter isBar = ' + params.isBar
   print "DEBUG: parameter isBar = ${params.isBar}"
   sh "echo sh isBar is ${params.isBar}"
   if (params.isBar) { print "this should display" }
}

产量

[Pipeline] {
[Pipeline] properties
WARNING: The properties step will remove all JobPropertys currently configured in this job, either from the UI or from an earlier properties step.
This includes configuration for discarding old builds, parameters, concurrent builds and build triggers.
WARNING: Removing existing job property 'This project is parameterized'
WARNING: Removing existing job property 'Build triggers'
[Pipeline] echo
DEBUG: parameter isFoo = false
[Pipeline] echo
DEBUG: parameter isFoo = false
[Pipeline] sh
[wegotrade-test-job] Running shell script
+ echo sh isFoo is false
sh isFoo is false
[Pipeline] echo
DEBUG: parameter isBar = true
[Pipeline] echo
DEBUG: parameter isBar = true
[Pipeline] sh
[wegotrade-test-job] Running shell script
+ echo sh isBar is true
sh isBar is true
[Pipeline] echo
this should display
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS

我发送了一个Pull Request来更新误导性的管道教程#build-parameters引用,它说"它们可以作为同名的Groovy变量访问"..;)

编辑:正如Jesse Glick所指出的那样: 发行说明会详细介绍

您还应该将Pipeline Job Plugin更新为2.7或更高版本,以便将构建参数定义为环境变量,从而可以将它们视为全局Groovy变量.

Answer 3

当你添加一个构建参数foo时,它会被转换为类似"裸变量"的东西,所以在你的脚本中你会这样做:

node {
   echo foo
}

如果查看工作流脚本的实现,您将看到在执行脚本时,会动态生成一个名为WorkflowScript的类.脚本中的所有语句都在此类的上下文中执行.传递给此脚本的所有构建参数都将转换为可从此类访问的属性.

例如,你可以这样做:

node {
    getProperty("foo")
}

如果您很好奇,我写的是一个工作流脚本,它试图在WorkflowScript类上打印出构建参数,环境变量和方法.

node {
   echo "I am a "+getClass().getName()

   echo "PARAMETERS"
   echo "=========="
   echo getBinding().getVariables().getClass().getName()
   def myvariables = getBinding().getVariables()
   for (v in myvariables) {
       echo "${v} " + myvariables.get(v)
   }
   echo STRING_PARAM1.getClass().getName()

   echo "METHODS"
   echo "======="
   def methods = getMetaClass().getMethods()

   for (method in methods) {
       echo method.getName()    
   } 

   echo "PROPERTIES"
   echo "=========="
   properties.each{ k, v -> 
       println "${k} ${v}" 
   }
   echo properties
   echo properties["class"].getName()

   echo "ENVIRONMENT VARIABLES"
   echo "======================"
   echo "env is " + env.getClass().getName()
   def envvars = env.getEnvironment()
   envvars.each{ k, v ->
        println "${k} ${v}"
   }
}

这是我尝试过的另一个代码示例,我想测试一下是否设置了构建参数.

node {
   groovy.lang.Binding myBinding = getBinding()
   boolean mybool = myBinding.hasVariable("STRING_PARAM1")
   echo mybool.toString()
   if (mybool) {
       echo STRING_PARAM1
       echo getProperty("STRING_PARAM1")
   } else {
       echo "STRING_PARAM1 is not defined"
   }

   mybool = myBinding.hasVariable("DID_NOT_DEFINE_THIS")
   if (mybool) {
       echo DID_NOT_DEFINE_THIS
       echo getProperty("DID_NOT_DEFINE_THIS")
   } else {
       echo "DID_NOT_DEFINE_THIS is not defined"
   }
}

Answer 4

给参数变量添加前缀"params".例如:

params.myParam

不要忘记:如果您使用myParam的某些方法,可能应该在"脚本批准"中批准它.

Answer 5

您还可以尝试使用参数指令来使构建参数化并访问参数：

文档： 管道语法：参数

例子：

pipeline{

agent { node { label 'test' } }
options { skipDefaultCheckout() }

parameters {
    string(name: 'suiteFile', defaultValue: '', description: 'Suite File')
}
stages{

    stage('Initialize'){

        steps{

          echo "${params.suiteFile}"

        }
    }
 }

Answer 6

使用双引号而不是单引号

例如echo "$foo",而不是echo '$foo'

如果使用"使用参数构建"选项将管道配置为接受参数,则可以将这些参数作为同名的Groovy变量进行访问.看到这里.

如果不需要执行变量替换;,可以删除分号(),删除括号(( and )),并使用单引号(')而不是double(").看到这里.这让我想到了我的问题,虽然我发现只需要double()才能使它工作."