如果参数化构建参数存在与否，如何在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

当您使用管道时，您可以访问该对象：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 2

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

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

Answer 3

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

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

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

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

Answer 4

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

以下是我如何阅读参数化构建的PLATFORM参数。它是一个String参数。

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

我上面写了“Jenkins的新版本”。以下是该教程的定义：

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