Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-37984

org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed: General error during class generation: Method code too large! error in pipeline Script

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Blocker Blocker
    • workflow-cps-plugin
    • None

      Note from the Maintainers

      There is partial fix for this for Declarative pipelines in pipeline-model-definition-plugin v1.4.0 and later, significantly improved in v1.8.4.  Due to the extent to which it change how pipelines are executed it is turned off by default.  It can be turned on by setting a JVM property (either on the command-line or in Jenkins script console):

      org.jenkinsci.plugins.pipeline.modeldefinition.parser.RuntimeASTTransformer.SCRIPT_SPLITTING_TRANSFORMATION=true 

      As noted, this still works best with a Jenkinsfile with pipeline directive as the only root item in the file.
      Since v1.8.2 this workaround reports an informative error for pipelines using `def` variables before the pipeline directive. Add a @Field annotation to those declaration.
      This workaround generally does NOT work if the pipeline directive inside a shared library method. If this is a scenario you want, please come join the pipeline authoring SIG and we can discuss.

      Please give it a try and provide feedback. 

      Hi,

      We are getting below error in Pipeline which has some 495 lines of groovy code. Initially we assumed that one of our methods has an issue but once we remove any 30-40 lines of Pipeline groovy, this issue is not coming.

      Can you please suggest a quick workaround. It's a blocker for us.

      org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
      General error during class generation: Method code too large!
      
      java.lang.RuntimeException: Method code too large!
      	at groovyjarjarasm.asm.MethodWriter.a(Unknown Source)
      	at groovyjarjarasm.asm.ClassWriter.toByteArray(Unknown Source)
      	at org.codehaus.groovy.control.CompilationUnit$16.call(CompilationUnit.java:815)
      	at org.codehaus.groovy.control.CompilationUnit.applyToPrimaryClassNodes(CompilationUnit.java:1053)
      	at org.codehaus.groovy.control.CompilationUnit.doPhaseOperation(CompilationUnit.java:591)
      	at org.codehaus.groovy.control.CompilationUnit.processPhaseOperations(CompilationUnit.java:569)
      	at org.codehaus.groovy.control.CompilationUnit.compile(CompilationUnit.java:546)
      	at groovy.lang.GroovyClassLoader.doParseClass(GroovyClassLoader.java:298)
      	at groovy.lang.GroovyClassLoader.parseClass(GroovyClassLoader.java:268)
      	at groovy.lang.GroovyShell.parseClass(GroovyShell.java:688)
      	at groovy.lang.GroovyShell.parse(GroovyShell.java:700)
      	at org.jenkinsci.plugins.workflow.cps.CpsGroovyShell.reparse(CpsGroovyShell.java:67)
      	at org.jenkinsci.plugins.workflow.cps.CpsFlowExecution.parseScript(CpsFlowExecution.java:410)
      	at org.jenkinsci.plugins.workflow.cps.CpsFlowExecution.start(CpsFlowExecution.java:373)
      	at org.jenkinsci.plugins.workflow.job.WorkflowRun.run(WorkflowRun.java:213)
      	at hudson.model.ResourceController.execute(ResourceController.java:98)
      	at hudson.model.Executor.run(Executor.java:410)
      
      1 error
      
      	at org.codehaus.groovy.control.ErrorCollector.failIfErrors(ErrorCollector.java:310)
      	at org.codehaus.groovy.control.CompilationUnit.applyToPrimaryClassNodes(CompilationUnit.java:1073)
      	at org.codehaus.groovy.control.CompilationUnit.doPhaseOperation(CompilationUnit.java:591)
      	at org.codehaus.groovy.control.CompilationUnit.processPhaseOperations(CompilationUnit.java:569)
      	at org.codehaus.groovy.control.CompilationUnit.compile(CompilationUnit.java:546)
      	at groovy.lang.GroovyClassLoader.doParseClass(GroovyClassLoader.java:298)
      	at groovy.lang.GroovyClassLoader.parseClass(GroovyClassLoader.java:268)
      	at groovy.lang.GroovyShell.parseClass(GroovyShell.java:688)
      	at groovy.lang.GroovyShell.parse(GroovyShell.java:700)
      	at org.jenkinsci.plugins.workflow.cps.CpsGroovyShell.reparse(CpsGroovyShell.java:67)
      	at org.jenkinsci.plugins.workflow.cps.CpsFlowExecution.parseScript(CpsFlowExecution.java:410)
      	at org.jenkinsci.plugins.workflow.cps.CpsFlowExecution.start(CpsFlowExecution.java:373)
      	at org.jenkinsci.plugins.workflow.job.WorkflowRun.run(WorkflowRun.java:213)
      	at hudson.model.ResourceController.execute(ResourceController.java:98)
      	at hudson.model.Executor.run(Executor.java:410)
      Finished: FAILURE
      

        1. JenkinsCodeTooLarge.groovy
          45 kB
        2. Script_Splitting.groovy
          44 kB
        3. Script_Splittingx10.groovy
          519 kB
        4. errorIncomaptiblewithlocalvar.txt
          8 kB
        5. java.png
          java.png
          294 kB

          [JENKINS-37984] org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed: General error during class generation: Method code too large! error in pipeline Script

          Pete McNab added a comment - - edited

          I've run into the same problem. I have a large (200+kb) pipeline script that is generated from our legacy build specification language.

          My generated code is broken up into stages, with each stage running a potentially large parallel pipeline operation, where each platform of a given target is built.

          After some googling about the underlying cause, I attempted to break it up by having each stage be defined as a method and calling the method rather than just having all the code in one giant block, but it didn't help.

          As this will impact a lot of people trying to migrate to the Jenkins pipeline, and may make them throw up their hands due to the error being vague and unhelpful (which I realize is not the fault of Jenkins, but the underlying Java/Groovy architecture), it might be good to have some specific guides on how to deal with this.

          Pete McNab added a comment - - edited I've run into the same problem. I have a large (200+kb) pipeline script that is generated from our legacy build specification language. My generated code is broken up into stages, with each stage running a potentially large parallel pipeline operation, where each platform of a given target is built. After some googling about the underlying cause, I attempted to break it up by having each stage be defined as a method and calling the method rather than just having all the code in one giant block, but it didn't help. As this will impact a lot of people trying to migrate to the Jenkins pipeline, and may make them throw up their hands due to the error being vague and unhelpful (which I realize is not the fault of Jenkins, but the underlying Java/Groovy architecture), it might be good to have some specific guides on how to deal with this.

          Jesse Glick added a comment -

          Surprised that breaking it up into separate methods did not help. Other than that, I have no suggestions offhand.

          Jesse Glick added a comment - Surprised that breaking it up into separate methods did not help. Other than that, I have no suggestions offhand.

          Pete McNab added a comment -

          Yeah it's kind of puzzling – as part of my testing I had reduced the number of stages significantly.

          So a version that worked had 4 stages with no methods and it was about 1720 lines.

          With the full set of stages (27), the number of lines is about 5300 lines. Breaking it up into methods had no method larger than about 450 lines, but it wouldn't run.

          I also went in and removed the 4 stages that had worked, which put the entire script down to ~3600 lines broken out into methods, and that wouldn't run either.

          Pete McNab added a comment - Yeah it's kind of puzzling – as part of my testing I had reduced the number of stages significantly. So a version that worked had 4 stages with no methods and it was about 1720 lines. With the full set of stages (27), the number of lines is about 5300 lines. Breaking it up into methods had no method larger than about 450 lines, but it wouldn't run. I also went in and removed the 4 stages that had worked, which put the entire script down to ~3600 lines broken out into methods, and that wouldn't run either.

          Pete McNab added a comment - - edited

          Whoops. Well cancel what I said. When I generated the code with what I intended to be methods I was actually defining closures attached to a variable. When I did it properly as methods it's ok with it.

          So more specifically, for those of you who find this, what I used to have was:

          stage foo
          parallel([
           ... giant list of maps ...
          ])
          

          What I changed it to was:

          stage foo
          def build_foo() {
            parallel([
               ...giant list of maps...
            ])}
          build_foo()
          

          Pete McNab added a comment - - edited Whoops. Well cancel what I said. When I generated the code with what I intended to be methods I was actually defining closures attached to a variable. When I did it properly as methods it's ok with it. So more specifically, for those of you who find this, what I used to have was: stage foo parallel([ ... giant list of maps ... ]) What I changed it to was: stage foo def build_foo() { parallel([ ...giant list of maps... ])} build_foo()

          Jesse Glick added a comment -

          Sounds like a good candidate for a self-answer.

          Jesse Glick added a comment - Sounds like a good candidate for a self-answer .

          Pete McNab added a comment -

          I made one – I still think this case should be touched on in the Pipeline docs. I don't think searching Jira or StackOverflow is a substitute for documentation

          Pete McNab added a comment - I made one – I still think this case should be touched on in the Pipeline docs. I don't think searching Jira or StackOverflow is a substitute for documentation

          Jesse Glick added a comment -

          Sure, that is why this is still open.

          Jesse Glick added a comment - Sure, that is why this is still open.

          philippe lançon added a comment - - edited

          problem seems to be linked with the size all the script but I remarked it's linked also according number and size of stages.
          A workaround consists to declare a function called in some big stages.

          before :

          stage ('build') {
          ....
          if (.....) {
          } else {
          }
          .....
          }

          workaround

          def build() {
          ....
          if (.....) {
          } else {
          }
          .....
          }
          stage ('build') {
          build()
          }

          philippe lançon added a comment - - edited problem seems to be linked with the size all the script but I remarked it's linked also according number and size of stages. A workaround consists to declare a function called in some big stages. before : stage ('build') { .... if (.....) { } else { } ..... } workaround def build() { .... if (.....) { } else { } ..... } stage ('build') { build() }

          Andrew Bayer added a comment -

          So this is happening because of how CPS transformation works - everything's getting wrapped in a single method behind the scenes, and that's ending up being too large. The best answer we've got is to move things out into shared libraries.

          Andrew Bayer added a comment - So this is happening because of how CPS transformation works - everything's getting wrapped in a single method behind the scenes, and that's ending up being too large. The best answer we've got is to move things out into shared libraries.

          Dee Kryvenko added a comment -

          Any workarounds? My scenario is quite specific, we threat Jenkinsfile as some sort of a JIT. No one working with it directly, it rather being generated automatically based on something else. It is essential for the debugging purposes to have a big picture perspective on how the resulting Jenkinsfile going to look like, and there is no benefits into splitting it or moving to the shared library (again this is not for humans and not made by humans).

          We need a way to increase this limit.

          Dee Kryvenko added a comment - Any workarounds? My scenario is quite specific, we threat Jenkinsfile as some sort of a JIT. No one working with it directly, it rather being generated automatically based on something else. It is essential for the debugging purposes to have a big picture perspective on how the resulting Jenkinsfile going to look like, and there is no benefits into splitting it or moving to the shared library (again this is not for humans and not made by humans). We need a way to increase this limit.

          Ruud P added a comment - - edited

          i use as "work a round" a script blok, for me it was a lot of work to change it but the result was smaller code witch is always good

             stages {
              stage('parallel stages') {
                steps {
                  script {

          in my case i have 200-300 parallel  stages

          i generate the parallel stages with a single function and i execute more as 200-300 stages in parallel, this is very dynamic as this amount of stages depends on user input. So i use now script block to generate all the stages and execute the stages instead of using declarative Pipeline.

           

          Ruud P added a comment - - edited i use as "work a round" a script blok, for me it was a lot of work to change it but the result was smaller code witch is always good    stages {     stage('parallel stages') {       steps {         script { in my case i have 200-300 parallel  stages i generate the parallel stages with a single function and i execute more as 200-300 stages in parallel, this is very dynamic as this amount of stages depends on user input. So i use now script block to generate all the stages and execute the stages instead of using declarative Pipeline.  

          Dee Kryvenko added a comment - - edited

          The thing is I actually don't want to hide this code to the library. My library already does it's thing, I have a custom DSL syntax that my library goes through and generates resulting Jenkinsfile. And I follow TDD, so I got tests, and my tests basically checking the resulting Jenkinsfile vs given my own DSL. Hiding parts of Jenkinsfile into the library going to ruin the whole idea of testing for my project. Again the Jenkinsfile for me is kind of JIT, it's not a code to being read or created by human.

          Dee Kryvenko added a comment - - edited The thing is I actually don't want to hide this code to the library. My library already does it's thing, I have a custom DSL syntax that my library goes through and generates resulting Jenkinsfile. And I follow TDD, so I got tests, and my tests basically checking the resulting Jenkinsfile vs given my own DSL. Hiding parts of Jenkinsfile into the library going to ruin the whole idea of testing for my project. Again the Jenkinsfile for me is kind of JIT, it's not a code to being read or created by human.

          Ryan Kuba added a comment - - edited

          I am running into this, example file: 

          https://pastebin.com/raw/fnKnYiMq

          If I rip out some env declaration blocks like: 

                   script{
                     env.CI_IMAGE = env.DEV_DOCKERHUB_IMAGE
                     env.CI_TAGS = env.EXT_RELEASE + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
                     env.CI_META_TAG = env.EXT_RELEASE + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
                   }
          

          It will compile up and run, I already tried to move every script section out to functions, but still get Method to Large. 

           

          This is only ~800 lines and even if you compiled this text 10x over it would not be at the 64k java limit. 

          I am trying to understand how the workflow is interpreted that could result in this limit being hit.  

          Ryan Kuba added a comment - - edited I am running into this, example file:  https://pastebin.com/raw/fnKnYiMq If I rip out some env declaration blocks like:  script{ env.CI_IMAGE = env.DEV_DOCKERHUB_IMAGE env.CI_TAGS = env.EXT_RELEASE + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA env.CI_META_TAG = env.EXT_RELEASE + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA } It will compile up and run, I already tried to move every script section out to functions, but still get Method to Large.    This is only ~800 lines and even if you compiled this text 10x over it would not be at the 64k java limit.  I am trying to understand how the workflow is interpreted that could result in this limit being hit.  

          +1

          it is a real headache

          about 800-900 lines of code

          could you please enforce fixing this issue?

          Viachaslau Kabak added a comment - +1 it is a real headache about 800-900 lines of code could you please enforce fixing this issue?

          Szymon Surudo added a comment -

          Hello Guys,

          I am trying to find a workaround but after some testing I am not able to determine how Jenkinsfile is being parsed in case of Scripted Pipeline. For me it seems that whole file is going to JVM at once, thus gives this limitation of 800-900 lines of code like mentioned above. I tried to artificially split the code into different node blocks which uses the same runners like:

          node('master'){ stage stage stage }
          node('master'){ stage stage stage }
          node('master'){ stage stage stage }

          but it makes no difference. Is there any way to modify code structure so it would be compiled in chunks? Am I able to load some other Jenkinsfiles dynamically? Or maybe it is possible to move some code to shared groovy libraries (but then I would need to call http request plugin from libraries, which I don't know whether is possible)?

          I also did some additional, maybe even stupid test to check how many instructions is too much to compile and I was shocked a bit, when I saw ArrayIndexOutOfBoundsException when I had something above 400 print's invoked in the code divided into 3 stages. Is it that the instructions are held on stack and then send to JVM? How come declarative pipeline is so easy to be split and scripted version is not?

          I would very much appreciate any workaround to move on with dev.

          Best Regards,

          Szymon

          Szymon Surudo added a comment - Hello Guys, I am trying to find a workaround but after some testing I am not able to determine how Jenkinsfile is being parsed in case of Scripted Pipeline. For me it seems that whole file is going to JVM at once, thus gives this limitation of 800-900 lines of code like mentioned above. I tried to artificially split the code into different node blocks which uses the same runners like: node('master'){ stage stage stage } node('master'){ stage stage stage } node('master'){ stage stage stage } but it makes no difference. Is there any way to modify code structure so it would be compiled in chunks? Am I able to load some other Jenkinsfiles dynamically? Or maybe it is possible to move some code to shared groovy libraries (but then I would need to call http request plugin from libraries, which I don't know whether is possible)? I also did some additional, maybe even stupid test to check how many instructions is too much to compile and I was shocked a bit, when I saw ArrayIndexOutOfBoundsException when I had something above 400 print's invoked in the code divided into 3 stages. Is it that the instructions are held on stack and then send to JVM? How come declarative pipeline is so easy to be split and scripted version is not? I would very much appreciate any workaround to move on with dev. Best Regards, Szymon

          Szymon Surudo added a comment -

          It may sound obvious, however it worked for me when I extracted some methods of reusable code in Jenkinsfile and those are compiled in such a way that I can put more code into those. I don't know where my fixation came from, but I thought that methods are only available in declarative pipeline whereas in scripted pipeline it should be moved to for instance shared libraries. So now my code structure looks like this:

          node('master'){
             stage('setup')

          { some logic    method1()    method2()    }

             stage('cleanup')

          { some logic    method2()    method3()    }

          }

          def method1() {}
          def method2() {}
          def method3() {}

          Szymon Surudo added a comment - It may sound obvious, however it worked for me when I extracted some methods of reusable code in Jenkinsfile and those are compiled in such a way that I can put more code into those. I don't know where my fixation came from, but I thought that methods are only available in declarative pipeline whereas in scripted pipeline it should be moved to for instance shared libraries. So now my code structure looks like this: node('master'){    stage('setup') { some logic    method1()    method2()    }    stage('cleanup') { some logic    method2()    method3()    } } def method1() {} def method2() {} def method3() {}

          I'm starting to run into this issue myself when my pipeline reaches about 800 lines. I've been creating helper function outside of the "pipeline" brackets and that's helping but I find myself still running into this issue more than I'd like.

          I can't help it. Having all the new nice features makes me write longer more useful pipelines.

          Henry Borchers added a comment - I'm starting to run into this issue myself when my pipeline reaches about 800 lines. I've been creating helper function outside of the "pipeline" brackets and that's helping but I find myself still running into this issue more than I'd like. I can't help it. Having all the new nice features makes me write longer more useful pipelines.

          Dee Kryvenko added a comment - - edited

          800 lines of code in one file sounds bad in any language. It definitely needs a refactoring and shared libraries.

          Just to be clear - in my case above I experienced that issue while already having my libraries, and it was due the way I designed these libraries (they treat Jenkinsfile concept as some sort of JIT, they basically doing some calculations based on the input and spits out resulting long Jenkinsfile that I then eval() ed). I solved my case by splitting what I eval() into chunks exchanging the data through the context singleton object in my library (surprisingly singleton instances were not per Jenkins master JVM but per library instance, i.e. per individual build). So technically my case wasn't even related to Jenkins at all. I was sending too long string into eval() method and it was legitimately (accordingly to JVM) giving me a finger. Just to give an example, my chunks would look like:

          getContext('stages')['Test Stage'] = {
              echo 'hi'
          }
          
          getContext('stages')['Second Test Stage'] = {
            echo 'hi again'
          timestamps {
              ansiColor("xterm") {
                  stage('Test Stage', getContext('stages')['Test Stage'])
                  stage('Second Test Stage', getContext('stages')['Second Test Stage'])
              }
          }
          

          Given that I think this issue may be closed now.

          Dee Kryvenko added a comment - - edited 800 lines of code in one file sounds bad in any language. It definitely needs a refactoring and shared libraries. Just to be clear - in my case above I experienced that issue while already having my libraries, and it was due the way I designed these libraries (they treat Jenkinsfile concept as some sort of JIT, they basically doing some calculations based on the input and spits out resulting long Jenkinsfile that I then eval() ed). I solved my case by splitting what I eval() into chunks exchanging the data through the context singleton object in my library (surprisingly singleton instances were not per Jenkins master JVM but per library instance, i.e. per individual build). So technically my case wasn't even related to Jenkins at all. I was sending too long string into eval() method and it was legitimately (accordingly to JVM) giving me a finger. Just to give an example, my chunks would look like: getContext( 'stages' )[ 'Test Stage' ] = { echo 'hi' } getContext( 'stages' )[ 'Second Test Stage' ] = { echo 'hi again' }  timestamps { ansiColor( "xterm" ) { stage( 'Test Stage' , getContext( 'stages' )[ 'Test Stage' ]) stage( 'Second Test Stage' , getContext( 'stages' )[ 'Second Test Stage' ]) } } Given that I think this issue may be closed now.

          llibicpep, My pipeline is long because it contains more than just unit testing. It's a complete DevOps pipeline with optional stages depending on the situation. I have sequential stages, parallel stages and most of these have a post section that cleans up or depends on the success or failure of the stage. It's very declarative and pretty easy to reason with so there really shouldn't be a reason to refactored the code.

          Jenkins has become very very powerful tool with the Pipeline DSL with a lot of very useful features. It's a shame when I when I can't use a feature because my pipeline contains too many lines already.

          Henry Borchers added a comment - llibicpep , My pipeline is long because it contains more than just unit testing. It's a complete DevOps pipeline with optional stages depending on the situation. I have sequential stages, parallel stages and most of these have a post section that cleans up or depends on the success or failure of the stage. It's very declarative and pretty easy to reason with so there really shouldn't be a reason to refactored the code. Jenkins has become very very powerful tool with the Pipeline DSL with a lot of very useful features. It's a shame when I when I can't use a feature because my pipeline contains too many lines already.

          Dee Kryvenko added a comment - - edited

          henryborchers, complexity of your pipeline is completely irrelevant. Just to draw a parallel, the fact that you're creating complex Enterprise product does not justify you to put all it's code in a single file, or even in a single method, does it?

          Parts of your pipeline has to be a reusable functions in the shared library, so your actual jenkins file should consist only simple statements, something like

          doThis()
          if (itsTrue()) {
            doThat()
          }
          

          That applies only for scripted pipelines, of course. Accordingly to https://jenkins.io/doc/book/pipeline/shared-libraries/#defining-declarative-pipelines it sounds like declarative pipelines even more limited than I thought, so I'm happy I don't use 'em.

          Dee Kryvenko added a comment - - edited henryborchers , complexity of your pipeline is completely irrelevant. Just to draw a parallel, the fact that you're creating complex Enterprise product does not justify you to put all it's code in a single file, or even in a single method, does it? Parts of your pipeline has to be a reusable functions in the shared library, so your actual jenkins file should consist only simple statements, something like doThis() if (itsTrue()) { doThat() } That applies only for scripted pipelines, of course. Accordingly to https://jenkins.io/doc/book/pipeline/shared-libraries/#defining-declarative-pipelines it sounds like declarative pipelines even more limited than I thought, so I'm happy I don't use 'em.

          Dee Kryvenko added a comment -

          Just a quick searching in google reveal there is actually an open source project doing something good enough to demonstrate what I mean:
          https://github.com/fabric8io/fabric8-pipeline-library
          https://github.com/fabric8io/fabric8-jenkinsfile-library

          Dee Kryvenko added a comment - Just a quick searching in google reveal there is actually an open source project doing something good enough to demonstrate what I mean: https://github.com/fabric8io/fabric8-pipeline-library https://github.com/fabric8io/fabric8-jenkinsfile-library

          henryborchers, complexity of your pipeline is completely irrelevant.

          Couldn't agree more

          Just to draw a parallel, the fact that you're creating complex Enterprise product does not justify you to put all it's code in a single file, or even in a single method, does it?

          It's not a complex Enterprise product. Quite the opposite. I don't have much support so I have to automate as much DevOps stuff myself. Because I have very little resources and stakeholders that require a lot, I'm making the most of the resources I can get my hands on.

          Parts of your pipeline has to be a reusable functions in the shared library, so your actual jenkins file should consist only simple statements, something like

          doThis()
          if (itsTrue()) {
            doThat()
          }
          

          That applies only for scripted pipelines, of course. Accordingly to https://jenkins.io/doc/book/pipeline/shared-libraries/#defining-declarative-pipelines it sounds like declarative pipelines even more limited than I thought, so I'm happy I don't use 'em.

           

          I'm happy that you're happy that you don't use declarative pipelines. However, I do. The only limit I've run has been line length.

          Just a quick searching in google reveal there is actually an open source project doing something good enough to demonstrate what I mean:
          https://github.com/fabric8io/fabric8-pipeline-library
          https://github.com/fabric8io/fabric8-jenkinsfile-library

          Yes. I already use shared libraries for somethings already.  I just don't use need it very often.

           

          The only reason my pipelines are so long is because of the declarative style.

           

           

          stage("Run Doctest Tests"){
            when { 
                equals expected: true, actual: params.TEST_DOCTEST  
            }  
            steps{
                bat "pipenv run sphinx-build -b doctest docs\\source build\\docs -d build\\docs\\doctrees -v"  
            }
            post{ 
                always {
                   dir(reports){ 
                       archiveArtifacts artifacts: "doctest.txt"
                   }
               }
            }
          }
          

           

           

          It's more verbose but I find it highly readable and very easy to maintain. Shared libraries are nice for helpers but they can be a pain for maintain so I keep them simple. 

          Henry Borchers added a comment - henryborchers , complexity of your pipeline is completely irrelevant. Couldn't agree more Just to draw a parallel, the fact that you're creating complex Enterprise product does not justify you to put all it's code in a single file, or even in a single method, does it? It's not a complex Enterprise product. Quite the opposite. I don't have much support so I have to automate as much DevOps stuff myself. Because I have very little resources and stakeholders that require a lot, I'm making the most of the resources I can get my hands on. Parts of your pipeline has to be a reusable functions in the shared library, so your actual jenkins file should consist only simple statements, something like doThis() if (itsTrue()) { doThat() } That applies only for scripted pipelines, of course. Accordingly to  https://jenkins.io/doc/book/pipeline/shared-libraries/#defining-declarative-pipelines  it sounds like declarative pipelines even more limited than I thought, so I'm happy I don't use 'em.   I'm happy that you're happy that you don't use declarative pipelines. However, I do. The only limit I've run has been line length. Just a quick searching in google reveal there is actually an open source project doing something good enough to demonstrate what I mean: https://github.com/fabric8io/fabric8-pipeline-library https://github.com/fabric8io/fabric8-jenkinsfile-library Yes. I already use shared libraries for somethings already.  I just don't use need it very often.   The only reason my pipelines are so long is because of the declarative style.     stage( "Run Doctest Tests" ){   when { equals expected: true , actual: params.TEST_DOCTEST  }  steps{   bat "pipenv run sphinx-build -b doctest docs\\source build\\docs -d build\\docs\\doctrees -v"   }   post{ always { dir(reports){ archiveArtifacts artifacts: "doctest.txt" } }   } }     It's more verbose but I find it highly readable and very easy to maintain. Shared libraries are nice for helpers but they can be a pain for maintain so I keep them simple. 

          Dee Kryvenko added a comment - - edited

          I don't have much support so I have to automate as much DevOps stuff myself. Because I have very little resources and stakeholders that require a lot, I'm making the most of the resources I can get my hands on.

          That is somewhat twisted conclusion. Shared library as a layer of abstraction helps to maintain and simplify your life, as long as you use it right. Same as the possibility to run unit tests for that code. Otherwise it's just a snowflake, it may look beautiful from a certain angle but that is your first symptom you're getting right there.

          However, it's a pointless discussion, I am just a user the same as you, I do not making that call, but even then I don't see what Jenkins can possibly do as this is a JVM limitation. The Jenkinsfile essentially is Groovy DSL file which ends up being executed as a method. I can imagine they could possibly do some semantic analysis and try to automatically split it into chunks or obfuscate parts of it into a separate functions, but the level of effort needs to be put in it is nowhere close to the potential benefit. So I wouldn't expect any resolution to that issue.

          Dee Kryvenko added a comment - - edited I don't have much support so I have to automate as much DevOps stuff myself. Because I have very little resources and stakeholders that require a lot, I'm making the most of the resources I can get my hands on. That is somewhat twisted conclusion. Shared library as a layer of abstraction helps to maintain and simplify your life, as long as you use it right. Same as the possibility to run unit tests for that code. Otherwise it's just a snowflake, it may look beautiful from a certain angle but that is your first symptom you're getting right there. However, it's a pointless discussion, I am just a user the same as you, I do not making that call, but even then I don't see what Jenkins can possibly do as this is a JVM limitation. The Jenkinsfile essentially is Groovy DSL file which ends up being executed as a method. I can imagine they could possibly do some semantic analysis and try to automatically split it into chunks or obfuscate parts of it into a separate functions, but the level of effort needs to be put in it is nowhere close to the potential benefit. So I wouldn't expect any resolution to that issue.

          I have a specific example where I have 174 individual git repos that I want to sync and run Simian and other static code analysis on to check for warnings/errors/duplicate code, etc.

           

          I have even tried breaking the checkout down into multiple stages.  How do I fix this?  I have tried moving it out to a function but that does not work.  I have tried breaking down into multiple (12+) stages and also does not work.

          My total script is 224 lines long (64K).  Not sure this should be too big.

          Stephen Tunney added a comment - I have a specific example where I have 174 individual git repos that I want to sync and run Simian and other static code analysis on to check for warnings/errors/duplicate code, etc.   I have even tried breaking the checkout down into multiple stages.  How do I fix this?  I have tried moving it out to a function but that does not work.  I have tried breaking down into multiple (12+) stages and also does not work. My total script is 224 lines long (64K).  Not sure this should be too big.

          Getting same error while using much smaller pipeline, (actually it is delivered as shared library), whole thing (*.groovy) with comments and long property names has just slightly > 64kb. 

           

          I guess when it is translated to one great method it is obfuscated / optimised.

           

          jglick is there a way to monitor the size of transformed pipeline? Some output or custom job to monitor it would be great?

          Jakub Pawlinski added a comment - Getting same error while using much smaller pipeline, (actually it is delivered as shared library), whole thing (*.groovy) with comments and long property names has just slightly > 64kb.    I guess when it is translated to one great method it is obfuscated / optimised.   jglick is there a way to monitor the size of transformed pipeline? Some output or custom job to monitor it would be great?

          Jesse Glick added a comment -

          I do not foresee anyone spending much effort on this issue, as that would distract from the goal of moving Pipeline execution out of process, rendering this moot.

          Jesse Glick added a comment - I do not foresee anyone spending much effort on this issue, as that would distract from the goal of moving Pipeline execution out of process, rendering this moot.

          Could you share some details on "moving Pipeline execution out of process", like is this on roadmap somewhere?

          I don't need rendering, would be enough to output pipeline size during the build so I know how far I am from hitting this. Something like this:

             println Jenkins.instance.getPipelineSize('pipeline.groovy').toString()

           

          Jakub Pawlinski added a comment - Could you share some details on "moving Pipeline execution out of process", like is this on roadmap somewhere? I don't need rendering, would be enough to output pipeline size during the build so I know how far I am from hitting this. Something like this:    println Jenkins.instance.getPipelineSize('pipeline.groovy').toString()  

          dan tran added a comment -

          we just hit this issue today on our many stages mainly used to run many integration test suites

          dan tran added a comment - we just hit this issue today on our many stages mainly used to run many integration test suites

          Sam Van Oort added a comment -

          quas It is on the roadmap and has a couple engineers working hard on it (myself included), although we're not quite ready to demo or announce something (a few more pieces need to fall into place).

          Sam Van Oort added a comment - quas It is on the roadmap and has a couple engineers working hard on it (myself included), although we're not quite ready to demo or announce something (a few more pieces need to fall into place).

          svanoort any updates on this issue? I see nobody assigned to it right now, but I've just hit the same issue on our CI.

          Sergey Avseyev added a comment - svanoort any updates on this issue? I see nobody assigned to it right now, but I've just hit the same issue on our CI.

          Jesse Glick added a comment -

          avsej as discussed above, I doubt anyone is planning to spend time on this.

          Jesse Glick added a comment - avsej as discussed above, I doubt anyone is planning to spend time on this.

          jglick, but last comment a month ago was about working hard on it. So I thought there might be some progress, or at least assignee for the issue.

          Sergey Avseyev added a comment - jglick , but last comment a month ago was about working hard on it. So I thought there might be some progress, or at least assignee for the issue.

          Jesse Glick added a comment -

          No, the last comment was about working on a completely different execution engine that would not suffer from this class of bugs by design.

          Jesse Glick added a comment - No, the last comment was about working on a completely different execution engine that would not suffer from this class of bugs by design.

          Naval Gupta added a comment -

          Any update or resolution on this issue.

          Our production deployment is stuck due to this pipeline size restriction. 

          Pipeline scripts fails in case it contains more than 78 build job statements in total. Right now, we are splitting the complete script into smaller pipeline scripts and then running all in predefined sequence, provided a single parallel cannot contain  more than 78 builds, currently

          But its production and due to increase in server list, this count will go beyond 100 or more at some point of time and hence this pipeline job concept wont be of any use.

          Therefore requesting you to expedite on this and provide us the update.

          Naval Gupta added a comment - Any update or resolution on this issue. Our production deployment is stuck due to this pipeline size restriction.  Pipeline scripts fails in case it contains more than 78 build job statements in total. Right now, we are splitting the complete script into smaller pipeline scripts and then running all in predefined sequence, provided a single parallel cannot contain  more than 78 builds, currently But its production and due to increase in server list, this count will go beyond 100 or more at some point of time and hence this pipeline job concept wont be of any use. Therefore requesting you to expedite on this and provide us the update.

          Peter Thomson added a comment -

          Any news on this, like https://issues.jenkins-ci.org/secure/ViewProfile.jspa?name=naval_gupta01 We are also suffering within our Jenkins system due to this issue

          Peter Thomson added a comment - Any news on this, like https://issues.jenkins-ci.org/secure/ViewProfile.jspa?name=naval_gupta01  We are also suffering within our Jenkins system due to this issue

          J P added a comment - - edited

          We are on Jenkins 2.150.2 and Groovy Plugin 2.60.  We started getting this error when we upgraded Groovy to 2.6.1.  Our pipeline is about 690 lines.  It is a workflow to deploy 2 application components to staging servers and then to prod servers.  Please let us know when we can get an update on this.

          J P added a comment - - edited We are on Jenkins 2.150.2 and Groovy Plugin 2.60.  We started getting this error when we upgraded Groovy to 2.6.1.  Our pipeline is about 690 lines.  It is a workflow to deploy 2 application components to staging servers and then to prod servers.  Please let us know when we can get an update on this.

          I'm running into this more and more. I've put what makes sense into shared libraries and squeeze more and more into ugly "helper functions" outside of the pipeline but it's getting really hard.

           

          I really hope there is a better solution coming soon because I'm pretty sure that my coworkers are working with HR to have a talk with me about how much swearing I've been doing.

          Henry Borchers added a comment - I'm running into this more and more. I've put what makes sense into shared libraries and squeeze more and more into ugly "helper functions" outside of the pipeline but it's getting really hard.   I really hope there is a better solution coming soon because I'm pretty sure that my coworkers are working with HR to have a talk with me about how much swearing I've been doing.

          Wim Gaethofs added a comment -

          Even when putting everything into shared libraries, my pipeline code is still 700+ lines. 

          I had to split my code up into 2 jenkins jobs because of this issue. 

          Wim Gaethofs added a comment - Even when putting everything into shared libraries, my pipeline code is still 700+ lines.  I had to split my code up into 2 jenkins jobs because of this issue. 

          svanoort, it's been a few months since you teased us about something on your roadmap that would alleviate this issue. Any chance you could provide a little more info or at least tease us enough to wet our appetite? I'm running against the limit way too often these days. 

          Henry Borchers added a comment - svanoort , it's been a few months since you teased us about something on your roadmap that would alleviate this issue. Any chance you could provide a little more info or at least tease us enough to wet our appetite? I'm running against the limit way too often these days. 

          Jesse Glick added a comment -

          I am not aware of any plans to work on this issue. I tend to doubt it is fixable in the current Pipeline execution engine (workflow-cps), beyond better reporting the error. The known workaround is to split long blocks of code into distinct methods.

          Jesse Glick added a comment - I am not aware of any plans to work on this issue. I tend to doubt it is fixable in the current Pipeline execution engine ( workflow-cps ), beyond better reporting the error. The known workaround is to split long blocks of code into distinct methods.

          jglick, a few post ago you mentioned something about creating a different execution engine that wouldn't have this issue. Anything you can point me to so that I can follow the progress or, at least, is anything interesting that you can tease to keep me hopeful that the future looks bright?

          I have been putting any "steps block" that is more than 1 line into into helper functions but I'm still running into issues. 

          I'm sorry if I come off as nagging. I just really love Jenkins. The declarative pipeline has been my one of favorite tools which I used for everything I build, 

          Henry Borchers added a comment - jglick , a few post ago you mentioned something about creating a different execution engine that wouldn't have this issue. Anything you can point me to so that I can follow the progress or, at least, is anything interesting that you can tease to keep me hopeful that the future looks bright? I have been putting any "steps block" that is more than 1 line into into helper functions but I'm still running into issues.  I'm sorry if I come off as nagging. I just really love Jenkins. The declarative pipeline has been my one of favorite tools which I used for everything I build, 

          Jesse Glick added a comment -

          henryborchers I believe that work is now inactive. I am afraid I have no particular advice for now beyond:

          • If at all possible, remove logic from Pipeline Groovy code and move it into external processes. We see a lot of people with these very complex calculations that could better have been done in some Python script or whatever in the workspace, so that the Pipeline part would boil down to just node {sh './something'}.
          • When not possible (for example because the Pipeline script is actually required to determine how to configure steps such as parallel or Jenkins publishers), split up long functions (including the implicit main function at top level of a Jenkinsfile) into shorter functions.

          Jesse Glick added a comment - henryborchers I believe that work is now inactive. I am afraid I have no particular advice for now beyond: If at all possible, remove logic from Pipeline Groovy code and move it into external processes. We see a lot of people with these very complex calculations that could better have been done in some Python script or whatever in the workspace, so that the Pipeline part would boil down to just node {sh './something' }. When not possible (for example because the Pipeline script is actually required to determine how to configure steps such as parallel or Jenkins publishers), split up long functions (including the implicit main function at top level of a Jenkinsfile ) into shorter functions.

          Dee Kryvenko added a comment -

          Any `Jenkinsfile` of any complexity can be shortened to just one line that looks like `doStuff()`. Does it makes sense to do it that way? Probably not but hopefully gives an idea as to where to move with this issue.

          Dee Kryvenko added a comment - Any `Jenkinsfile` of any complexity can be shortened to just one line that looks like `doStuff()`. Does it makes sense to do it that way? Probably not but hopefully gives an idea as to where to move with this issue.

          Dee Kryvenko added a comment - - edited

          Let me re-phrase and sum-up some of the questions in that thread:

          I'm writing off my application and even though I moved bunch of the stuff into separate methods I still keep all of my high-level app working flow in my `main()` method and it is still to big and java complains about that. Can you fix it plz?

          I think the ticket may now be closed.

          Dee Kryvenko added a comment - - edited Let me re-phrase and sum-up some of the questions in that thread: I'm writing off my application and even though I moved bunch of the stuff into separate methods I still keep all of my high-level app working flow in my `main()` method and it is still to big and java complains about that. Can you fix it plz? I think the ticket may now be closed.

          Why you are talking about moving stuff into functions, and mention flows? This problem also reproducing in declarative pipelines, which do not have code at all. They just describes steps and each one is single-line and invokes built-in function.

          Sergey Avseyev added a comment - Why you are talking about moving stuff into functions, and mention flows? This problem also reproducing in declarative pipelines, which do not have code at all. They just describes steps and each one is single-line and invokes built-in function.

          Dee Kryvenko added a comment -

          Well if a declarative pipeline is so big that it won't fit into the limit - clearly the definition of a step needs some re-thinking. Sounds like a layer of abstraction required to wrap a multiple commonly-reusable steps into one to reduce the amount.

          Dee Kryvenko added a comment - Well if a declarative pipeline is so big that it won't fit into the limit - clearly the definition of a step needs some re-thinking. Sounds like a layer of abstraction required to wrap a multiple commonly-reusable steps into one to reduce the amount.

          are you saying that all steps I'm using in my pipeline also counted and inlined into result class object? stuff like zip(...), archiveartifacts, etc.?

          Sergey Avseyev added a comment - are you saying that all steps I'm using in my pipeline also counted and inlined into result class object? stuff like zip(...) , archiveartifacts , etc.?

          Dee Kryvenko added a comment -

          Entire Jenkinsfile effectively becomes a body to some sort of `eval` function under the hood (for the sake of simplification let's forget about CPS and stuff). It's no difference if you split the code into the methods and still keep the methods in Jenkinsfile. Methods needs to be moved into shared library or otherwise made available in the Jenkinsfile scope.
          No matter declarative or scripted pipeline - it's just directives that are effectively a Groovy closures. Standard java rules still applies no matter what.

          Dee Kryvenko added a comment - Entire Jenkinsfile effectively becomes a body to some sort of `eval` function under the hood (for the sake of simplification let's forget about CPS and stuff). It's no difference if you split the code into the methods and still keep the methods in Jenkinsfile. Methods needs to be moved into shared library or otherwise made available in the Jenkinsfile scope. No matter declarative or scripted pipeline - it's just directives that are effectively a Groovy closures. Standard java rules still applies no matter what.

          Jesse Glick added a comment -

          This problem also reproducing in declarative pipelines

          If true then it may be feasible to provide a fix in the pipeline-model-definition plugin, even without a general fix for Scripted.

          Jesse Glick added a comment - This problem also reproducing in declarative pipelines If true then it may be feasible to provide a fix in the pipeline-model-definition plugin, even without a general fix for Scripted.

          efo plo added a comment -

          We get this error in a purely declarative pipeline just by the sheer amount of 

          stage {  when { ... } 
              agent { ... } 
              steps { ... } 
              post { success { ... } failure { ... } cleanup { ... } }
          }

          Add parallels, rinse, repeat — Method code too large.

          Our steps {} are already a call to a single function.

          This would be great if we could produce the stages in a separate function or file, but so far we can't find anything with regards to how to possibly go about it.

          efo plo added a comment - We get this error in a purely declarative pipeline just by the sheer amount of  stage {  when { ... }     agent { ... }     steps { ... }      post { success { ... } failure { ... } cleanup { ... } } } Add parallels, rinse, repeat — Method code too large. Our steps {} are already a call to a single function. This would be great if we could produce the stages in a separate function or file, but so far we can't find anything with regards to how to possibly go about it.

          Wim Gaethofs added a comment -

          I'm seeing the same thing as 'efo plo' in declarative pipeline.  Only defining the flow in the pipeline with stages, and calling shared libraries and functions to execute code. 

          I now have 41 stages inside my pipeline{}. Adding just one more stage gives me this error. 

          Wim Gaethofs added a comment - I'm seeing the same thing as 'efo plo' in declarative pipeline.  Only defining the flow in the pipeline with stages, and calling shared libraries and functions to execute code.  I now have 41 stages inside my pipeline{}. Adding just one more stage gives me this error. 

          Jesse Glick added a comment -

          It would be helpful if someone observing this issue in Declarative could create a new issue in the pipeline-model-definition-plugin component (Link ed to this one) attaching a minimal, self-contained Jenkinsfile reproducing the error in a specified version of Jenkins and the workflow-cps (Pipeline: Groovy) and pipeline-model-definition (Pipeline: Declarative) plugins. I am not making any promises but that would at least improve the odds of a targeted fix for that case. (Bonus points for a pull request to jenkinsci/pipeline-model-definition-plugin adding an @Ignore d test case demonstrating the error.)

          Jesse Glick added a comment - It would be helpful if someone observing this issue in Declarative could create a new issue in the pipeline-model-definition-plugin component ( Link ed to this one) attaching a minimal, self-contained Jenkinsfile reproducing the error in a specified version of Jenkins and the workflow-cps ( Pipeline: Groovy ) and pipeline-model-definition ( Pipeline: Declarative ) plugins. I am not making any promises but that would at least improve the odds of a targeted fix for that case. (Bonus points for a pull request to jenkinsci/pipeline-model-definition-plugin adding an @Ignore d test case demonstrating the error.)

            Unassigned Unassigned
            anudeeplalam Anudeep Lalam
            Votes:
            87 Vote for this issue
            Watchers:
            103 Start watching this issue

              Created:
              Updated: