Skip to content

Fix missing gitlabUserUsername definition for MR and Note triggers #1469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ljackiewicz wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Fix missing gitlabUserUsername definition for MR and Note triggers #1469

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
32c8e82
gitlabUserUsername variable is not set for MR trigger
ljackiewicz May 8, 2023
02cba11
gitlabUserUsername variable is not set for Note (comments) trigger
ljackiewicz May 9, 2023
947445a
Merge branch 'master' into fix/missing-defined-variables
krisstern May 10, 2023
c39ff4d
Merge branch 'master' of https://github.com/jenkinsci/gitlab-plugin i…
krisstern May 29, 2023
5671b24
Applying code review suggestions
krisstern May 29, 2023
c602665
Leave the previous values for gitlabUserName and gitlabUserEmail
ljackiewicz May 22, 2023
aee617b
Change confusing variable name
ljackiewicz May 22, 2023
3ff76f2
Merge branch 'master' into fix/missing-defined-variables
ljackiewicz Jun 26, 2023
dc00bd1
Merge branch 'master' into fix/missing-defined-variables
krisstern Jul 30, 2023
6404ccf
Merge branch 'master' into fix/missing-defined-variables
ljackiewicz Nov 16, 2023
41b249f
Merge remote-tracking branch 'upstream/master' into fix/missing-defin…
MarkEWaite Dec 30, 2023
f8006a6
Merge branch 'master' into fix/missing-defined-variables
ljackiewicz Feb 5, 2024
6fb9468
Merge branch 'master' into fix/missing-defined-variables
krisstern Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions ...om/dabsquared/gitlabjenkins/trigger/handler/merge/MergeRequestHookTriggerHandlerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,10 +196,9 @@ protected CauseData retrieveCauseData(MergeRequestHook hook) {
.withTargetProjectId(hook.getObjectAttributes().getTargetProjectId())
.withBranch(hook.getObjectAttributes().getSourceBranch())
.withSourceBranch(hook.getObjectAttributes().getSourceBranch())
.withUserName(
hook.getObjectAttributes().getLastCommit().getAuthor().getName())
.withUserEmail(
hook.getObjectAttributes().getLastCommit().getAuthor().getEmail())
.withUserName(hook.getUser().getName())
.withUserUsername(hook.getUser().getUsername())
Copy link
Copy Markdown
Member

@krisstern krisstern May 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the UserUsername cannot be returned here with hook.getObjectAttributes().getLastCommit().getAuthor().getUsername() then we will need some upstream changes. I don't think we are supposed to stray from the pattern prescribed, as the suggested hook.getUser().getUsername() would obviously return something not related to the Last Commit Author.

Copy link
Copy Markdown
Contributor Author

@ljackiewicz ljackiewicz May 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, and I mentioned that it can be confusing that gitlabUserName and gitlabUserUsername can represent two different persons.
It was probably a mistake that the author of the last commit was set as the author of the merge request (in case of MR Event) or comment (in case of Note Event).

.withUserEmail(hook.getUser().getEmail())
Comment thread
krisstern marked this conversation as resolved.
Outdated
.withSourceRepoHomepage(hook.getObjectAttributes().getSource().getHomepage())
.withSourceRepoName(hook.getObjectAttributes().getSource().getName())
.withSourceNamespace(hook.getObjectAttributes().getSource().getNamespace())
Expand Down
6 changes: 3 additions & 3 deletions ...in/java/com/dabsquared/gitlabjenkins/trigger/handler/note/NoteHookTriggerHandlerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ protected CauseData retrieveCauseData(NoteHook hook) {
.withTargetProjectId(hook.getMergeRequest().getTargetProjectId())
.withBranch(hook.getMergeRequest().getSourceBranch())
.withSourceBranch(hook.getMergeRequest().getSourceBranch())
.withUserName(hook.getMergeRequest().getLastCommit().getAuthor().getName())
.withUserEmail(
hook.getMergeRequest().getLastCommit().getAuthor().getEmail())
.withUserName(hook.getUser().getName())
.withUserUsername(hook.getUser().getUsername())
.withUserEmail(hook.getUser().getEmail())
Comment thread
krisstern marked this conversation as resolved.
Outdated
.withSourceRepoHomepage(hook.getMergeRequest().getSource().getHomepage())
.withSourceRepoName(hook.getMergeRequest().getSource().getName())
.withSourceNamespace(hook.getMergeRequest().getSource().getNamespace())
Expand Down
7 changes: 7 additions & 0 deletions src/test/java/com/dabsquared/gitlabjenkins/trigger/handler/PendingBuildsHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,13 @@ private MergeRequestHook mergeRequestHook(int projectId, String branch, String c
.withProject(ProjectBuilder.project()
.withWebUrl("https://gitlab.org/test.git")
.build())
.withUser(user().withId(1)
.withName("User")
.withUsername("user")
.withEmail("user@gitlab.com")
.withAvatarUrl(
"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon")
.build())
.build();
}

Expand Down
28 changes: 28 additions & 0 deletions ...absquared/gitlabjenkins/trigger/handler/merge/MergeRequestHookTriggerHandlerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,13 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
.withProject(project()
.withWebUrl("https://gitlab.org/test.git")
.build())
.withUser(user().withId(1)
.withName("User")
.withUsername("user")
.withEmail("user@gitlab.com")
.withAvatarUrl(
"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon")
.build())
.build(),
true,
BranchFilterFactory.newBranchFilter(branchFilterConfig().build(BranchFilterType.All)),
Expand All @@ -452,6 +459,13 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
.withProject(project()
.withWebUrl("https://gitlab.org/test.git")
.build())
.withUser(user().withId(1)
.withName("User")
.withUsername("user")
.withEmail("user@gitlab.com")
.withAvatarUrl(
"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon")
.build())
.build(),
true,
BranchFilterFactory.newBranchFilter(branchFilterConfig().build(BranchFilterType.All)),
Expand Down Expand Up @@ -541,6 +555,13 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
.withProject(project()
.withWebUrl("https://gitlab.org/test.git")
.build())
.withUser(user().withId(1)
.withName("User")
.withUsername("user")
.withEmail("user@gitlab.com")
.withAvatarUrl(
"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon")
.build())
.build(),
true,
BranchFilterFactory.newBranchFilter(branchFilterConfig().build(BranchFilterType.All)),
Expand Down Expand Up @@ -575,6 +596,13 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
.withId("testid")
.build())
.build())
.withUser(user().withId(1)
.withName("User")
.withUsername("user")
.withEmail("user@gitlab.com")
.withAvatarUrl(
"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon")
.build())
.build(),
true,
BranchFilterFactory.newBranchFilter(branchFilterConfig().build(BranchFilterType.All)),
Expand Down
7 changes: 7 additions & 0 deletions ...ava/com/dabsquared/gitlabjenkins/trigger/handler/note/NoteHookTriggerHandlerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,13 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
.withWebUrl("https://gitlab.org/test.git")
.build())
.build())
.withUser(user().withId(1)
.withName("User")
.withUsername("user")
.withEmail("user@gitlab.com")
.withAvatarUrl(
"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon")
.build())
.build(),
true,
BranchFilterFactory.newBranchFilter(branchFilterConfig().build(BranchFilterType.All)),
Expand Down
4 changes: 4 additions & 0 deletions src/test/java/com/dabsquared/gitlabjenkins/webhook/build/MergeRequestBuildActionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.dabsquared.gitlabjenkins.webhook.build;

import static com.dabsquared.gitlabjenkins.cause.CauseDataBuilder.causeData;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.notNullValue;
Expand Down Expand Up @@ -107,6 +108,9 @@ public void build() throws IOException {
verify(mockTrigger).onPost(pushHookArgumentCaptor.capture());
assertThat(pushHookArgumentCaptor.getValue().getProject(), is(notNullValue()));
assertThat(pushHookArgumentCaptor.getValue().getProject().getWebUrl(), is(notNullValue()));
assertThat(pushHookArgumentCaptor.getValue().getUser(), is(notNullValue()));
assertThat(pushHookArgumentCaptor.getValue().getUser().getName(), containsString("Administrator"));
assertThat(pushHookArgumentCaptor.getValue().getUser().getUsername(), containsString("root"));
Comment thread
krisstern marked this conversation as resolved.
Outdated
Copy link
Copy Markdown
Member

@krisstern krisstern May 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually this only checks for when the User's name contains "Administrator" and the User's username is "root" by design. But there should be no harm done by adding this code snippet.

}
}

Expand Down
25 changes: 18 additions & 7 deletions src/test/java/com/dabsquared/gitlabjenkins/webhook/build/NoteBuildActionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
package com.dabsquared.gitlabjenkins.webhook.build;

import static com.dabsquared.gitlabjenkins.cause.CauseDataBuilder.causeData;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.notNullValue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;

Expand Down Expand Up @@ -28,6 +32,7 @@
import org.jvnet.hudson.test.JenkinsRule;
import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.StaplerResponse;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

Expand Down Expand Up @@ -68,13 +73,19 @@ public void setup() throws Exception {

@Test
public void build() throws IOException {
FreeStyleProject testProject = jenkins.createFreeStyleProject();
testProject.addTrigger(trigger);

exception.expect(HttpResponses.HttpResponseException.class);
new NoteBuildAction(testProject, getJson("NoteEvent.json"), null).execute(response);

verify(trigger).onPost(any(NoteHook.class));
try {
FreeStyleProject testProject = jenkins.createFreeStyleProject();
testProject.addTrigger(trigger);

exception.expect(HttpResponses.HttpResponseException.class);
new NoteBuildAction(testProject, getJson("NoteEvent.json"), null).execute(response);
} finally {
ArgumentCaptor<NoteHook> noteHookArgumentCaptor = ArgumentCaptor.forClass(NoteHook.class);
verify(trigger).onPost(noteHookArgumentCaptor.capture());
assertThat(noteHookArgumentCaptor.getValue().getUser(), is(notNullValue()));
assertThat(noteHookArgumentCaptor.getValue().getUser().getName(), containsString("Administrator"));
assertThat(noteHookArgumentCaptor.getValue().getUser().getUsername(), containsString("root"));
Comment thread
krisstern marked this conversation as resolved.
}
}

@Test
Expand Down