Skip to content

Commit a6ed0f6

Browse files
stianststianst
committed
Support state reason for issues
Closes #1792
1 parent be00e51 commit a6ed0f6

File tree

19 files changed

+1114
-1
lines changed

19 files changed

+1114
-1
lines changed

‎src/main/java/org/kohsuke/github/GHIssue.java‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@
3535
import java.util.Collection;
3636
import java.util.Collections;
3737
import java.util.Date;
38+
import java.util.HashMap;
3839
import java.util.List;
3940
import java.util.Locale;
41+
import java.util.Map;
4042
import java.util.Objects;
4143

4244
import static org.kohsuke.github.internal.Previews.SQUIRREL_GIRL;
@@ -67,6 +69,9 @@ public class GHIssue extends GHObject implements Reactable {
6769
/** The state. */
6870
protected String state;
6971

72+
/** The state. */
73+
protected String state_reason;
74+
7075
/** The number. */
7176
protected int number;
7277

@@ -198,6 +203,17 @@ public GHIssueState getState() {
198203
return Enum.valueOf(GHIssueState.class, state.toUpperCase(Locale.ENGLISH));
199204
}
200205

206+
/**
207+
* Gets state reason.
208+
*
209+
* @return the state reason
210+
*/
211+
public GHIssueStateReason getStateReason() {
212+
return state_reason != null
213+
? Enum.valueOf(GHIssueStateReason.class, state_reason.toUpperCase(Locale.ENGLISH))
214+
: null;
215+
}
216+
201217
/**
202218
* Gets labels.
203219
*
@@ -273,6 +289,10 @@ private void edit(String key, Object value) throws IOException {
273289
root().createRequest().with(key, value).method("PATCH").withUrlPath(getApiRoute()).send();
274290
}
275291

292+
private void edit(Map<String, Object> map) throws IOException {
293+
root().createRequest().with(map).method("PATCH").withUrlPath(getApiRoute()).send();
294+
}
295+
276296
/**
277297
* Identical to edit(), but allows null for the value.
278298
*/
@@ -294,6 +314,19 @@ public void close() throws IOException {
294314
edit("state", "closed");
295315
}
296316

317+
/**
318+
* Closes this issue.
319+
*
320+
* @throws IOException
321+
* the io exception
322+
*/
323+
public void close(GHIssueStateReason reason) throws IOException {
324+
Map<String, Object> map = new HashMap<>();
325+
map.put("state", "closed");
326+
map.put("state_reason", reason.name().toLowerCase(Locale.ENGLISH));
327+
edit(map);
328+
}
329+
297330
/**
298331
* Reopens this issue.
299332
*

‎src/main/java/org/kohsuke/github/GHIssueStateReason.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*
2+
* The MIT License
3+
*
4+
* Copyright (c) 2011, Eric Maupin
5+
*
6+
* Permission is hereby granted, free of charge, to any person obtaining a copy
7+
* of this software and associated documentation files (the "Software"), to deal
8+
* in the Software without restriction, including without limitation the rights
9+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
* copies of the Software, and to permit persons to whom the Software is
11+
* furnished to do so, subject to the following conditions:
12+
*
13+
* The above copyright notice and this permission notice shall be included in
14+
* all copies or substantial portions of the Software.
15+
*
16+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22+
* THE SOFTWARE.
23+
*/
24+
25+
package org.kohsuke.github;
26+
27+
public enum GHIssueStateReason {
28+
29+
COMPLETED, NOT_PLANNED
30+
}

‎src/test/java/org/kohsuke/github/GHIssueTest.java‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import static org.hamcrest.Matchers.hasSize;
1919
import static org.hamcrest.Matchers.is;
2020
import static org.hamcrest.Matchers.notNullValue;
21+
import static org.hamcrest.Matchers.nullValue;
2122

2223
// TODO: Auto-generated Javadoc
2324
/**
@@ -158,7 +159,33 @@ public void closeIssue() throws Exception {
158159
assertThat(issue.getTitle(), equalTo(name));
159160
assertThat(getRepository().getIssue(issue.getNumber()).getState(), equalTo(GHIssueState.OPEN));
160161
issue.close();
161-
assertThat(getRepository().getIssue(issue.getNumber()).getState(), equalTo(GHIssueState.CLOSED));
162+
GHIssue closedIssued = getRepository().getIssue(issue.getNumber());
163+
assertThat(closedIssued.getState(), equalTo(GHIssueState.CLOSED));
164+
assertThat(closedIssued.getStateReason(), equalTo(GHIssueStateReason.COMPLETED));
165+
}
166+
167+
/**
168+
* Close issue as not planned.
169+
*
170+
* @throws Exception
171+
* the exception
172+
*/
173+
@Test
174+
public void closeIssueNotPlanned() throws Exception {
175+
String name = "closeIssueNotPlanned";
176+
GHIssue issue = getRepository().createIssue(name).body("## test").create();
177+
assertThat(issue.getTitle(), equalTo(name));
178+
179+
GHIssue createdIssue = issue.getRepository().getIssue(issue.getNumber());
180+
181+
assertThat(createdIssue.getState(), equalTo(GHIssueState.OPEN));
182+
assertThat(createdIssue.getStateReason(), nullValue());
183+
184+
issue.close(GHIssueStateReason.NOT_PLANNED);
185+
186+
GHIssue closedIssued = getRepository().getIssue(issue.getNumber());
187+
assertThat(closedIssued.getState(), equalTo(GHIssueState.CLOSED));
188+
assertThat(closedIssued.getStateReason(), equalTo(GHIssueStateReason.NOT_PLANNED));
162189
}
163190

164191
/**

‎src/test/resources/org/kohsuke/github/GHIssueTest/wiremock/closeIssueNotPlanned/__files/1-user.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"login": "stianst",
3+
"id": 2271511,
4+
"node_id": "MDQ6VXNlcjIyNzE1MTE=",
5+
"avatar_url": "https://avatars.githubusercontent.com/u/2271511?v=4",
6+
"gravatar_id": "",
7+
"url": "https://api.github.com/users/stianst",
8+
"html_url": "https://github.com/stianst",
9+
"followers_url": "https://api.github.com/users/stianst/followers",
10+
"following_url": "https://api.github.com/users/stianst/following{/other_user}",
11+
"gists_url": "https://api.github.com/users/stianst/gists{/gist_id}",
12+
"starred_url": "https://api.github.com/users/stianst/starred{/owner}{/repo}",
13+
"subscriptions_url": "https://api.github.com/users/stianst/subscriptions",
14+
"organizations_url": "https://api.github.com/users/stianst/orgs",
15+
"repos_url": "https://api.github.com/users/stianst/repos",
16+
"events_url": "https://api.github.com/users/stianst/events{/privacy}",
17+
"received_events_url": "https://api.github.com/users/stianst/received_events",
18+
"type": "User",
19+
"site_admin": false,
20+
"name": "Stian Thorgersen",
21+
"company": "Red Hat",
22+
"blog": "",
23+
"location": null,
24+
"email": "stian@redhat.com",
25+
"hireable": null,
26+
"bio": "Keycloak Project Lead",
27+
"twitter_username": null,
28+
"public_repos": 39,
29+
"public_gists": 20,
30+
"followers": 454,
31+
"following": 1,
32+
"created_at": "2012-09-03T14:55:29Z",
33+
"updated_at": "2023-11-20T07:52:25Z"
34+
}

‎src/test/resources/org/kohsuke/github/GHIssueTest/wiremock/closeIssueNotPlanned/__files/2-orgs_hub4j-test-org.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"login": "hub4j-test-org",
3+
"id": 160007886,
4+
"node_id": "O_kgDOCYmGzg",
5+
"url": "https://api.github.com/orgs/hub4j-test-org",
6+
"repos_url": "https://api.github.com/orgs/hub4j-test-org/repos",
7+
"events_url": "https://api.github.com/orgs/hub4j-test-org/events",
8+
"hooks_url": "https://api.github.com/orgs/hub4j-test-org/hooks",
9+
"issues_url": "https://api.github.com/orgs/hub4j-test-org/issues",
10+
"members_url": "https://api.github.com/orgs/hub4j-test-org/members{/member}",
11+
"public_members_url": "https://api.github.com/orgs/hub4j-test-org/public_members{/member}",
12+
"avatar_url": "https://avatars.githubusercontent.com/u/160007886?v=4",
13+
"description": null,
14+
"is_verified": false,
15+
"has_organization_projects": true,
16+
"has_repository_projects": true,
17+
"public_repos": 1,
18+
"public_gists": 0,
19+
"followers": 0,
20+
"following": 0,
21+
"html_url": "https://github.com/hub4j-test-org",
22+
"created_at": "2024-02-14T08:57:43Z",
23+
"updated_at": "2024-02-14T08:57:43Z",
24+
"archived_at": null,
25+
"type": "Organization"
26+
}

‎src/test/resources/org/kohsuke/github/GHIssueTest/wiremock/closeIssueNotPlanned/__files/3-r_s_ghissuetest.json‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
{
2+
"id": 757320982,
3+
"node_id": "R_kgDOLSPNFg",
4+
"name": "GHIssueTest",
5+
"full_name": "hub4j-test-org/GHIssueTest",
6+
"private": false,
7+
"owner": {
8+
"login": "hub4j-test-org",
9+
"id": 160007886,
10+
"node_id": "O_kgDOCYmGzg",
11+
"avatar_url": "https://avatars.githubusercontent.com/u/160007886?v=4",
12+
"gravatar_id": "",
13+
"url": "https://api.github.com/users/hub4j-test-org",
14+
"html_url": "https://github.com/hub4j-test-org",
15+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
16+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
17+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
18+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
19+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
20+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
21+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
22+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
23+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
24+
"type": "Organization",
25+
"site_admin": false
26+
},
27+
"html_url": "https://github.com/hub4j-test-org/GHIssueTest",
28+
"description": null,
29+
"fork": false,
30+
"url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest",
31+
"forks_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/forks",
32+
"keys_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/keys{/key_id}",
33+
"collaborators_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/collaborators{/collaborator}",
34+
"teams_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/teams",
35+
"hooks_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/hooks",
36+
"issue_events_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/issues/events{/number}",
37+
"events_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/events",
38+
"assignees_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/assignees{/user}",
39+
"branches_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/branches{/branch}",
40+
"tags_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/tags",
41+
"blobs_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/git/blobs{/sha}",
42+
"git_tags_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/git/tags{/sha}",
43+
"git_refs_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/git/refs{/sha}",
44+
"trees_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/git/trees{/sha}",
45+
"statuses_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/statuses/{sha}",
46+
"languages_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/languages",
47+
"stargazers_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/stargazers",
48+
"contributors_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/contributors",
49+
"subscribers_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/subscribers",
50+
"subscription_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/subscription",
51+
"commits_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/commits{/sha}",
52+
"git_commits_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/git/commits{/sha}",
53+
"comments_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/comments{/number}",
54+
"issue_comment_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/issues/comments{/number}",
55+
"contents_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/contents/{+path}",
56+
"compare_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/compare/{base}...{head}",
57+
"merges_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/merges",
58+
"archive_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/{archive_format}{/ref}",
59+
"downloads_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/downloads",
60+
"issues_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/issues{/number}",
61+
"pulls_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/pulls{/number}",
62+
"milestones_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/milestones{/number}",
63+
"notifications_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/notifications{?since,all,participating}",
64+
"labels_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/labels{/name}",
65+
"releases_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/releases{/id}",
66+
"deployments_url": "https://api.github.com/repos/hub4j-test-org/GHIssueTest/deployments",
67+
"created_at": "2024-02-14T08:58:05Z",
68+
"updated_at": "2024-02-14T08:58:05Z",
69+
"pushed_at": "2024-02-14T08:58:05Z",
70+
"git_url": "git://github.com/hub4j-test-org/GHIssueTest.git",
71+
"ssh_url": "git@github.com:hub4j-test-org/GHIssueTest.git",
72+
"clone_url": "https://github.com/hub4j-test-org/GHIssueTest.git",
73+
"svn_url": "https://github.com/hub4j-test-org/GHIssueTest",
74+
"homepage": null,
75+
"size": 0,
76+
"stargazers_count": 0,
77+
"watchers_count": 0,
78+
"language": null,
79+
"has_issues": true,
80+
"has_projects": true,
81+
"has_downloads": true,
82+
"has_wiki": true,
83+
"has_pages": false,
84+
"has_discussions": false,
85+
"forks_count": 0,
86+
"mirror_url": null,
87+
"archived": false,
88+
"disabled": false,
89+
"open_issues_count": 0,
90+
"license": null,
91+
"allow_forking": true,
92+
"is_template": false,
93+
"web_commit_signoff_required": false,
94+
"topics": [],
95+
"visibility": "public",
96+
"forks": 0,
97+
"open_issues": 0,
98+
"watchers": 0,
99+
"default_branch": "main",
100+
"permissions": {
101+
"admin": true,
102+
"maintain": true,
103+
"push": true,
104+
"triage": true,
105+
"pull": true
106+
},
107+
"custom_properties": {},
108+
"organization": {
109+
"login": "hub4j-test-org",
110+
"id": 160007886,
111+
"node_id": "O_kgDOCYmGzg",
112+
"avatar_url": "https://avatars.githubusercontent.com/u/160007886?v=4",
113+
"gravatar_id": "",
114+
"url": "https://api.github.com/users/hub4j-test-org",
115+
"html_url": "https://github.com/hub4j-test-org",
116+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
117+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
118+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
119+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
120+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
121+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
122+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
123+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
124+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
125+
"type": "Organization",
126+
"site_admin": false
127+
},
128+
"network_count": 0,
129+
"subscribers_count": 0
130+
}

0 commit comments

Comments
 (0)