-
Bug
-
Resolution: Unresolved
-
Minor
-
None
Attempting to lock a resource label in a declarative pipeline script fails with the following error:
org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
WorkflowScript: 7: Missing required parameter: "resource" @ line 7, column 17.
lock(label: 'foo') {
^
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:430)
at org.jenkinsci.plugins.workflow.cps.CpsFlowExecution.start(CpsFlowExecution.java:393)
at org.jenkinsci.plugins.workflow.job.WorkflowRun.run(WorkflowRun.java:238)
at hudson.model.ResourceController.execute(ResourceController.java:98)
at hudson.model.Executor.run(Executor.java:404)
Finished: FAILURE
The error was generated by the following declarative pipeline script:
pipeline {
agent none
stages {
stage('Build') {
agent none
steps {
lock(label: 'foo') {
echo 'Do something here that requires unique access to the resource'
}
}
}
}
}
If resource is swapped in for label, the script is able to execute. Likewise if lock call is called from a non-declarative pipeline, label works fine.
[JENKINS-43002] Unable to lock by label in a declarative pipeline script
fwiw, you can do lock(resource: null, label: 'foo') and that'll work fine. I think. If it doesn't, i.e., if it errors out during Declarative validation due to the null, that's a Declarative bug. =)
fwiw, you can do lock(resource: null, label: 'foo') and that'll work fine. I think.
Confirmed (Jenkins 2.150.3, pipeline-model-definition 1.3.4.1).
Tobias Gruetzmacher
added a comment - I'm not really sure how that can be fixed without breaking backward-compatibility with the one-argument lock-step for scripted pipeline...
Tobias Gruetzmacher
added a comment - I'm not really sure how that can be fixed without breaking backward-compatibility with the one-argument lock-step for scripted pipeline... I was looking for how others solved this problem ("fixed without breaking backward-compatibility"). The answer is: fixes are not backward-compatible. Some examples:
- sauce-ondemand-plugin:
JENKINS-41236(see changes in code) - stashnotifier-plugin: #245 (see changes in code)
Maybe it is a good time for Lockable Resources plugin 3.X ? 
You will be able to fix the bug and you don't have to afraid about backward-compatibility (because it is a new major version). What do you think?
Yeah, the underlying problem is that the @DataBoundConstructor for the lock step still requires resource. In Scripted Pipeline, with named arguments, the actual call ends up having resource: null magically included, but in Declarative's validation process, we can't know that yeah, this isn't really a required parameter, so...