-
New Feature
-
Resolution: Fixed
-
Minor
-
None
It's very possible that someone will want to bring in an external library, which we're unfamiliar with or just don't include. If they could add an @Grab to get it, it's add up a lot of functionality.
Comments / References from Original Github Issue
andrewharmellaw referenced this issue 8 months ago
Closed
Issue #18: Facilitate DSL Extensions
andrewharmellaw commented 8 months ago
Sounds great. This is anther way of looking at the issue I created (#18). This is more idiomatic than mine though. I'll close it.
- is related to
-
-
- Open
-
-
-
- Open
-
[JENKINS-16361] @Grab Grape support
Andrew Harmel-Law
created issue -
Daniel Spilker
added a comment - I tried to implement the two solutions I suggested above.
- Adding the Ivy library to jenkins.war works. The plugin does not need to be changed.
- Adding the Groovy library to the plugin does not work so well. Fortunately no classloader magic on the plugin side is required since Jenkins can hide classes from a plugin when the plugin specifies a "Mask-Classes" attribute in the manifest. I implemented that in a branch, see https://github.com/CoreMedia/job-dsl-plugin/commit/830fae7a0fd8a046c620600e46633166804190e3. Script execution with @Grab works. Unfortunately this needs some workaround in the gradle build and currently breaks "gradlew server". The server does not start because it can not find the Groovy classes. It also breaks rendering the GeneratedJobsBuildAction with a java.lang.VerifyError when deploying to a running instance of Jenkins.
Daniel Spilker
added a comment - I tried to implement the two solutions I suggested above.
Adding the Ivy library to jenkins.war works. The plugin does not need to be changed.
Adding the Groovy library to the plugin does not work so well. Fortunately no classloader magic on the plugin side is required since Jenkins can hide classes from a plugin when the plugin specifies a "Mask-Classes" attribute in the manifest. I implemented that in a branch, see https://github.com/CoreMedia/job-dsl-plugin/commit/830fae7a0fd8a046c620600e46633166804190e3 . Script execution with @Grab works. Unfortunately this needs some workaround in the gradle build and currently breaks "gradlew server". The server does not start because it can not find the Groovy classes. It also breaks rendering the GeneratedJobsBuildAction with a java.lang.VerifyError when deploying to a running instance of Jenkins.
Excellent research so far. I really need to get this working, so I'll try to find some time this week to review what you've found so far. Though I'm curious what problem you found by default, it sounded like an Ivy problem. And what problem did you see when you added Ivy to the plugin?
Daniel Spilker
added a comment - When adding Ivy to the plugin without using "Mask-Classes", the exception is the same as without Ivy.
Daniel Spilker
added a comment - When adding Ivy to the plugin without using "Mask-Classes", the exception is the same as without Ivy. | Status | Original: Open [ 1 ] | New: In Progress [ 3 ] |
I think I got this figured out. Daniel, your research was spot on. There is no all-groovy or no-groovy solution, but there is a compromise. The trick is to just get Grape into the plugin classloader, so it can see the plugin's Ivy. I'll send you the code review.
Can someone review: https://github.com/jenkinsci/job-dsl-plugin/pull/51
Andrew Harmel-Law
added a comment - Done. I'm giving 10 hours to see if anyone else wants to have a look too. Great work. Do you want to put something up on the wiki too? I created a "User Power Moves" page yesterday where this (using @Grab) would fit nicely...
Andrew Harmel-Law
added a comment - Done. I'm giving 10 hours to see if anyone else wants to have a look too. Great work. Do you want to put something up on the wiki too? I created a "User Power Moves" page yesterday where this (using @Grab) would fit nicely... Let's leave this open until after it's documented. I just started using this feature today, so give me a few days to clean it up to be used as an example. Thanks for adding the page.
I did some investigation why this is not working. When using the @Grap annotation in a script the exception below is thrown. Adding the Ivy library to the plugin did not fix the problem.
Each plugin is loaded with a separate classloader and the plugin classloaders are children of the Jenkins classloader. Since Groovy is provided by Jenkins, the Groovy classes are loaded by the Jenkins classloader. But the Ivy classes are not visible to the Jenkins classloader, they are only visible to the plugin classloader. So they can not be loaded when reference from Groovy classes which leads to the exception.
There are at least two solutions for this problem: