{"id":660,"date":"2019-10-21T15:09:40","date_gmt":"2019-10-21T19:09:40","guid":{"rendered":"https:\/\/crossan007.dev\/blog\/?p=660"},"modified":"2019-10-21T15:09:40","modified_gmt":"2019-10-21T19:09:40","slug":"override-jenkins-stage-function","status":"publish","type":"post","link":"https:\/\/crossan007.dev\/blog\/uncategorized\/override-jenkins-stage-function\/","title":{"rendered":"Override Jenkins stage Function"},"content":{"rendered":"\n
Tweet<\/a><\/div>\n\n

Recently, I needed a mechanism to identify, as part of a try\/catch block, which stage in a Jenkins Groovy Scripted Pipeline was the last to execute before<\/em> the catch block was called.<\/p>\n\n\n\n

Jenkins does not currently store details about the last stage to run outside of the context of that specific stage<\/em>. So, in other words env.STAGE_NAME<\/code> is valid with a particular stage(\"I'm a stage\"){ \/\/valid here} <\/code> block, but not in, say, a catch(Exception e) { \/\/ where was I called from? }<\/code> block.<\/p>\n\n\n\n

To get around this, I found a few examples, and cobbled together something that I believe will provide future functionality. I present to you the extensibleContextStage<\/code>:<\/p>\n\n\n

\n\/\/ Jenkins groovy stages are somewhat lacking in their ability to persist \n\/\/ context state beyond the lifespan of the stage\n\/\/ For example, to obtain the name of the last stage to run, \n\/\/ one needs to store the name in an ENV varialble (JENKINS 48315)\n\/\/ https:\/\/issues.jenkins-ci.org\/browse\/JENKINS-48315\n\n\/\/ We can create an extensible stage to provide attitional context to the pipeline\n\/\/ about the state of the currently running stage.\n\n\/\/ This also provides a capability to extend pre- and post- stage operations\n\n\/\/ Idea \/ base code borrowed from https:\/\/stackoverflow.com\/a\/51081177\/11125318\n\/\/ and from https:\/\/issues.jenkins-ci.org\/browse\/JENKINS-48315?focusedCommentId=321366&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-321366\n\ndef call(name, Closure closure) {\n    env.BUILD_LAST_STAGE_STARTED = name\n    try {\n        stage(name) {\n            def result = closure.call()\n            return result\n        }\n        env.BUILD_LAST_STAGE_SUCCEEDED = name\n    }\n    catch(Exception ex) {\n        env.BUILD_LAST_STAGE_FAILED = name\n        throw ex;\n    }\n}\n\n<\/pre><\/div>\n\n\n
This is a drop-in replacement for stage(string name){ closure}<\/code> blocks in a Jenkins Groovy Scripted Pipeline, but with the added benefit of additional environment variables:<\/p>\n\n\n\n