Add merge request labels to environment variables #1713

yiftahw · 2024-10-22T07:21:42Z

many thanks to @anton-johansson at #901 and @jakub-bochenski at #646 for starting this work
closes #900

Done

rebased work from Provide merge request labels as environment variables #901 to latest master branch
provided test cases at GitLabEnvironmentContributorTest.java
added pipeline helper function GitLabMergeRequestLabelExists("some label") -> Boolean
added explanation to README.md
provided test cases at GitLabMergeRequestLabelExistsStepTest.java
indentation fix in src/docker/README.md

groovy example of using the helper function:

if (GitLabMergeRequestLabelExists("test label")) {
    echo "test label found"
}

groovy example of echoing all the labels:

// Check if the environment variable is null (should never be empty - see unit tests)
if (env.gitlabMergeRequestLabels == null) {
    echo "No merge request labels provided."
} else {
    // Split the labels by commas and trim each label
    def labels = env.gitlabMergeRequestLabels.split(',').collect { it.trim() }
    echo "Merge request labels:"
    labels.each { label -> echo label }
}

Testing done

test set up:
- OpenSUSE Leap 15.6 VM
- Java 17 (openjdk)
- Maven 3.9.9
- docker running inside the VM
  - changed the Jenkins tag to 2.479 (with lts I got an error when trying to install the plugin: Jenkins minimum version required: 2.479)
  - GitLab tags tested: latest (17.5), 15.11.13-ce.0
built the plugin with mvn deploy and manually installed to Jenkins with the web UI.
created a pipeline in Jenkins, integrated it to GitLab and observed the behavior of new environment variable and helper function in push and merge request hooks.

Note

@anton-johansson provided a note in his merge request Provide merge request labels as environment variables #901 that this doesn't work when putting comments to merge requests, because the webhook doesn't contain the labels.
using the GitLab Jenkins Integration (under Settings -> Integrations -> Jenkins) doesn't send webhooks on comments.
using a generic web trigger (under Settings -> Webhooks) allows sending hooks on comments, and according to the oldest doc online - GitLab 15.6 Webhook events it does send the labels on comments in merge requests.
the class NoteHook doesn't handle the labels

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main 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

…actory

src/test/java/com/dabsquared/gitlabjenkins/environment/GitLabEnvironmentContributorTest.java

krisstern

Hi @yiftahw, I think this implementation looks good but maybe we could add some instructions on how to use this feature before I can accept and merge this?

krisstern · 2024-10-23T11:12:41Z

You can basically just copy and past what you have in the description to the README we have at the root

yiftahw · 2024-10-23T12:52:52Z

You can basically just copy and past what you have in the description to the README we have at the root

@krisstern thinking about what to put in the README, I thought to myself that people that will want to use this feature will probably suffer from some boilerplate of parsing the string held by the environment variable...
I'm working now on adding a function called GitLabMergeRequestLabelExists("some label") -> Boolean
I'm kind of copying the mechanism used in AcceptGitLabMergeRequestStep
your thoughts?

example pipeline:

script {
    if (GitLabMergeRequestLabelExists("bugfix"))
    {
        echo 'bugfix label detected!'
    }
}

instead of:

script {
    if (env.gitlabMergeRequestLabels) {
        def labels = env.gitlabMergeRequestLabels.split(',').collect { it.trim() }
        if ('bugfix' in labels) {
            echo 'bugfix label detected!'
        }
    }
}

I'm moving this to draft as I need to add some unit-tests but form initial testing with the docker setup it looks to be working fine

krisstern · 2024-10-23T16:39:01Z

Hi @yiftahw, regarding:

I'm working now on adding a function called GitLabMergeRequestLabelExists("some label") -> Boolean
I'm kind of copying the mechanism used in AcceptGitLabMergeRequestStep
your thoughts

Sounds like a reasonable approach to me! Please go ahead with the implementation.

krisstern

Some more changes before we are good to go

src/test/java/com/dabsquared/gitlabjenkins/workflow/GitLabMergeRequestLabelExistsStepTest.java

Co-authored-by: Kris Stern <krisstern@outlook.com>

krisstern · 2024-10-24T12:02:34Z

Please apply mvn spotless:apply to fix the spotless issues

krisstern

LGTM

krisstern · 2024-10-24T12:30:46Z

Hi @yiftahw the PR looks good now, thanks for your contribution! I will let it sit for between 24 and 48 hours before I merge it if there is no objection from the community.

yiftahw · 2024-10-25T09:54:14Z

@krisstern before merging, I have some changes that close #1715 , they are pretty minor, should I push these changes here and you'll review them?
you can view them here
TL;DR now both MergeRequestAttributes and MergeRequestHook have a member List<MergeRequestLabel> labels, which more accurately models the webhook payloads. (before that, only MergeRequestHook held the labels)

krisstern · 2024-10-25T15:09:29Z

Hi @yiftahw I think it may be better to create another PR to address issue #1715. I can review that and merge it before cutting a new release.

yiftahw added 6 commits October 21, 2024 21:03

fix in readme

65d0b99

update readme

00101fa

collect labels from merge request web hook and fill in to causeData f…

82c6600

…actory

add merge request labels to CauseData

2954e91

mvn spotless apply

c3bfbb4

simple test case

4eed37c

github-actions bot added documentation Improvements or additions to documentation tests This PR adds/removes/updates test cases labels Oct 22, 2024

yiftahw changed the title ~~Feature add labels to env~~ Add merge request labels to environment variables Oct 22, 2024

yiftahw added 4 commits October 22, 2024 10:32

mvn spotless apply

0461e15

simple unit tests

04f9a2b

cleanup

dfa7a01

mvn spotless apply

497624d

yiftahw marked this pull request as ready for review October 22, 2024 09:17

yiftahw requested a review from a team as a code owner October 22, 2024 09:17

unify labels unit tests logic

383e0d0

krisstern requested changes Oct 23, 2024

View reviewed changes

src/test/java/com/dabsquared/gitlabjenkins/environment/GitLabEnvironmentContributorTest.java Outdated Show resolved Hide resolved

src/test/java/com/dabsquared/gitlabjenkins/environment/GitLabEnvironmentContributorTest.java Outdated Show resolved Hide resolved

argument naming fix

9b66ecc

yiftahw requested a review from krisstern October 23, 2024 09:20

krisstern requested changes Oct 23, 2024

View reviewed changes

yiftahw marked this pull request as draft October 23, 2024 13:35

merge request labels checker helper function

4a177a7

yiftahw added 5 commits October 24, 2024 08:12

update readme

4fd02b0

update readme

d921b32

GitLabMergeRequestExistsStepTest

9c26509

update unit tests for label exists step

94329ab

1 more unit test

2fde2b1

yiftahw marked this pull request as ready for review October 24, 2024 09:12

yiftahw requested a review from krisstern October 24, 2024 09:12

yiftahw marked this pull request as draft October 24, 2024 09:33

yiftahw marked this pull request as ready for review October 24, 2024 09:33

yiftahw added 2 commits October 24, 2024 12:36

move unit test resource to pipeline folder

87ff244

add author comment

e4cd230

krisstern requested changes Oct 24, 2024

View reviewed changes

yiftahw and others added 2 commits October 24, 2024 14:46

Apply suggestions from code review

4dc1697

Co-authored-by: Kris Stern <krisstern@outlook.com>

fix names

dc08e3f

mvn spotless apply

0fdddd0

krisstern approved these changes Oct 24, 2024

View reviewed changes

krisstern added the hacktoberfest-accepted label Oct 24, 2024

Merge branch 'master' into feature-add-labels-to-env

7a8a714

yiftahw mentioned this pull request Oct 24, 2024

Provide merge request labels in comment webhooks (when using GitLab Webhook) #1715

Closed

krisstern mentioned this pull request Oct 24, 2024

Avoid caching the credential, instead get the credential value whenever it is required through the request filter #1712

Merged

6 tasks

krisstern merged commit b661e62 into jenkinsci:master Oct 25, 2024

yiftahw mentioned this pull request Oct 26, 2024

Handle merge request labels in Note Webhooks (comments) #1717

Merged

6 tasks

yiftahw deleted the feature-add-labels-to-env branch November 12, 2024 07:12

Add merge request labels to environment variables #1713

Add merge request labels to environment variables #1713

Uh oh!

Conversation

yiftahw commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Done

groovy example of using the helper function:

groovy example of echoing all the labels:

Testing done

Note

Submitter checklist

Uh oh!

Uh oh!

Uh oh!

krisstern left a comment

Choose a reason for hiding this comment

Uh oh!

krisstern commented Oct 23, 2024

Uh oh!

yiftahw commented Oct 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krisstern commented Oct 23, 2024

Uh oh!

krisstern left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

krisstern commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krisstern left a comment

Choose a reason for hiding this comment

Uh oh!

krisstern commented Oct 24, 2024

Uh oh!

yiftahw commented Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krisstern commented Oct 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yiftahw commented Oct 22, 2024 •

edited

Loading

yiftahw commented Oct 23, 2024 •

edited

Loading

krisstern commented Oct 24, 2024 •

edited

Loading

yiftahw commented Oct 25, 2024 •

edited

Loading