Merge pull request #1175 from t0m4uk1991/issue_rename_event_add_from_to_metadata

Add mapping for from/to fields in issue rename event

Author: bitwiseman

src/main/java/org/kohsuke/github/GHIssueEvent.java

@@ -21,6 +21,7 @@ public class GHIssueEvent extends GitHubInteractiveObject {
     private GHMilestone milestone;
     private GHLabel label;
     private GHUser assignee;
+    private GHIssueRename rename;
 
     private GHIssue issue;
 
@@ -144,6 +145,16 @@ public GHUser getAssignee() {
         return assignee;
     }
 
+    /**
+     * Get the {@link GHIssueRename} that contains information about issue old and new name. Only present for event
+     * "renamed", <code>null</code> otherwise.
+     *
+     * @return the GHIssueRename
+     */
+    public GHIssueRename getRename() {
+        return this.rename;
+    }
+
     GHIssueEvent wrapUp(GitHub root) {
         this.root = root;
         return this;

src/main/java/org/kohsuke/github/GHIssueRename.java

@@ -0,0 +1,32 @@
+package org.kohsuke.github;
+
+/**
+ * The type GHIssueRename.
+ *
+ * @see <a href="https://docs.github.com/en/developers/webhooks-and-events/events/issue-event-types#renamed">Github
+ *      documentation for renamed event</a>
+ *
+ * @author Andrii Tomchuk
+ */
+public class GHIssueRename {
+    private String from = "";
+    private String to = "";
+
+    /**
+     * Old issue name.
+     *
+     * @return old issue name
+     */
+    public String getFrom() {
+        return this.from;
+    }
+
+    /**
+     * New issue name.
+     *
+     * @return new issue name
+     */
+    public String getTo() {
+        return this.to;
+    }
+}

src/test/java/org/kohsuke/github/GHIssueEventTest.java

@@ -39,6 +39,40 @@ public void testEventsForSingleIssue() throws Exception {
         issue.close();
     }
 
+    @Test
+    public void testEventsForIssueRename() throws Exception {
+        // Create the issue.
+        GHRepository repo = getRepository();
+        GHIssueBuilder builder = repo.createIssue("Some invalid issue name");
+        GHIssue issue = builder.create();
+
+        // Generate rename event.
+        issue.setTitle("Fixed issue name");
+
+        // Test that the event is present.
+        List<GHIssueEvent> list = issue.listEvents().toList();
+        assertThat(list.size(), equalTo(1));
+
+        GHIssueEvent event = list.get(0);
+        assertThat(event.getIssue().getNumber(), equalTo(issue.getNumber()));
+        assertThat(event.getEvent(), equalTo("renamed"));
+        assertThat(event.getRename(), notNullValue());
+        assertThat(event.getRename().getFrom(), equalTo("Some invalid issue name"));
+        assertThat(event.getRename().getTo(), equalTo("Fixed issue name"));
+
+        // Test that we can get a single event directly.
+        GHIssueEvent eventFromRepo = repo.getIssueEvent(event.getId());
+        assertThat(eventFromRepo.getId(), equalTo(event.getId()));
+        assertThat(eventFromRepo.getCreatedAt(), equalTo(event.getCreatedAt()));
+        assertThat(eventFromRepo.getEvent(), equalTo("renamed"));
+        assertThat(eventFromRepo.getRename(), notNullValue());
+        assertThat(eventFromRepo.getRename().getFrom(), equalTo("Some invalid issue name"));
+        assertThat(eventFromRepo.getRename().getTo(), equalTo("Fixed issue name"));
+
+        // Close the issue.
+        issue.close();
+    }
+
     @Test
     public void testRepositoryEvents() throws Exception {
         GHRepository repo = getRepository();

src/test/resources/org/kohsuke/github/GHIssueEventTest/wiremock/testEventsForIssueRename/__files/orgs_hub4j-test-org-2.json

@@ -0,0 +1,31 @@
+{
+  "login": "hub4j-test-org",
+  "id": 7544739,
+  "node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
+  "url": "https://api.github.com/orgs/hub4j-test-org",
+  "repos_url": "https://api.github.com/orgs/hub4j-test-org/repos",
+  "events_url": "https://api.github.com/orgs/hub4j-test-org/events",
+  "hooks_url": "https://api.github.com/orgs/hub4j-test-org/hooks",
+  "issues_url": "https://api.github.com/orgs/hub4j-test-org/issues",
+  "members_url": "https://api.github.com/orgs/hub4j-test-org/members{/member}",
+  "public_members_url": "https://api.github.com/orgs/hub4j-test-org/public_members{/member}",
+  "avatar_url": "https://avatars.githubusercontent.com/u/7544739?v=4",
+  "description": "Hub4j Test Org Description (this could be null or blank too)",
+  "name": "Hub4j Test Org Name (this could be null or blank too)",
+  "company": null,
+  "blog": "https://hub4j.url.io/could/be/null",
+  "location": "Hub4j Test Org Location (this could be null or blank too)",
+  "email": "hub4jtestorgemail@could.be.null.com",
+  "twitter_username": null,
+  "is_verified": false,
+  "has_organization_projects": true,
+  "has_repository_projects": true,
+  "public_repos": 18,
+  "public_gists": 0,
+  "followers": 0,
+  "following": 0,
+  "html_url": "https://github.com/hub4j-test-org",
+  "created_at": "2014-05-10T19:39:11Z",
+  "updated_at": "2020-06-04T05:56:10Z",
+  "type": "Organization"
+}