Skip to content

Commit 27f511a

Browse files
lucaslslucasls
committed
Add methods to retrieve a single discussion from a Merge Request
1 parent 05d4eb9 commit 27f511a

File tree

3 files changed

+116
-13
lines changed

3 files changed

+116
-13
lines changed

‎gitlab4j-api/src/main/java/org/gitlab4j/api/DiscussionsApi.java‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,50 @@ public Stream<Discussion> getMergeRequestDiscussionsStream(Object projectIdOrPat
361361
return (pager.stream());
362362
}
363363

364+
/**
365+
* Get a single discussion for the specified merge request.
366+
*
367+
* <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id</code></pre>
368+
*
369+
* @param projectIdOrPath projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
370+
* @param mergeRequestIid the internal ID of the merge request
371+
* @param discussionId the ID of the discussion
372+
* @return the Discussion instance specified by discussionId for the specified merge request
373+
* @throws GitLabApiException if any exception occurs during execution
374+
*/
375+
public Discussion getMergeRequestDiscussion(Object projectIdOrPath, Long mergeRequestIid, String discussionId)
376+
throws GitLabApiException {
377+
Response response = get(
378+
Response.Status.OK,
379+
null,
380+
"projects",
381+
getProjectIdOrPath(projectIdOrPath),
382+
"merge_requests",
383+
mergeRequestIid,
384+
"discussions",
385+
discussionId);
386+
return (response.readEntity(Discussion.class));
387+
}
388+
389+
/**
390+
* Get an Optional instance of a single discussion for the specified merge request.
391+
*
392+
* <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id</code></pre>
393+
*
394+
* @param projectIdOrPath projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
395+
* @param mergeRequestIid the internal ID of the merge request
396+
* @param discussionId the ID of the discussion
397+
* @return an Optional instance with the specified Discussion instance as a value
398+
*/
399+
public Optional<Discussion> getOptionalMergeRequestDiscussion(Object projectIdOrPath, Long mergeRequestIid, String discussionId)
400+
throws GitLabApiException {
401+
try {
402+
return (Optional.ofNullable(getMergeRequestDiscussion(projectIdOrPath, mergeRequestIid, discussionId)));
403+
} catch (GitLabApiException glae) {
404+
return (GitLabApi.createOptionalFromException(glae));
405+
}
406+
}
407+
364408
/**
365409
* Creates a new discussion to a single project merge request. This is similar to creating
366410
* a note but other comments (replies) can be added to it later.

‎gitlab4j-api/src/test/java/org/gitlab4j/api/TestMergeRequestDiscussionsApi.java‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
11
package org.gitlab4j.api;
22

3-
import static org.gitlab4j.api.JsonUtils.compareJson;
4-
import static org.junit.jupiter.api.Assertions.assertNotNull;
5-
import static org.junit.jupiter.api.Assertions.assertTrue;
6-
import static org.mockito.ArgumentMatchers.any;
7-
import static org.mockito.Mockito.when;
8-
import static org.mockito.MockitoAnnotations.openMocks;
9-
10-
import java.util.List;
11-
import java.util.stream.Collectors;
12-
import java.util.stream.Stream;
13-
143
import jakarta.ws.rs.core.MultivaluedMap;
15-
164
import org.gitlab4j.api.models.Discussion;
175
import org.gitlab4j.models.Constants;
186
import org.junit.jupiter.api.BeforeEach;
@@ -22,6 +10,18 @@
2210
import org.mockito.Mock;
2311
import org.mockito.Mockito;
2412

13+
import java.util.List;
14+
import java.util.Optional;
15+
import java.util.stream.Collectors;
16+
import java.util.stream.Stream;
17+
18+
import static org.gitlab4j.api.JsonUtils.compareJson;
19+
import static org.junit.jupiter.api.Assertions.assertNotNull;
20+
import static org.junit.jupiter.api.Assertions.assertTrue;
21+
import static org.mockito.ArgumentMatchers.any;
22+
import static org.mockito.Mockito.when;
23+
import static org.mockito.MockitoAnnotations.openMocks;
24+
2525
public class TestMergeRequestDiscussionsApi implements Constants {
2626

2727
@Mock
@@ -38,7 +38,7 @@ public class TestMergeRequestDiscussionsApi implements Constants {
3838
@BeforeEach
3939
public void setUp() throws Exception {
4040
openMocks(this);
41-
response = new MockResponse(Discussion.class, null, "merge-request-discussions.json");
41+
response = new MockResponse(Discussion.class, "merge-request-discussion.json", "merge-request-discussions.json");
4242
when(gitLabApi.getApiClient()).thenReturn(gitLabApiClient);
4343
when(gitLabApiClient.validateSecretToken(any())).thenReturn(true);
4444
when(gitLabApiClient.get(attributeCaptor.capture(), Mockito.any(Object[].class)))
@@ -73,4 +73,18 @@ public void testGetMergeRequestDiscussionsByStream() throws Exception {
7373
List<Discussion> discussions = stream.collect(Collectors.toList());
7474
assertTrue(compareJson(discussions, "merge-request-discussions.json"));
7575
}
76+
77+
@Test
78+
public void testGetMergeRequestDiscussion() throws Exception {
79+
Discussion discussion = new DiscussionsApi(gitLabApi).getMergeRequestDiscussion(1L, 1L, "1");
80+
assertNotNull(discussion);
81+
assertTrue(compareJson(discussion, "merge-request-discussion.json"));
82+
}
83+
84+
@Test
85+
public void testGetOptionalMergeRequestDiscussion() throws Exception {
86+
Optional<Discussion> discussion = new DiscussionsApi(gitLabApi).getOptionalMergeRequestDiscussion(1L, 1L, "");
87+
assertTrue(discussion.isPresent());
88+
assertTrue(compareJson(discussion.get(), "merge-request-discussion.json"));
89+
}
7690
}

‎gitlab4j-api/src/test/resources/org/gitlab4j/api/merge-request-discussion.json‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
3+
"individual_note": false,
4+
"notes": [
5+
{
6+
"id": 1126,
7+
"type": "DiscussionNote",
8+
"author": {
9+
"id": 1,
10+
"name": "root",
11+
"username": "root",
12+
"state": "active",
13+
"avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
14+
"web_url": "http://localhost:3000/root"
15+
},
16+
"created_at": "2018-03-03T21:54:39.668Z",
17+
"updated_at": "2018-03-03T21:54:39.668Z",
18+
"system": false,
19+
"noteable_id": 3,
20+
"noteable_type": "Merge request",
21+
"resolved": false,
22+
"resolvable": true
23+
},
24+
{
25+
"id": 1129,
26+
"type": "DiscussionNote",
27+
"body": "reply to the discussion",
28+
"author": {
29+
"id": 1,
30+
"name": "root",
31+
"username": "root",
32+
"state": "active",
33+
"avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
34+
"web_url": "http://localhost:3000/root"
35+
},
36+
"created_at": "2018-03-04T13:38:02.127Z",
37+
"updated_at": "2018-03-04T13:38:02.127Z",
38+
"system": false,
39+
"noteable_id": 3,
40+
"noteable_type": "Merge request",
41+
"resolved": false,
42+
"resolvable": true
43+
}
44+
]
45+
}

0 commit comments

Comments
 (0)