How to write properly an if statement in regards to a BooleanParameter in Jenkins pipeline Jenkinsfile?

Question

I'm setting a Jenkins pipeline Jenkinsfile and I'd like to check if a booleanparameter is set.

Here's the relevant portion of the file:

node ("master") {
        stage 'Setup' (
                [[$class: 'BooleanParameterValue', name: 'BUILD_SNAPSHOT', value: 'Boolean.valueOf(BUILD_SNAPSHOT)']],

As I understand, that is the way to access the booleanparameter but I'm not sure how to state the IF statement itself.

I was thinking about doing something like:

if(BooleanParameterValue['BUILD_SNAPSHOT']){...

What is the correct way to write this statement please?

Answer 1

A boolean parameter is accessible to your pipeline script in 3 ways:

1. As a bare parameter, e.g: isFoo

2. From the env map, e.g: env.isFoo

3. From the params map, e.g: params.isFoo

If you access isFoo using 1) or 2) it will have a String value (of either "true" or "false").

If you access isFoo using 3) it will have a Boolean value.

So the least confusing way (IMO) to test the isFoo parameter in your script is like this:

if (params.isFoo) {
   ....
}

Alternatively you can test it like this:

if (isFoo.toBoolean()) {
   ....
}​​​​​​​​​​​​​​​​​​

or

if (env.isFoo.toBoolean()) {
   ....
}​​​​​​​​​​​​​​​​​​

the toBoolean() is required to convert the "true" String to a boolean true and the "false" String to a boolean false.