Creating reusable pipeline steps in Jenkins - Practice Exercises

Challenge - 5 Problems

🧠 Conceptual

intermediate

What is the main benefit of using reusable pipeline steps in Jenkins?

Why should you create reusable pipeline steps in Jenkins pipelines?

A To increase the pipeline execution time by adding more steps

B To avoid repeating the same code and make pipelines easier to maintain

C To make the pipeline code more complex and harder to understand

D To prevent the pipeline from running on multiple agents

💡 Hint

Think about how repeating code affects maintenance.

Reusable steps help avoid code duplication, making pipelines simpler and easier to update.

💻 Command Output

intermediate

Output of calling a shared library step in Jenkins pipeline

Given this Jenkinsfile snippet calling a shared library step buildApp(), what will be the output?

Jenkins

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        script {
          buildApp()
        }
      }
    }
  }
}

// Assume buildApp() prints 'Building application...'

A No output, step is skipped

B Error: buildApp() is not defined

C Pipeline fails with syntax error

D Building application...

💡 Hint

Shared library steps are reusable functions defined outside the Jenkinsfile.

If the shared library is properly loaded, calling buildApp() runs its code and prints the message.

❓ Configuration

advanced

How to define a reusable step in a Jenkins shared library

Which of the following is the correct way to define a reusable step named deployApp in a Jenkins shared library?

A def deployApp() { echo 'Deploying application...' }

B step deployApp { echo 'Deploying application...' }

C function deployApp() { echo 'Deploying application...' }

D deployApp() => { echo 'Deploying application...' }

💡 Hint

Shared library steps are usually Groovy methods starting with def.

In Jenkins shared libraries, reusable steps are defined as Groovy methods using def.

🔀 Workflow

advanced

Order of execution in a Jenkins pipeline using reusable steps

Given these reusable steps called in order: checkoutCode(), buildApp(), testApp(), what is the correct order of execution in the pipeline?

A 2,1,3

B 3,2,1

C 1,2,3

D 1,3,2

💡 Hint

Think about the logical order: get code, build, then test.

The pipeline must first checkout code, then build it, and finally run tests.

❓ Troubleshoot

expert

Why does calling a reusable step cause 'No such DSL method' error?

You have defined a reusable step deployApp() in your shared library, but Jenkins pipeline fails with No such DSL method 'deployApp'. What is the most likely cause?

A The shared library is not properly loaded or configured in the pipeline

B The deployApp() method has a syntax error inside its definition

C The Jenkins agent does not have enough memory to run the step

D The pipeline script is missing the <code>agent any</code> declaration

💡 Hint

Check if the shared library is declared in the pipeline or global configuration.

This error usually means Jenkins cannot find the step because the shared library is not loaded or referenced correctly.

Practice

1. What is the main benefit of creating reusable pipeline steps in Jenkins?

easy

A. It automatically fixes syntax errors.

B. It makes the pipeline run faster.

C. It reduces code duplication and simplifies maintenance.

D. It disables pipeline notifications.

Solution

1. Step 1: Understand the purpose of reusable steps

   Reusable steps are designed to avoid repeating the same code multiple times in pipelines.

2. Step 2: Identify the main advantage

   By reusing code, maintenance becomes easier because changes are made in one place, reducing errors and effort.

3. Final Answer:

   It reduces code duplication and simplifies maintenance. -> Option C

4. Quick Check:

   Reusable steps = less duplication [OK]

Hint: Think about saving time and effort by reusing code [OK]

Common Mistakes:

• Confusing speed improvement with code reuse
• Assuming reusable steps fix errors automatically
• Believing reusable steps control notifications

2. Which syntax correctly defines a reusable step named buildApp in a Jenkins pipeline?

easy

A. def buildApp() { echo 'Building app...' }

B. buildApp() { echo 'Building app...' }

C. function buildApp { echo 'Building app...' }

D. step buildApp() { echo 'Building app...' }

Solution

1. Step 1: Recall Groovy function syntax in Jenkins

   Reusable steps are defined as Groovy functions using the def keyword followed by the function name and parentheses.

2. Step 2: Match the correct syntax

   def buildApp() { echo 'Building app...' } uses def buildApp() { ... } which is the correct Groovy function definition.

3. Final Answer:

   def buildApp() { echo 'Building app...' } -> Option A

4. Quick Check:

   Groovy functions start with def [OK]

Hint: Look for 'def' keyword to define functions in Jenkinsfile [OK]

Common Mistakes:

• Omitting 'def' keyword
• Using JavaScript or shell syntax
• Using unsupported keywords like 'step' or 'function'

3. Given the reusable step below, what will be the output when calling buildApp('Test')?

def buildApp(String env) {
  echo "Building for ${env} environment"
}

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        script {
          buildApp('Test')
        }
      }
    }
  }
}

medium

A. No output

B. Building for Test environment

C. Error: Missing parameter

D. Building for env environment

Solution

1. Step 1: Understand the function call with parameter

   The function buildApp takes a string parameter env and prints a message including it.

2. Step 2: Substitute the parameter value

   Calling buildApp('Test') replaces ${env} with 'Test', so the output is 'Building for Test environment'.

3. Final Answer:

   Building for Test environment -> Option B

4. Quick Check:

   Parameter substitution = correct output [OK]

Hint: Replace variables with passed arguments to find output [OK]

Common Mistakes:

• Ignoring parameter substitution
• Assuming default or missing parameter error
• Thinking no output occurs without explicit return

4. Identify the error in this reusable step definition:

def deployApp(env) {
  echo "Deploying to ${environment}"
}

pipeline {
  agent any
  stages {
    stage('Deploy') {
      steps {
        script {
          deployApp('production')
        }
      }
    }
  }
}

medium

A. Parameter name mismatch: 'env' vs 'environment' inside echo

B. Missing 'def' keyword before function name

C. Incorrect pipeline syntax: missing agent label

D. Function call missing parentheses

Solution

1. Step 1: Check parameter usage inside function

   The function defines parameter env but uses ${environment} inside the echo, which is undefined.

2. Step 2: Identify the mismatch causing error

   This mismatch causes a runtime error because environment is not declared or passed.

3. Final Answer:

   Parameter name mismatch: 'env' vs 'environment' inside echo -> Option A

4. Quick Check:

   Parameter names must match exactly [OK]

Hint: Match parameter names exactly inside function body [OK]

Common Mistakes:

• Using different variable names inside function
• Omitting 'def' keyword (not the issue here)
• Incorrect pipeline syntax unrelated to function

5. You want to create a reusable step notifyBuild that sends different messages based on build status. Which code snippet correctly implements this using parameters and conditional logic?

hard

A. def notifyBuild(String status) {
match (status) {
'SUCCESS' -> echo 'Build succeeded!'
'FAILURE' -> echo 'Build failed!'
}
}

B. def notifyBuild(status) {
switch (status) {
case 'SUCCESS': echo 'Build succeeded!'
case 'FAILURE': echo 'Build failed!'
}
}

C. def notifyBuild(String status) {
if status = 'SUCCESS' {
echo 'Build succeeded!'
} else {
echo 'Build failed!'
}
}

D. def notifyBuild(String status) {
if (status == 'SUCCESS') {
echo 'Build succeeded!'
} else {
echo 'Build failed!'
}
}

Solution

1. Step 1: Review correct Groovy conditional syntax

   Groovy uses if (condition) { ... } with double equals == for comparison.

2. Step 2: Analyze each option

   def notifyBuild(String status) { if (status == 'SUCCESS') { echo 'Build succeeded!' } else { echo 'Build failed!' } } uses correct parameter typing, if-else structure, and comparison operator.
   def notifyBuild(status) { switch (status) { case 'SUCCESS': echo 'Build succeeded!' case 'FAILURE': echo 'Build failed!' } } misses breaks in switch, causing fall-through.
   def notifyBuild(String status) { match (status) { 'SUCCESS' -> echo 'Build succeeded!' 'FAILURE' -> echo 'Build failed!' } } uses invalid 'match' syntax in Groovy.
   def notifyBuild(String status) { if status = 'SUCCESS' { echo 'Build succeeded!' } else { echo 'Build failed!' } } uses single equals = instead of == in if condition, causing assignment error.

3. Final Answer:

   def notifyBuild(String status) { if (status == 'SUCCESS') { echo 'Build succeeded!' } else { echo 'Build failed!' } } -> Option D

4. Quick Check:

   Use if (condition == value) for Groovy conditionals [OK]

Hint: Use if with double equals (==) for conditions in Groovy [OK]

Common Mistakes:

• Using single equals (=) instead of double (==) in conditions
• Using unsupported 'match' syntax
• Missing breaks in switch causing fall-through