Try-catch block in Jenkins pipeline script

Question

I'm trying to use the following code to execute builds, and in the end, execute post build actions when builds were successful. Still, I get a MultipleCompilationErrorsException, saying that my try block is Not a valid section definition. Please help, I tried a lot reorganize the block but can't seem to be able to solve the issue.

pipeline{

agent any 
    try {
        stages{
            stage("Parallel 1") {
                steps {
                    parallel (
                       'firstTask' : { 
                            build( "DSL-Controll-Demo-Fibonacci-1" )
                        },
                        'secondTask' : { 
                            build( "DSL-Controll-Demo-Fibonacci-2" )
                        }
                    )
                }
            }
            stage("Feature") {
                steps {
                        build( "DSL-Controll-Demo-Fibonacci-5" )
                        build( "DSL-Controll-Demo-Fibonacci-6" )
                }
            }
            stage("Parallel 2") {
                steps{
                    parallel (
                        "thirdTask" : { 
                            build( "DSL-Controll-Demo-Fibonacci-3" )
                        },
                        "forthTask" : { 
                            build( "DSL-Controll-Demo-Fibonacci-4" )
                        }
                    )
                }
            }
        }
    }   

    catch(all) {
        currentBuild.result = 'FAILURE'
    }   

    if(currentBuild.result != 'FAILURE') {
        stages{
            stage("Post Build") {
                steps {
                    build("DSL-Controll-Demo-Fibonacci-7")
                }   
            }   
        }
    }
}

Lahiru Chandima · Accepted Answer · 2020-10-23 03:30:23Z

125

try like this (no pun intended btw)

script {
  try {
      sh 'do your stuff'
  } catch (Exception e) {
      echo 'Exception occurred: ' + e.toString()
      sh 'Handle the exception!'
  }
}

The key is to put try...catch in a script block in declarative pipeline syntax. Then it will work. This might be useful if you want to say continue pipeline execution despite failure (eg: test failed, still you need reports..)

edited Oct 23, 2020 at 3:30

Lahiru Chandima

24.4k26 gold badges116 silver badges202 bronze badges

answered May 14, 2018 at 6:39

Ciado

2,1162 gold badges18 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

cowlinator Over a year ago

Note that the generic Exception is the only exception allowed (by default) by the Jenkins security sandbox.

User5910 · Accepted Answer · 2018-10-03 15:41:27Z

44

You're using the declarative style of specifying your pipeline, so you must not use try/catch blocks (which are for Scripted Pipelines), but the post section. See: https://jenkins.io/doc/book/pipeline/syntax/#post-conditions

edited Oct 3, 2018 at 15:41

User5910

5076 silver badges15 bronze badges

answered May 16, 2017 at 15:02

Mike

4966 silver badges5 bronze badges

3 Comments

sanya Over a year ago

Using the declarative script{} step, is there a way to to translate an exception to a human readable form? Eg: when a build variable doesn't match a regex how can you deliberately break the build with an error message? IndexOutOfBoundsException doesn't really tell anything about the problem at hand..

user337598 Over a year ago

There is only 1 post section in a declarative pipeline, so if you use parallel blocks, you cannot cleanup and archive logs in each parallel (which could run on a separate node) without a try/catch.

James Nelson Over a year ago

This answer is not correct based on: stackoverflow.com/questions/43293501/… am I missing something?

Robert Casey · Accepted Answer · 2019-05-09 22:30:05Z

21

Look up the AbortException class for Jenkins. You should be able to use the methods to get back simple messages or stack traces. In a simple case, when making a call in a script block (as others have indicated), you can call getMessage() to get the string to echo to the user. Example:

script {
        try {
            sh "sudo docker rmi frontend-test"
        } catch (err) {
            echo err.getMessage()
            echo "Error detected, but we will continue."
        }
        ...continue with other code...
}

answered May 9, 2019 at 22:30

Robert Casey

1,59119 silver badges20 bronze badges

Comments

KBM · Accepted Answer · 2020-09-22 14:23:31Z

6

try/catch is scripted syntax. So any time you are using declarative syntax to use something from scripted in general you can do so by enclosing the scripted syntax in the scripts block in a declarative pipeline. So your try/catch should go inside stage >steps >script.

This holds true for any other scripted pipeline syntax you would like to use in a declarative pipeline as well.

answered Sep 22, 2020 at 14:23

KBM

3611 gold badge4 silver badges16 bronze badges

Collectives™ on Stack Overflow

Try-catch block in Jenkins pipeline script

4 Answers 4

1 Comment

3 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related