Try-catch-finally in pipelines in Jenkins - Mini Project: Build & Apply

Try-catch-finally in Jenkins Pipelines

📖 Scenario: You are creating a Jenkins pipeline script to automate a simple build process. Sometimes the build step might fail, and you want to handle errors gracefully. You also want to always run a cleanup step at the end, no matter if the build succeeded or failed.

🎯 Goal: Build a Jenkins pipeline script that uses try, catch, and finally blocks to run a build step, handle any errors by printing a message, and always run a cleanup step.

📋 What You'll Learn

Create a pipeline block with agent any

Inside stages, create a stage named Build

Use try block to run a shell command sh 'exit 1' to simulate failure

Use catch block to catch errors and print Build failed

Use finally block to print Cleaning up

💡 Why This Matters

🌍 Real World

In real Jenkins pipelines, builds can fail due to many reasons. Using try-catch-finally helps keep the pipeline stable and ensures cleanup steps always run.

💼 Career

Understanding error handling in Jenkins pipelines is essential for DevOps engineers to create reliable automation scripts.

1

Create the basic Jenkins pipeline structure

Create a Jenkins pipeline with agent any and an empty stages block.

Jenkins

pipeline {
    agent any
    stages {
        // Your code here
    }
}

Hint

Start by writing pipeline { agent any stages { } to set up the pipeline skeleton.

2

Add a Build stage with a try block

Inside stages, add a stage named Build with a steps block. Inside steps, add a script block containing a try block that runs sh 'exit 1' to simulate a failure.

Jenkins

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    // Your code here
                }
            }
        }
    }
}

Hint

Use stage('Build') and inside steps add script { try { sh 'exit 1' } }.

3

Add catch and finally blocks

Inside the script block, after the try block, add a catch (err) block that prints Build failed using echo. Then add a finally block that prints Cleaning up using echo.

Jenkins

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    try {
                        sh 'exit 1'
                    }
                    // Your code here
                }
            }
        }
    }
}

Hint

After try, add catch (err) { echo 'Build failed' } and finally { echo 'Cleaning up' }.

4

Print the final pipeline script output

Run the pipeline script and observe the output. The output should include Build failed and Cleaning up messages.

Jenkins

// Run the pipeline and check the console output

Hint

Look at the Jenkins console output after running the pipeline. You should see both messages printed.

Practice

1. What is the main purpose of using try-catch-finally blocks in Jenkins pipelines?

easy

A. To create parallel stages automatically

B. To speed up the pipeline execution

C. To handle errors and ensure cleanup actions run

D. To deploy applications to production

Solution

1. Step 1: Understand the role of try-catch-finally

   The try block runs code that might fail, catch handles errors, and finally runs cleanup code regardless of success or failure.

2. Step 2: Identify the main purpose in Jenkins pipelines

   This structure helps manage errors gracefully and ensures cleanup steps always run, making pipelines reliable.

3. Final Answer:

   To handle errors and ensure cleanup actions run -> Option C

4. Quick Check:

   Error handling and cleanup = A [OK]

Hint: Remember: try for risky code, catch errors, finally cleans up [OK]

Common Mistakes:

• Thinking try-catch-finally speeds up pipelines
• Confusing try-catch-finally with deployment steps
• Assuming finally runs only on success

2. Which of the following is the correct syntax to catch an exception in a Jenkins scripted pipeline?

easy

A. try { ... } catch Exception e { ... } finally { ... }

B. try { ... } catch(Exception e) { ... } finally { ... }

C. try { ... } catch { Exception e } finally { ... }

D. try: { ... } except(Exception e) { ... } finally { ... }

Solution

1. Step 1: Recall Jenkins scripted pipeline syntax

   Jenkins scripted pipelines use Groovy syntax, where try { ... } catch(Exception e) { ... } finally { ... } is correct.

2. Step 2: Identify syntax errors in other options

   Options A, B, and C have incorrect keywords or misplaced braces not valid in Groovy.

3. Final Answer:

   try { ... } catch(Exception e) { ... } finally { ... } -> Option B

4. Quick Check:

   Groovy try-catch syntax = D [OK]

Hint: Groovy uses catch(Exception e) with braces, not colons or misplaced braces [OK]

Common Mistakes:

• Using Python-style except instead of catch
• Misplacing braces around catch block
• Omitting parentheses around exception

3. What will be the output of this Jenkins scripted pipeline snippet?

try {
  echo 'Start'
  error('Fail here')
  echo 'End'
} catch (Exception e) {
  echo 'Caught error'
} finally {
  echo 'Cleanup'
}

medium

A. Start\nCaught error\nCleanup

B. Caught error\nCleanup

C. Start\nEnd\nCleanup

D. Start\nCleanup

Solution

1. Step 1: Trace the try block execution

   The pipeline prints 'Start', then calls error('Fail here') which throws an exception, so 'End' is skipped.

2. Step 2: Understand catch and finally blocks

   The catch block runs and prints 'Caught error'. The finally block always runs and prints 'Cleanup'.

3. Final Answer:

   Start Caught error Cleanup -> Option A

4. Quick Check:

   Exception skips 'End', catch and finally run = C [OK]

Hint: Remember: error stops try, catch runs, finally always runs [OK]

Common Mistakes:

• Assuming code after error() runs
• Thinking finally runs before catch
• Ignoring that catch handles the error

4. Identify the error in this Jenkins pipeline snippet:

try {
  echo 'Running'
} catch {
  echo 'Error caught'
} finally {
  echo 'Done'
}

medium

A. try block must have a return statement

B. finally block cannot be used without catch

C. echo statements must be inside script block

D. Missing exception variable in catch block

Solution

1. Step 1: Check catch block syntax

   In Groovy/Jenkins, catch must declare an exception variable like catch (Exception e). Here it is missing.

2. Step 2: Verify other parts

   finally block is valid with catch, echo works outside script block in scripted pipeline, and try block does not require return.

3. Final Answer:

   Missing exception variable in catch block -> Option D

4. Quick Check:

   catch needs (Exception e) = A [OK]

Hint: Always declare exception variable in catch (e.g., catch(Exception e)) [OK]

Common Mistakes:

• Omitting exception variable in catch
• Thinking finally requires catch to be absent
• Assuming echo needs script block

5. You want to run a cleanup step in your Jenkins pipeline regardless of success or failure, but only if the try block ran without syntax errors. Which is the best way to structure your pipeline?

hard

A. Put cleanup code inside the finally block

B. Put cleanup code inside the catch block

C. Put cleanup code after the try-catch-finally block

D. Put cleanup code inside the try block after risky steps

Solution

1. Step 1: Understand when finally runs

   The finally block runs after try and catch, regardless of success or failure, but only if the pipeline syntax is valid and the try block started.

2. Step 2: Compare options for cleanup placement

   Cleanup in catch runs only on errors, after block runs only if no errors, and inside try risks skipping on errors. finally is best for guaranteed cleanup.

3. Final Answer:

   Put cleanup code inside the finally block -> Option A

4. Quick Check:

   Cleanup always runs in finally = B [OK]

Hint: Use finally for guaranteed cleanup after try-catch [OK]

Common Mistakes:

• Putting cleanup only in catch (misses success case)
• Placing cleanup after try-catch (may skip on errors)
• Putting cleanup inside try (skipped if error thrown early)