WIP: [JENKINS-63284] Add initial Pipeline job support for Groovy properties by M-r-A · Pull Request #47 · jenkinsci/active-choices-plugin

M-r-A · 2021-04-12T11:43:29Z

I want to add support for Pipeline job for Groovy script properties.

Currently, the plugin does not fully work with the Pipeline job: it uses classes that are specific only for the Freestyle job for getting extra data to inject to Groovy binding.

I changed plugin code to deal with Job/Run classes and added a test that demonstrates the result.

With these changes, users will be able to use jenkinsProject Groovy property with the Pipeline job.

Related issues: JENKINS-63284, JENKINS-65235, JENKINS-53554.
Related guide: Writing Pipeline-Compatible Plugins

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your master branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

…rid of annoying log messages

M-r-A · 2021-04-12T11:52:49Z

+    private static boolean isParameterDefinitionOf(@Nonnull String parameterUUID, @Nonnull Job<?, ?> project) {
        List<ParameterDefinition> parameterDefinitions = new ArrayList<>(getProjectParameterDefinitions(project));
-        for (List<ParameterDefinition> params : getBuildWrapperParameterDefinitions(project).values()) {
+        // TODO: Update or get rid of getBuildWrapperParameterDefinitions


@kinow Dear maintainers, please help me with this part of the plugin. I'm unsure how we use getBuildWrapperParameterDefinition and how we test that it works.
Do we still need it with all these introspections with BuildWrapper and all?

This isParameterDefinitionOf method is called as a fallback when we cannot find the project of the parameter.

We navigate all the projects in Jenkins, trying to find one that contains the parameter UUID. It is highly inefficient, but was the last resort after getting so many bugs from users with custom plug-ins that were modifying the structure of project <-> parameters (i.e. inserting extra nodes in-between these two).

It should work with pipeline jobs, no?

M-r-A · 2021-04-12T12:39:36Z

        String projectName = null;
        String projectFullName = null;
        if (currentRequest != null) {
+            // TODO: Check if we really need AbstractItem instead of Job class


@kinow Same for this commentary: why do we use AbstractItem here but then filter with Project class in getHelperParameters()?

From memory, the name or full name may have the project name. Or one of them may contain a folder name. Or a special object name (e.g. another plug-in that provides an AbstractItem.).

In case where the projectName is the name of an AbstractItem that is not a Project, we ignore that as we don't want to put another object instance in the jenkinsProject bound variable.

c4sh · 2022-02-01T08:49:50Z

Is there a reason why this was never finished ?

jan-stoltman-bolt · 2022-03-25T07:20:14Z

Hey @M-r-A @kinow would it be possible to finalize this PR? 🙏 This feature would be amazing to have

kinow · 2022-03-25T09:13:47Z

Hey @M-r-A @kinow would it be possible to finalize this PR? pray This feature would be amazing to have

Sorry, a bit strapped for time (life, work, being sponsored to work on other OSS projects, etc.)

Maybe someone could test the current PR with pipelines, and report whether it's working or not? That could help myself or another dev when re-starting the work on this code.

Cheers
Bruno

dimmel82 · 2022-08-17T11:57:52Z

Hi @kinow,
I merged the PR to the master branch in a local clone and built the plugin. After installing the plugin on Jenkins, I tried to define a ChoiceParameter (also tried with lower-case and camel-case) in a declarative pipeline's "parameters" block but got the following error which shows that only specific types of parameters are allowed:

org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
WorkflowScript: 286: Invalid parameter type "ChoiceParameter". Valid parameter types: [booleanParam, choice, credentials, extendedChoice, file, text, password, run, string] @ line 286, column 5.
       ChoiceParameter name: 'ENVIRONMENT'
       ^

Maybe additional development is required in other plugins to support this feature.
Please let me know if my approach with the "parameters" block was the indented one or if should test in a different way.

Thanks,
Dimitris

kinow · 2022-08-17T23:08:29Z

Thanks a lot for testing and reporting @dimmel82!

JinPengGeng · 2023-06-01T06:26:05Z

Is there an update? I have been looking for this feature for a long time

asetty · 2023-07-27T05:51:03Z

Pinging for updates

mvanini · 2023-12-17T10:41:03Z

Hi @kinow, I merged the PR to the master branch in a local clone and built the plugin. After installing the plugin on Jenkins, I tried to define a ChoiceParameter (also tried with lower-case and camel-case) in a declarative pipeline's "parameters" block but got the following error which shows that only specific types of parameters are allowed:
org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
WorkflowScript: 286: Invalid parameter type "ChoiceParameter". Valid parameter types: [booleanParam, choice, credentials, extendedChoice, file, text, password, run, string] @ line 286, column 5.
       ChoiceParameter name: 'ENVIRONMENT'
       ^
Maybe additional development is required in other plugins to support this feature. Please let me know if my approach with the "parameters" block was the indented one or if should test in a different way.

Thanks, Dimitris

This PR is only for having access to Jenkins API for pipeline job types from groovy code used in the parameter's script.
Definition of the active-choices parameters in declarative way are not implemented but sure it would be an amazing feature to have.
We used mixed scripted/declarative pipeline to define this type of parameters. Is not so cool but it works.

wrbst · 2025-04-14T11:55:42Z

Hey @M-r-A @kinow would it be possible to finalize this PR? pray This feature would be amazing to have

Sorry, a bit strapped for time (life, work, being sponsored to work on other OSS projects, etc.)

Maybe someone could test the current PR with pipelines, and report whether it's working or not? That could help myself or another dev when re-starting the work on this code.

Cheers Bruno

3 years later.
What is going on with this PR ?

kinow · 2025-04-14T12:52:41Z

Hi @wrbst

I merged changes contributed via PRs to adjust the code to changes in Jenkins upstream. The tests passed, and quick manual tests were OK too, and the code changes looked fine.

The plug-in releases got blocked due to regressions in the last release. It's been going for a few months already (you can check the commits & JIRA). Regressions and security bugs normally take most of my volunteer time to work on the plug-in.

You can see in the comments (above) that there were some errors with this PR on user's environments, so I planned to work on this when I had more time as I expect some hiccups and need to do more tests.

If OP can rebase and fix conflicts, and others can test & send PRs to update it fixing the code, it would be easier to review. Otherwise, I'll work on this when I have time to volunteer on this PR.

I'm highlighting this as you can see in this recent example that some users expect open source volunteers to prioritize the bugs/PRs regardless of their lives/jobs/family/personal issues/etc..

M-r-A added 4 commits April 12, 2021 13:45

[JENKINS-63284] Bump plugin-pom to version 4.17

1c73c50

[JENKINS-63284] Bump antisamy-markup-formatter to version 2.1 to get …

ebc77cb

…rid of annoying log messages

[JENKINS-63284] Add test for jenkinsProject Groovy property

2027890

[JENKINS-63284] Add support for Pipeline job

2025859

M-r-A commented Apr 12, 2021

View reviewed changes

Conversation

M-r-A commented Apr 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

M-r-A Apr 12, 2021

Choose a reason for hiding this comment

Uh oh!

kinow Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

M-r-A Apr 12, 2021

Choose a reason for hiding this comment

Uh oh!

kinow Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

c4sh commented Feb 1, 2022

Uh oh!

jan-stoltman-bolt commented Mar 25, 2022

Uh oh!

kinow commented Mar 25, 2022

Uh oh!

dimmel82 commented Aug 17, 2022

Uh oh!

kinow commented Aug 17, 2022

Uh oh!

JinPengGeng commented Jun 1, 2023

Uh oh!

asetty commented Jul 27, 2023

Uh oh!

mvanini commented Dec 17, 2023

Uh oh!

wrbst commented Apr 14, 2025

Uh oh!

kinow commented Apr 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

M-r-A commented Apr 12, 2021 •

edited

Loading