What is the effect of @NonCPS in a Jenkins pipeline script

by

The exception that you are seeing is due to script security and sandboxing. Basically, by default, when you run a pipeline script, it runs in a sandbox which only allow usage of certain methods and classes. There are ways to whitelist operations, check the link above.

The @NonCPS annotation is useful when you have methods which use objects which aren’t serializable. Normally, all objects that you create in your pipeline script must be serializable (the reason for this is that Jenkins must be able to serialize the state of the script so that it can be paused and stored on disk).

When you put @NonCPS on a method, Jenkins will execute the entire method in one go without the ability to pause. Also, you’re not allowed to reference any pipeline steps or CPS transformed methods from within an @NonCPS annotated method. More information about this can be found here.

As for the exception handling: Not 100% sure what you are experiencing; I’ve tried the following and it works as expected:

@NonCPS
def myFunction() {
    throw new RuntimeException();
}

try {
    myFunction();
} catch (Exception e) {
    echo "Caught";
}

and

@NonCPS
def myFunction() {
    throw new RuntimeException();
}

def mySecondFunction() {
    try {
        myFunction();
    } catch (Exception e) {
        echo "Caught";
    }
}

mySecondFunction();

and finally:

@NonCPS
def myFunction() {
    throw new RuntimeException();
}

@NonCPS
def mySecondFunction() {
    try {
        myFunction();
    } catch (Exception e) {
        echo "Caught";
    }
}

mySecondFunction();

All print “Caught” as expected.

More Related Contents:

  1. How do you load a groovy file and execute it
  2. How can I trigger another job from a jenkins pipeline (jenkinsfile) with GitHub Org Plugin?
  3. Show a Jenkins pipeline stage as failed without failing the whole job
  4. How to access parameters in a Parameterized Build?
  5. Strange variable scoping behavior in Jenkinsfile
  6. Jenkinsfile Declarative Pipeline defining dynamic env vars
  7. Jenkins dynamic declarative pipeline parameters
  8. Cannot define variable in pipeline stage
  9. Active Choices Reactive Reference Parameter in jenkins pipeline
  10. Closures in Groovy not capturing outside variables
  11. How to list all `env` properties within jenkins pipeline job?
  12. How to read properties file from Jenkins 2.0 pipeline script
  13. What is the JUnit XML format specification that Hudson supports?
  14. Access to build environment variables from a groovy script in a Jenkins build step (Windows)
  15. How do I make a Jenkins job start after multiple simultaneous upstream jobs succeed?
  16. How to change workspace and build record Root Directory on Jenkins?
  17. Export/import jobs in Jenkins
  18. How to move Jenkins from one PC to another
  19. How to get the API token for Jenkins
  20. Determine Failed Stage in Jenkins Declarative Pipeline
  21. Get absolute path to workspace directory in Jenkins Pipeline plugin
  22. How to change port for jenkins window service when 8080 is being used
  23. Jenkins / Hudson environment variables
  24. Abort current build from pipeline in Jenkins
  25. How to implement Post-Build stage using Jenkins Pipeline plug-in?
  26. How to retrieve Jenkins build parameters using the Groovy API?
  27. Pass groovy variable to shell script
  28. How do I pass variables between stages in a declarative Jenkins pipeline?
  29. Can I create dynamically stages in a Jenkins pipeline?
  30. Running stages in parallel with Jenkins workflow / pipeline

Leave a Comment