fix: allow null app ids to provide the same behaviour as the deprecated endpoint & post-review changes

Author: tginiotis-at-work

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

@@ -1,5 +1,6 @@
 package org.kohsuke.github;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
@@ -226,6 +227,8 @@ public boolean isEnabled() {
      */
     public static class Check {
         private String context;
+
+        @JsonInclude(JsonInclude.Include.NON_NULL)
         private Integer appId;
 
         /**
@@ -240,7 +243,9 @@ public Check() {
          * @param context
          *            the context string of the check
          * @param appId
-         *            the application ID the check is supposed to come from
+         *            the application ID the check is supposed to come from. Pass "-1" to explicitly allow any app to
+         *            set the status. Pass "null" to automatically select the GitHub App that has recently provided this
+         *            check.
          */
         public Check(String context, Integer appId) {
             this.context = context;

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

@@ -11,6 +11,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import static org.kohsuke.github.internal.Previews.LUKE_CAGE;
 
@@ -50,11 +51,8 @@ public class GHBranchProtectionBuilder {
      *            the checks
      * @return the gh branch protection builder
      */
-    public GHBranchProtectionBuilder addRequiredChecksWithAppIds(Collection<GHBranchProtection.Check> checks) {
-        if (!(getStatusChecks() instanceof StatusChecksWithAppId)) {
-            statusChecks = new StatusChecksWithAppId();
-        }
-        ((StatusChecksWithAppId) getStatusChecks()).checks.addAll(checks);
+    public GHBranchProtectionBuilder addRequiredStatusChecks(Collection<GHBranchProtection.Check> checks) {
+        getStatusChecks().checks.addAll(checks);
         return this;
     }
 
@@ -67,10 +65,9 @@ public GHBranchProtectionBuilder addRequiredChecksWithAppIds(Collection<GHBranch
      */
     @Deprecated
     public GHBranchProtectionBuilder addRequiredChecks(Collection<String> checks) {
-        if (!(getStatusChecks() instanceof StatusChecksDeprecated)) {
-            statusChecks = new StatusChecksDeprecated();
-        }
-        ((StatusChecksDeprecated) getStatusChecks()).contexts.addAll(checks);
+        getStatusChecks().checks.addAll(checks.stream()
+                .map(context -> new GHBranchProtection.Check(context, null))
+                .collect(Collectors.toList()));
         return this;
     }
 
@@ -94,8 +91,8 @@ public GHBranchProtectionBuilder addRequiredChecks(String... checks) {
      *            the checks
      * @return the gh branch protection builder
      */
-    public GHBranchProtectionBuilder addRequiredChecksWithAppIds(GHBranchProtection.Check... checks) {
-        addRequiredChecksWithAppIds(Arrays.asList(checks));
+    public GHBranchProtectionBuilder addRequiredChecks(GHBranchProtection.Check... checks) {
+        addRequiredStatusChecks(Arrays.asList(checks));
         return this;
     }
 
@@ -564,7 +561,7 @@ private Restrictions getRestrictions() {
 
     private StatusChecks getStatusChecks() {
         if (statusChecks == null) {
-            statusChecks = new StatusChecksWithAppId();
+            statusChecks = new StatusChecks();
         }
         return statusChecks;
     }
@@ -578,15 +575,8 @@ private static class Restrictions {
         private Set<String> users = new HashSet<String>();
     }
 
-    private static abstract class StatusChecks {
-        boolean strict;
-    }
-
-    private static class StatusChecksWithAppId extends StatusChecks {
+    private static class StatusChecks {
         final List<GHBranchProtection.Check> checks = new ArrayList<>();
-    }
-
-    private static class StatusChecksDeprecated extends StatusChecks {
-        final List<String> contexts = new ArrayList<>();
+        boolean strict;
     }
 }

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

@@ -200,18 +200,20 @@ public void testSignedCommits() throws Exception {
     @Test
     public void testChecksWithAppIds() throws Exception {
         GHBranchProtection protection = branch.enableProtection()
-                .addRequiredChecksWithAppIds(new GHBranchProtection.Check("context", -1),
-                        new GHBranchProtection.Check("context2", 123))
+                .addRequiredChecks(new GHBranchProtection.Check("context", -1),
+                        new GHBranchProtection.Check("context2", 123),
+                        new GHBranchProtection.Check("context3", null))
                 .enable();
 
         ArrayList<GHBranchProtection.Check> resultChecks = new ArrayList<>(
                 protection.getRequiredStatusChecks().getChecks());
 
-        assertThat(resultChecks.size(), is(2));
+        assertThat(resultChecks.size(), is(3));
         assertThat(resultChecks.get(0).getContext(), is("context"));
         assertThat(resultChecks.get(0).getAppId(), nullValue());
         assertThat(resultChecks.get(1).getContext(), is("context2"));
         assertThat(resultChecks.get(1).getAppId(), is(123));
+        assertThat(resultChecks.get(2).getContext(), is("context3"));
     }
 
     /**

src/test/resources/org/kohsuke/github/GHBranchProtectionTest/wiremock/testChecksWithAppIds/__files/6-r_h_t_branches_main_protection.json

@@ -0,0 +1,56 @@
+{
+  "url": "https://api.github.com/repos/hub4j-test-org/temp-testChecksWithAppIds/branches/main/protection",
+  "required_status_checks": {
+    "url": "https://api.github.com/repos/hub4j-test-org/temp-testChecksWithAppIds/branches/main/protection/required_status_checks",
+    "strict": false,
+    "contexts": [
+      "context",
+      "context2",
+      "context3"
+    ],
+    "contexts_url": "https://api.github.com/repos/hub4j-test-org/temp-testChecksWithAppIds/branches/main/protection/required_status_checks/contexts",
+    "checks": [
+      {
+        "context": "context",
+        "app_id": null
+      },
+      {
+        "context": "context2",
+        "app_id": 123
+      },
+      {
+        "context": "context3",
+        "app_id": null
+      }
+    ]
+  },
+  "required_signatures": {
+    "url": "https://api.github.com/repos/hub4j-test-org/temp-testChecksWithAppIds/branches/main/protection/required_signatures",
+    "enabled": false
+  },
+  "enforce_admins": {
+    "url": "https://api.github.com/repos/hub4j-test-org/temp-testChecksWithAppIds/branches/main/protection/enforce_admins",
+    "enabled": false
+  },
+  "required_linear_history": {
+    "enabled": false
+  },
+  "allow_force_pushes": {
+    "enabled": false
+  },
+  "allow_deletions": {
+    "enabled": false
+  },
+  "block_creations": {
+    "enabled": false
+  },
+  "required_conversation_resolution": {
+    "enabled": false
+  },
+  "lock_branch": {
+    "enabled": false
+  },
+  "allow_fork_syncing": {
+    "enabled": false
+  }
+}

src/test/resources/org/kohsuke/github/GHBranchProtectionTest/wiremock/testChecksWithAppIds/mappings/6-r_h_t_branches_main_protection.json

@@ -0,0 +1,57 @@
+{
+  "id": "9f6f5be6-b5c5-4840-865c-ba84ad262118",
+  "name": "repos_hub4j-test-org_temp-testcheckswithappids_branches_main_protection",
+  "request": {
+    "url": "/repos/hub4j-test-org/temp-testChecksWithAppIds/branches/main/protection",
+    "method": "PUT",
+    "headers": {
+      "Accept": {
+        "equalTo": "application/vnd.github.luke-cage-preview+json"
+      }
+    },
+    "bodyPatterns": [
+      {
+        "equalToJson": "{\"required_pull_request_reviews\":null,\"required_status_checks\":{\"checks\":[{\"context\":\"context\",\"app_id\":-1},{\"context\":\"context2\",\"app_id\":123},{\"context\":\"context3\"}],\"strict\":false},\"restrictions\":null,\"enforce_admins\":false}",
+        "ignoreArrayOrder": true,
+        "ignoreExtraElements": false
+      }
+    ]
+  },
+  "response": {
+    "status": 200,
+    "bodyFileName": "6-r_h_t_branches_main_protection.json",
+    "headers": {
+      "Server": "GitHub.com",
+      "Date": "Thu, 13 Jun 2024 14:46:41 GMT",
+      "Content-Type": "application/json; charset=utf-8",
+      "Cache-Control": "private, max-age=60, s-maxage=60",
+      "Vary": [
+        "Accept, Authorization, Cookie, X-GitHub-OTP",
+        "Accept-Encoding, Accept, X-Requested-With"
+      ],
+      "ETag": "W/\"59d4b1a76c2903c6f8950aecee97ded98e0a0704a6ec06aebd22434d63b3a19c\"",
+      "X-OAuth-Scopes": "admin:enterprise, admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, admin:ssh_signing_key, audit_log, codespace, copilot, delete:packages, delete_repo, gist, notifications, project, repo, user, workflow, write:discussion, write:packages",
+      "X-Accepted-OAuth-Scopes": "",
+      "github-authentication-token-expiration": "2024-06-16 12:56:36 UTC",
+      "X-GitHub-Media-Type": "github.v3; param=luke-cage-preview; format=json",
+      "x-github-api-version-selected": "2022-11-28",
+      "X-RateLimit-Limit": "5000",
+      "X-RateLimit-Remaining": "4966",
+      "X-RateLimit-Reset": "1718293429",
+      "X-RateLimit-Used": "34",
+      "X-RateLimit-Resource": "core",
+      "Access-Control-Expose-Headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset",
+      "Access-Control-Allow-Origin": "*",
+      "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
+      "X-Frame-Options": "deny",
+      "X-Content-Type-Options": "nosniff",
+      "X-XSS-Protection": "0",
+      "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
+      "Content-Security-Policy": "default-src 'none'",
+      "X-GitHub-Request-Id": "C8E4:2DA98F:90511D4:9134847:666B0651"
+    }
+  },
+  "uuid": "9f6f5be6-b5c5-4840-865c-ba84ad262118",
+  "persistent": true,
+  "insertionIndex": 6
+}