Stage conditions with when directive in Jenkins - Practice Problems & Coding Challenges

Challenge - 5 Problems

💻 Command Output

intermediate

Output of a stage with a simple when condition

Given the following Jenkins pipeline snippet, what will be the output if the branch name is 'feature-xyz'?

Jenkins

pipeline {
  agent any
  stages {
    stage('Build') {
      when {
        branch 'main'
      }
      steps {
        echo 'Building on main branch'
      }
    }
  }
}

A The stage 'Build' will be skipped and no output from this stage

B The stage 'Build' will run and print 'Building on main branch'

C Pipeline will fail with a syntax error

D The stage 'Build' will run but print nothing

💡 Hint

Check the branch name condition in the when directive.

The when condition specifies the stage runs only on branch 'main'. Since the branch is 'feature-xyz', the stage is skipped.

🧠 Conceptual

intermediate

Understanding multiple conditions in when directive

Which of the following when conditions will cause the stage to run only if the branch is 'develop' and the build is triggered by a user?

A when { branch 'develop' && triggeredBy 'UserIdCause' }

B when { allOf { branch 'develop'; triggeredBy 'UserIdCause' } }

C when { anyOf { branch 'develop'; triggeredBy 'UserIdCause' } }

D when { branch 'develop' || triggeredBy 'UserIdCause' }

💡 Hint

Look for the condition that requires both checks to be true.

The allOf block requires all conditions inside to be true, so the stage runs only if branch is 'develop' and triggered by a user.

❓ Troubleshoot

advanced

Why does this when condition cause a syntax error?

Identify the error in this when directive snippet: when { branch == 'main' }

Jenkins

when {
  branch == 'main'
}

A The when block must be empty

B Missing quotes around 'main'

C The branch condition requires parentheses

D Using '==' inside when block is invalid syntax

💡 Hint

Check the correct syntax for branch condition in when directive.

The when directive uses a keyword style like branch 'main', not an expression with '=='. Using '==' causes syntax error.

🔀 Workflow

advanced

Order of evaluation in multiple when conditions

Given this when directive, in what order are the conditions evaluated? when { allOf { branch 'release' environment name: 'DEPLOY_ENV', value: 'prod' } }

A branch condition is checked first, then environment

B environment condition is checked first, then branch

C Both conditions are checked simultaneously

D Only the branch condition is checked

💡 Hint

Think about how allOf logically works in Jenkins when directive.

Jenkins evaluates conditions in the order written inside allOf, so branch is checked first, then environment.

✅ Best Practice

expert

Choosing the best when condition for skipping stages on pull requests

You want to skip a stage when the build is triggered by a pull request. Which when condition is the best choice?

A when { branch 'PR-*' }

B when { expression { return env.CHANGE_ID == null } }

C when { not { changeRequest() } }

D when { triggeredBy 'PullRequestCause' }

💡 Hint

Consider the official Jenkins way to detect pull requests.

The changeRequest() condition is designed to detect pull requests. Using not { changeRequest() } skips the stage on PR builds.

Practice

1. What is the main purpose of the when directive in a Jenkins pipeline stage?

easy

A. To set the timeout for a stage execution

B. To define environment variables for a stage

C. To specify the agent where the stage runs

D. To control whether a stage runs based on specified conditions

Solution

1. Step 1: Understand the role of when directive

   The when directive is used to decide if a stage should run or be skipped based on conditions.

2. Step 2: Compare with other stage directives

   Other directives like environment, agent, and timeout serve different purposes unrelated to conditional execution.

3. Final Answer:

   To control whether a stage runs based on specified conditions -> Option D

4. Quick Check:

   when controls stage execution [OK]

Hint: Remember: when decides if stage runs or skips [OK]

Common Mistakes:

• Confusing when with environment
• Thinking when sets agent or timeout
• Assuming when always runs the stage

2. Which of the following is the correct syntax to run a stage only on the 'main' branch using the when directive?

easy

A. when {
branch 'main'
}

B. when {
branch == 'main'
}

C. when {
if (branch == 'main')
}

D. when {
branch: 'main'
}

Solution

1. Step 1: Recall correct when syntax for branch condition

   The correct syntax uses branch 'branchName' inside when block without operators or colons.

2. Step 2: Identify syntax errors in other options

   Options B and C use invalid operators or expressions; D uses colon which is incorrect in this context.

3. Final Answer:

   when { branch 'main' } -> Option A

4. Quick Check:

   Use branch 'name' syntax [OK]

Hint: Use branch 'name' without operators in when [OK]

Common Mistakes:

• Using comparison operators inside when
• Adding colons or equal signs incorrectly
• Writing if statements inside when

3. Given the following Jenkins pipeline snippet, what will happen if the branch is 'feature'?

stage('Deploy') {
  when {
    branch 'main'
  }
  steps {
    echo 'Deploying to production'
  }
}

medium

A. The stage will run and print 'Deploying to production'

B. The stage will be skipped and nothing will print

C. The pipeline will fail with a syntax error

D. The stage will run but print nothing

Solution

1. Step 1: Understand the when condition

   The stage runs only if the branch is 'main'. Since the branch is 'feature', the condition is false.

2. Step 2: Determine stage behavior on false condition

   When when condition is false, Jenkins skips the stage and does not execute steps.

3. Final Answer:

   The stage will be skipped and nothing will print -> Option B

4. Quick Check:

   Branch mismatch skips stage [OK]

Hint: If branch doesn't match, stage is skipped silently [OK]

Common Mistakes:

• Assuming stage runs regardless of branch
• Expecting syntax error for valid when
• Thinking stage runs but steps don't print

4. Identify the error in this Jenkins pipeline stage that uses when:

stage('Test') {
  when {
    branch == 'dev'
  }
  steps {
    echo 'Running tests'
  }
}

medium

A. The stage name 'Test' is not allowed

B. Missing agent directive for the stage

C. Using '==' operator inside when is invalid syntax

D. The steps block should be inside when

Solution

1. Step 1: Check when syntax for branch condition

   The when directive expects branch 'name' without operators like '=='.

2. Step 2: Validate other parts of the stage

   Missing agent is allowed if inherited; steps must be outside when; stage name is valid.

3. Final Answer:

   Using '==' operator inside when is invalid syntax -> Option C

4. Quick Check:

   No operators in when branch condition [OK]

Hint: No operators like '==' inside when branch check [OK]

Common Mistakes:

• Using comparison operators inside when
• Placing steps inside when
• Assuming stage name restrictions

5. You want a Jenkins stage to run only when the branch is 'release' and an environment variable DEPLOY is set to 'true'. Which when directive correctly implements this?

hard

A. when {
allOf {
branch 'release'
environment name: 'DEPLOY', value: 'true'
}
}

B. when {
branch 'release' && environment name: 'DEPLOY', value: 'true'
}

C. when {
branch 'release'
environment 'DEPLOY': 'true'
}

D. when {
anyOf {
branch 'release'
environment name: 'DEPLOY', value: 'true'
}
}

Solution

1. Step 1: Understand combining conditions in when

   To require both conditions, use allOf block combining branch and environment.

2. Step 2: Analyze each option's logic

   when {
     allOf {
       branch 'release'
       environment name: 'DEPLOY', value: 'true'
     }
   }

   correctly uses allOf.

   when {
     branch 'release' && environment name: 'DEPLOY', value: 'true'
   }

   uses invalid syntax with '&&'.

   when {
     branch 'release'
     environment 'DEPLOY': 'true'
   }

   uses invalid syntax for environment condition (missing name: and value:).

   when {
     anyOf {
       branch 'release'
       environment name: 'DEPLOY', value: 'true'
     }
   }

   uses anyOf, meaning either condition suffices.

3. Final Answer:

   when { allOf { branch 'release' environment name: 'DEPLOY', value: 'true' } } -> Option A

4. Quick Check:

   Use allOf to combine multiple when conditions [OK]

Hint: Use allOf to require all conditions true [OK]

Common Mistakes:

• Using '&&' inside when block
• Using environment 'VAR': 'value' shorthand syntax
• Using anyOf when all conditions are needed