-
New Feature
-
Resolution: Fixed
-
Minor
-
-
workflow-support 2.22
It is currently not possible to access the Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses() function. An additional drawback to that approach is that is allows direct access to the actual Cause objects, which could potentially allow a malicious pipeline script to manipulate the Cause associated with an upstream build.
This jira and its associated PR propose a different approach based on the use of stapler's ModelBuilder to create a JSON representation of a Cause}}s {{@Exported fields:
For example, a build with a hudson.model.Cause$UserId cause produce the following output:
[{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }]
The JSON objects in the resulting array can be used directly in a pipeline:
assert currentBuild.getBuildCauses().size() == 1 assert currentBuild.getBuildCauses()[0].userId == 'tester' echo currentBuild.getBuildCauses()[0].shortDescription
Additionally, you can filter the result of currentBuild.getBuildCauses() by passing a class name (or superclass name) of the type you would like to filter by. For example, to get a list of build Cause objects that only contains Cause objects of type hudson.model.Cause$UserIdCause, call the method like this:
echo currentBuild.getBuildCauses('hudson.model.Cause$UserIdCause').size()
- duplicates
-
JENKINS-41272 Pipeline "currentBuild" should expose build causes
-
- Resolved
-
- is duplicated by
-
-
- Resolved
-
- relates to
-
-
- Open
-
- links to
[JENKINS-54227] Safely expose the Cause(s) associated with the current build
mike cirioli
created issue -
mike cirioli
made changes -
| Description |
Original:
It is currently not possible to access the <code>Cause</code>s of a build without using the non-whitelisted <code>currentBuild.getRawBuild().getCauses()</code> function. An additional drawback to that approach is that is allows direct access to the actual <code>Cause</code> objects, which could potentially allow a malicious pipeline script to manipulate the <code>Cause</code> associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a <code>Cause</code>s <code>@Exported</code> fields: For example, a build with a <code>hudson.model.Cause$UserId</code> cause produce the following output: <code:json> [ { "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" } ] </code> |
New:
It is currently not possible to access the <code>Cause</code>s of a build without using the non-whitelisted \{code}currentBuild.getRawBuild().getCauses()\{/code} function. An additional drawback to that approach is that is allows direct access to the actual <code>Cause</code> objects, which could potentially allow a malicious pipeline script to manipulate the <code>Cause</code> associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a <code>Cause</code>s <code>@Exported</code> fields: For example, a build with a <code>hudson.model.Cause$UserId</code> cause produce the following output: <code:json> [ { "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" } ] </code> |
mike cirioli
made changes -
| Description |
Original:
It is currently not possible to access the <code>Cause</code>s of a build without using the non-whitelisted \{code}currentBuild.getRawBuild().getCauses()\{/code} function. An additional drawback to that approach is that is allows direct access to the actual <code>Cause</code> objects, which could potentially allow a malicious pipeline script to manipulate the <code>Cause</code> associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a <code>Cause</code>s <code>@Exported</code> fields: For example, a build with a <code>hudson.model.Cause$UserId</code> cause produce the following output: <code:json> [ { "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" } ] </code> |
New:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [ { "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" } ] {code} |
mike cirioli
made changes -
| Description |
Original:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [ { "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" } ] {code} |
New:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }]{code} |
mike cirioli
made changes -
| Description |
Original:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }]{code} |
New:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }] {code} The JSON objects in the resulting array can be used directly in a pipeline: {code:json} assert currentBuild.getBuildCauses().size() == 1 assert currentBuild.getBuildCauses()[0].userId == 'tester' echo currentBuild.getBuildCauses()[0].shortDescription {code} Additionally, you can filter the result of {{currentBuild.getBuildCauses()}} by passing a class (or superclass) of the type you would like to filter by. For example, to get a list of build {{Cause}}s that only contains {{Cause}}s of type {{hudson.model.Cause$UserIdCause}}, call the method like this: {code:json} echo currentBuild.getBuildCauses(hudson.model.Cause$UserIdCause).size() {code} |
mike cirioli
made changes -
| Description |
Original:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's <code>ModelBuilder</code> to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }] {code} The JSON objects in the resulting array can be used directly in a pipeline: {code:json} assert currentBuild.getBuildCauses().size() == 1 assert currentBuild.getBuildCauses()[0].userId == 'tester' echo currentBuild.getBuildCauses()[0].shortDescription {code} Additionally, you can filter the result of {{currentBuild.getBuildCauses()}} by passing a class (or superclass) of the type you would like to filter by. For example, to get a list of build {{Cause}}s that only contains {{Cause}}s of type {{hudson.model.Cause$UserIdCause}}, call the method like this: {code:json} echo currentBuild.getBuildCauses(hudson.model.Cause$UserIdCause).size() {code} |
New:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's {{ModelBuilder}} to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }] {code} The JSON objects in the resulting array can be used directly in a pipeline: {code:json} assert currentBuild.getBuildCauses().size() == 1 assert currentBuild.getBuildCauses()[0].userId == 'tester' echo currentBuild.getBuildCauses()[0].shortDescription {code} Additionally, you can filter the result of {{currentBuild.getBuildCauses()}} by passing a class (or superclass) of the type you would like to filter by. For example, to get a list of build {{Cause}}s that only contains {{Cause}}s of type {{hudson.model.Cause$UserIdCause}}, call the method like this: {code:json} echo currentBuild.getBuildCauses(hudson.model.Cause$UserIdCause).size() {code} |
| Released As | New: workflow-support 2.22 | |
| Resolution | New: Fixed [ 1 ] | |
| Status | Original: Open [ 1 ] | New: Resolved [ 5 ] |
| Link |
New:
This issue duplicates |
| Description |
Original:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's {{ModelBuilder}} to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }] {code} The JSON objects in the resulting array can be used directly in a pipeline: {code:json} assert currentBuild.getBuildCauses().size() == 1 assert currentBuild.getBuildCauses()[0].userId == 'tester' echo currentBuild.getBuildCauses()[0].shortDescription {code} Additionally, you can filter the result of {{currentBuild.getBuildCauses()}} by passing a class (or superclass) of the type you would like to filter by. For example, to get a list of build {{Cause}}s that only contains {{Cause}}s of type {{hudson.model.Cause$UserIdCause}}, call the method like this: {code:json} echo currentBuild.getBuildCauses(hudson.model.Cause$UserIdCause).size() {code} |
New:
It is currently not possible to access the {{Cause}}s of a build without using the non-whitelisted {{currentBuild.getRawBuild().getCauses()}} function. An additional drawback to that approach is that is allows direct access to the actual {{Cause}} objects, which could potentially allow a malicious pipeline script to manipulate the {{Cause}} associated with an upstream build. This jira and its associated PR propose a different approach based on the use of stapler's {{ModelBuilder}} to create a JSON representation of a {{Cause}}s {{@Exported}} fields: For example, a build with a {{hudson.model.Cause$UserId}} cause produce the following output: {code:json} [{ "_class":"hudson.model.Cause$UserIdCause", "shortDescription":"Started by user anonymous", "userId":"tester", "userName":"anonymous" }] {code} The JSON objects in the resulting array can be used directly in a pipeline: {code:json} assert currentBuild.getBuildCauses().size() == 1 assert currentBuild.getBuildCauses()[0].userId == 'tester' echo currentBuild.getBuildCauses()[0].shortDescription {code} Additionally, you can filter the result of {{currentBuild.getBuildCauses()}} by passing a class name (or superclass name) of the type you would like to filter by. For example, to get a list of build {{Cause}}s that only contains {{Cause}}s of type {{hudson.model.Cause$UserIdCause}}, call the method like this: {code:json} echo currentBuild.getBuildCauses("hudson.model.Cause$UserIdCause").size() {code} |
Release in version 2.22 of the Pipeline Supporting APIs Plugin.