如何在Jenkins工作流中检测参数化构建参数是否存在

Question

检测参数化构建中是否存在参数的最佳方法是什么？我发现最接近的解决方案是在groovy中这样做：

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"
   }
}

使用getBinding（）是正确的API吗？或者有更好的方法吗？

Answer 1

您可以使用try-catch来检查是否存在参数：

try {
    echo TEST1
    echo 'TEST1 is defined'
} catch (err) {
    echo 'TEST1 is not defined'
}

Answer 2

当您使用Pipelines时，您可以访问对象：params，这是一个Java映射，然后您可以使用：containsKey方法，即：

if(params.containsKey("STRING_PARAM1")) {
   echo "STRING_PARAM1 exists as parameter with value ${STRING_PARAM1}"
} else {
   echo "STRING_PARAM1 is not defined"
}

Answer 3

当您处于Sandbox模式（或通过SCM）时，不允许使用getBinding（）。至少，到目前为止我遇到过这种情况。

到目前为止，我使用的是以下方法，在工作流文件中，在顶部插入以下内容：

properties([[$class: 'ParametersDefinitionProperty', parameterDefinitions: [[$class: 'StringParameterDefinition', defaultValue: 'default_value', description: '', name: 'your_parameter']]]])

这样，您的参数将具有默认值，当它作为生成参数提供时，该值将被覆盖。

Answer 4

您可以在Jenkins的较新版本中使用params变量。

以下是我如何读取参数化构建的PLATFORM参数。它是一个字符串参数。

def platform = params?.PLATFORM?.trim()
stage("checkPlatform") {
  if (platform) {
    echo "Going to build for platform: ${platform}"
    // ...
  } else {
    echo "No platform given. Cancelling build"
    error("No platform given")
  }
}
stage("..."){
    ///...
}

这里有一个教程：https://st-g.de/2016/12/parametrized-jenkins-pipelines

我在上面写了"詹金斯的新版本"。以下是该教程中的定义：

从工作流cps版本2.18开始，一个新的params全局变量也在第一次运行时提供了正常访问（通过返回指定的默认值）。