Jenkins Groovy how to call methods from @NonCPS method without ending pipeline

Question

I need to parse some JSON in a Jenkins Pipeline and call some regular methods in a loop, however the script always exits after the first function call. How to do this?

import groovy.json.JsonSlurper
import com.cloudbees.groovy.cps.NonCPS

@NonCPS
def myMethod(String json) {
    def jsonSlurper = new JsonSlurper()
    def jsonObject = jsonSlurper(json)
    jsonObject.each {
        obj ->
            switch(obj.name) {
                case "foo":
                    doAThing(obj)
                    break
                case "bar":
                    doAnotherThing(obj)
                    break
            }
    }
}

In the above example, even with a json object like:

[{
    "name": "foo"
}, {
    "name": "bar"
}]

...the pipeline always exits after the first iteration. This is presumably due to mixing sync and async functions. Is there any way to do this?

Have you noticed the typo: def jsonObject = jsonSurper(json) (missing "l" in the right part)? — izzekil, Apr 15 '16 at 22:06
It's just a typo in the post, not the actual script... But good eye @izzekil — Fo., Apr 15 '16 at 22:08
You might have faced this: https://issues.jenkins-ci.org/browse/JENKINS-31314 or this: https://issues.jenkins-ci.org/browse/JENKINS-26481 — izzekil, Apr 15 '16 at 22:09

score 11 · Accepted Answer · answered Apr 19 '16 at 23:59

I've resolved this issue essentially by doing the following:

import groovy.json.JsonSlurper

def myMethod(String json) {
    def jsonSlurper = new JsonSlurper()
    def jsonObject = jsonSlurper(json)
    jsonSlurper = null
    for(int i = 0; i < jsonObject.size(); i++) {
        switch(jsonObject[i].name) {
            case "foo":
                doAThing(jsonObject[i])
                break
            case "bar":
                doAnotherThing(jsonObject[i])
                break
        }
    }
}

Immediately destroy the JsonSlurper instance after it's used, remove @NonCPS annotation, switch to a c-style for loop instead of each.

maybe you also have an idea on how to solve this https://stackoverflow.com/questions/44629038/how-do-i-remove-a-temporary-folder-on-exit-in-groovy -- what should we do to this to make it work in Jenkins? — sorin, Jun 19 '17 at 13:25

score 4 · Answer 2 · answered Dec 17 '16 at 07:02

Just to clarify, this is documented as an unsupported feature - https://github.com/jenkinsci/workflow-cps-plugin/#technical-design

You may not call regular (CPS-transformed) methods, or Pipeline steps, from a @NonCPS method, so they are best used for performing some calculations before passing a summary back to the main script.

Jenkins Groovy how to call methods from @NonCPS method without ending pipeline

2 Answers2

Linked