feat: Add head_commit to GHEventPayload.Push

rahulsom · rahulsom · commit 1876a6991ac8 · 2022-12-22T15:39:37.000-08:00
When that class represents a commit being pushed to a branch, the list of commits is available and useful to know what was pushed. When it represents a tag being pushed, the list of commits can be empty. The `head_commit` comes in handy to know more about the commit. This change exposes `head_commit` using the getter `getHeadCommit()`. The test data already has the data for this to work. The test case has been updated to test for this method. Refs: hub4j#1585
diff --git a/src/main/java/org/kohsuke/github/GHEventPayload.java b/src/main/java/org/kohsuke/github/GHEventPayload.java
@@ -1043,6 +1043,7 @@ public static class Push extends GHEventPayload {
         private String ref;
         private int size;
         private List<PushCommit> commits;
+        private PushCommit headCommit;
         private Pusher pusher;
         private String compare;
 
@@ -1124,6 +1125,16 @@ public List<PushCommit> getCommits() {
             return Collections.unmodifiableList(commits);
         }
 
+        /**
+         * The head commit of the push.
+         *
+         * @return the commit
+         */
+        @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+        public PushCommit getHeadCommit() {
+            return headCommit;
+        }
+
         /**
          * Gets pusher.
          *
diff --git a/src/test/java/org/kohsuke/github/GHEventPayloadTest.java b/src/test/java/org/kohsuke/github/GHEventPayloadTest.java
@@ -624,6 +624,18 @@ public void push() throws Exception {
         assertThat(event.getCommits().get(0).getRemoved().size(), is(0));
         assertThat(event.getCommits().get(0).getModified().size(), is(1));
         assertThat(event.getCommits().get(0).getModified().get(0), is("README.md"));
+
+        assertThat(event.getHeadCommit().getSha(), is("0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c"));
+        assertThat(event.getHeadCommit().getAuthor().getEmail(), is("baxterthehacker@users.noreply.github.com"));
+        assertThat(event.getHeadCommit().getAuthor().getUsername(), is("baxterthehacker"));
+        assertThat(event.getHeadCommit().getCommitter().getEmail(), is("baxterthehacker@users.noreply.github.com"));
+        assertThat(event.getHeadCommit().getCommitter().getUsername(), is("baxterthehacker"));
+        assertThat(event.getHeadCommit().getAdded().size(), is(0));
+        assertThat(event.getHeadCommit().getRemoved().size(), is(0));
+        assertThat(event.getHeadCommit().getModified().size(), is(1));
+        assertThat(event.getHeadCommit().getModified().get(0), is("README.md"));
+        assertThat(event.getHeadCommit().getMessage(), is("Update README.md"));
+
         SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
         formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
         assertThat(formatter.format(event.getCommits().get(0).getTimestamp()), is("2015-05-05T23:40:15Z"));
