How to fix NotSerializableException error during Jenkins workflow build?

Question

When I run the following code on the Jenkins workflow (Jenkins 1.609.1 ,workflow 1.8) I get error of 'NotSerializableException' (also below). However, if I move the "build job" outside the "for" scope it works fine (the job is activated). Any ideas why this behavior?

node('master') { 
ws('/opt/test) {
def file = "/ot.property"
def line = readFile (file)
def resultList = line.tokenize()
for(item in resultList )
  {
build job: 'testjob_1'
   }
 }
}

Got error:

Running: End of Workflow 
java.io.NotSerializableException: java.util.ArrayList$Itr  
    at org.jboss.marshalling.river.RiverMarshaller.doWriteObject(RiverMarshaller.java:860)
    at org.jboss.marshalling.river.RiverMarshaller.doWriteFields(RiverMarshaller.java:1032)
    at org.jboss.marshalling.river.RiverMarshaller.doWriteSerializableObject(RiverMarshaller.java:988)
    at org.jboss.marshalling.river.RiverMarshaller.doWriteObject(RiverMarshaller.java:854)
    at org.jboss.marshalling.river.RiverMarshaller.doWriteFields(RiverMarshaller.java:1032)  


.....

For me I found the best and simplest workaround here: https://stackoverflow.com/a/40166064/1929406 — kivagant, Dec 05 '18 at 13:48

Brian Ray · Accepted Answer · 2015-07-27T16:52:27.047

24

I thnk it is because it's trying to serialize the unserializable item iterator on resultList as soon as it hits the build job step. See here for guidance on use of nonserializable variables:

https://github.com/jenkinsci/workflow-plugin/blob/master/TUTORIAL.md#serialization-of-local-variables

As a workaround to safely iterate using the workflow plugin, you need to us C-style loops. Try this instead:

for ( int i = 0; i < resultList.size; i++ ) {
  etc...

edited Jul 27 '15 at 16:52

answered Jul 27 '15 at 16:46

Brian Ray

489
3
10

Further reference here: – Brian Ray Jul 27 '15 at 16:57
tnx, seems better now! – oTolev Jul 28 '15 at 12:32
FYI, this particular error is tracked as [JENKINS-27421](https://issues.jenkins-ci.org/browse/JENKINS-27421). – Jesse Glick Aug 04 '15 at 14:27
But how can I do the same for maps? – Arun Aug 19 '20 at 16:31

score 8 · Answer 2 · answered Oct 23 '16 at 18:36

8

According to CloudBees Platform Help page:

By design the pipeline can only keep records of Serializable objects. If you still need to keep an intermediate variable with a non serializable object, you need to hide it into a method and annotate this method with @NonCPS.

So you should transform your code into a function with @NonCPS helper method.

Related Jenkins bug: JENKINS-27421.

answered Oct 23 '16 at 18:36

kenorb

155,785
88
678
743

4

Yep. found this beautiful example to that effect: https://gist.github.com/oifland/ab56226d5f0375103141b5fbd7807398 – Prachi Jul 27 '17 at 17:04
3

Important thing to keep in mind here: you can't execute pipeline steps from an @NonCPS method! https://groups.google.com/forum/#!topic/jenkinsci-users/VXrSVBZ2maU – Mathiasdm Mar 12 '18 at 09:38

How to fix NotSerializableException error during Jenkins workflow build?

2 Answers2

Linked