CODEWITHSUNDEEP
jenkinsjenkins-pipeline
domruf
domruf

Reputation: 1563

How to check if build parameter is available in Jenkinsfile

I have a pipeline script that should work with and without parameters. So I have to check if the parameter is available.

I tried if(getBinding().hasVariable("myparameter")) but this leads to an Exception

org.jenkinsci.plugins.scriptsecurity.sandbox.RejectedAccessException: Scripts not permitted to use method groovy.lang.Binding getVariables

Is there another way to check if the job is parameterized?

Upvotes: 19

Views: 86980

Answers (5)

Aviv
Aviv

Reputation: 14477

The problem: Avoiding null parameters or not configured one's in your pipeline job

Solution: You've got 2 options in order to set default configuration to variables in declarative pipelines

Option 1. Using jenkins ability to set parameters scope fallback , this affect your pipeline configuration on job in jenkins (if your configure things in your declarative pipeline it will override your configuration in job parameters). 

parameters{    
  booleanParam(defaultValue: false, description: 'some description', name: 'SOME_FLAG')
}

Option 2. Securing your variables yourself, check if variable is not null and then assign the variable in the pipeline , this functionality doesn't affect your job configuration and it's better in my opinion:

some_flag = params.SOME_FLAG != null ? params.SOME_FLAG.toBoolean() : false

Upvotes: 1

user1428570
user1428570

Reputation: 211

This is how I did that: 

def myParam = false
if (params.myParam != null){
    myParam = params.myParam
}

Why do that at all when you can just define parameters in your pipeline as suggested above?

Well, there are situations when you want your pipeline file to work regardless of if parameter is defined or not. I.e., if you're re-using your pipeline script from different Jenkins jobs and you don't want to make people define that parameter ...

Upvotes: 19

StephenKing
StephenKing

Reputation: 37620

Newer versions make the parameters available through the params variable. If the parameter is not defined, it falls back to the configured default (see also here).

Upvotes: 7

Gerold Broser
Gerold Broser

Reputation: 14762

See Getting Started with Pipeline, Build Parameters:

Build Parameters

If you configured your pipeline to accept parameters using the Build with Parameters option, those parameters are accessible as Groovy variables of the same name.

UPDATE

  • ☑This build is parameterized → Add parameter → String Parameter:

    • Name: STRING_PARAMETER
    • Default Value: STRING_PARAMETER_VALUE

  • Pipeline → Definition: Pipeline script → Script:

def stringParameterExists = true
def otherParameterExists = true

try {
  println "  STRING_PARAMETER=$STRING_PARAMETER"
  }
catch (MissingPropertyException e) {
  stringParameterExists = false
  }  

try {
  println "  NOT_EXISTING_PARAMETER=$NOT_EXISTING_PARAMETER"
  }
catch (MissingPropertyException e) {
  otherParameterExists = false
  }

println "  stringParameterExists=$stringParameterExists"
println "  otherParameterExists=$otherParameterExists"

Console Output:

[Pipeline] echo
  STRING_PARAMETER=STRING_PARAMETER_VALUE
[Pipeline] echo
  stringParameterExists=true
[Pipeline] echo
  otherParameterExists=false
[Pipeline] End of Pipeline
Finished: SUCCESS

Upvotes: 6

Steven
Steven

Reputation: 2275

In the latest version of jenkins println(getBinding().hasVariable("myparameter")) is permitted and does not give an error any more.

Upvotes: 11

Related Questions