Fixes modifyCollaborators for multiple users

Fixes #868
hub4j · Jul 27, 2020 · 9c7de76 · 9c7de76
1 parent 8ba5cf7
commit 9c7de76
Show file tree

Hide file tree

Showing 5 changed files with 146 additions and 7 deletions.
diff --git a/src/main/java/org/kohsuke/github/GHRepository.java b/src/main/java/org/kohsuke/github/GHRepository.java
@@ -46,6 +46,7 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -979,13 +980,12 @@ public void removeCollaborators(Collection<GHUser> users) throws IOException {
     private void modifyCollaborators(@NonNull Collection<GHUser> users,
             @NonNull String method,
             @CheckForNull GHOrganization.Permission permission) throws IOException {
-        Requester requester = root.createRequest().method(method);
-
-        if (permission != null) {
-            requester = requester.with("permission", permission).inBody();
-        }
-
-        for (GHUser user : users) {
+        // Make sure that the users collection doesn't have any duplicates
+        for (GHUser user : new LinkedHashSet<GHUser>(users)) {
+            Requester requester = root.createRequest().method(method);
+            if (permission != null) {
+                requester = requester.with("permission", permission).inBody();
+            }
             requester.withUrlPath(getApiTailUrl("collaborators/" + user.getLogin())).send();
         }
     }

diff --git a/src/test/java/org/kohsuke/github/GHRepositoryTest.java b/src/test/java/org/kohsuke/github/GHRepositoryTest.java
@@ -191,6 +191,7 @@ public void addCollaborators() throws Exception {
         List<GHUser> users = new ArrayList<GHUser>();
 
         users.add(user);
+        users.add(gitHub.getUser("jimmysombrero2"));
         repo.addCollaborators(users, GHOrganization.Permission.PUSH);
 
         GHPersonSet<GHUser> collabs = repo.getCollaborators();

diff --git a/...hsuke/github/GHRepositoryTest/wiremock/addCollaborators/__files/users_jimmysombrero2.json b/...hsuke/github/GHRepositoryTest/wiremock/addCollaborators/__files/users_jimmysombrero2.json
@@ -0,0 +1,45 @@
+{
+  "login": "jimmysombrero2",
+  "id": 12157727,
+  "node_id": "MDQ6VXNlcjEyMTU3NzI3",
+  "avatar_url": "https://avatars3.githubusercontent.com/u/12157727?v=4",
+  "gravatar_id": "",
+  "url": "https://api.github.com/users/jimmysombrero",
+  "html_url": "https://github.com/jimmysombrero",
+  "followers_url": "https://api.github.com/users/jimmysombrero/followers",
+  "following_url": "https://api.github.com/users/jimmysombrero/following{/other_user}",
+  "gists_url": "https://api.github.com/users/jimmysombrero/gists{/gist_id}",
+  "starred_url": "https://api.github.com/users/jimmysombrero/starred{/owner}{/repo}",
+  "subscriptions_url": "https://api.github.com/users/jimmysombrero/subscriptions",
+  "organizations_url": "https://api.github.com/users/jimmysombrero/orgs",
+  "repos_url": "https://api.github.com/users/jimmysombrero/repos",
+  "events_url": "https://api.github.com/users/jimmysombrero/events{/privacy}",
+  "received_events_url": "https://api.github.com/users/jimmysombrero/received_events",
+  "type": "User",
+  "site_admin": false,
+  "name": null,
+  "company": null,
+  "blog": "",
+  "location": null,
+  "email": null,
+  "hireable": null,
+  "bio": null,
+  "public_repos": 4,
+  "public_gists": 0,
+  "followers": 1,
+  "following": 0,
+  "created_at": "2015-04-28T17:47:19Z",
+  "updated_at": "2020-02-02T04:43:58Z",
+  "private_gists": 0,
+  "total_private_repos": 0,
+  "owned_private_repos": 0,
+  "disk_usage": 19,
+  "collaborators": 0,
+  "two_factor_authentication": false,
+  "plan": {
+    "name": "free",
+    "space": 976562499,
+    "collaborators": 0,
+    "private_repos": 10000
+  }
+}
diff --git a/...dCollaborators/mappings/repos_hub4j-test-org_github-api_collaborators_jimmysombrero2.json b/...dCollaborators/mappings/repos_hub4j-test-org_github-api_collaborators_jimmysombrero2.json
@@ -0,0 +1,48 @@
+{
+  "id": "3d80b19e-05f4-4ad9-a610-5f573abc4363",
+  "name": "repos_hub4j-test-org_github-api_collaborators_jimmysombrero2",
+  "request": {
+    "url": "/repos/hub4j-test-org/github-api/collaborators/jimmysombrero2",
+    "method": "PUT",
+    "headers": {
+      "Accept": {
+        "equalTo": "text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2"
+      }
+    },
+    "bodyPatterns": [
+      {
+        "equalToJson": "{\"permission\":\"push\"}",
+        "ignoreArrayOrder": true,
+        "ignoreExtraElements": true
+      }
+    ]
+  },
+  "response": {
+    "status": 201,
+    "body": "[]",
+    "headers": {
+      "Server": "GitHub.com",
+      "Date": "Sun, 02 Feb 2020 04:59:39 GMT",
+      "Content-Type": "application/json; charset=utf-8",
+      "Status": "201 Created",
+      "X-RateLimit-Limit": "5000",
+      "X-RateLimit-Remaining": "4892",
+      "X-RateLimit-Reset": "1580620983",
+      "X-OAuth-Scopes": "admin:enterprise, admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete:packages, delete_repo, gist, notifications, read:packages, repo, user, workflow, write:discussion, write:packages",
+      "X-Accepted-OAuth-Scopes": "",
+      "X-GitHub-Media-Type": "unknown, github.v3",
+      "Access-Control-Expose-Headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type",
+      "Access-Control-Allow-Origin": "*",
+      "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
+      "X-Frame-Options": "deny",
+      "X-Content-Type-Options": "nosniff",
+      "X-XSS-Protection": "1; mode=block",
+      "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
+      "Content-Security-Policy": "default-src 'none'",
+      "X-GitHub-Request-Id": "C903:768E:16C4966:2BA11B0:5E36573B"
+    }
+  },
+  "uuid": "3d80b19e-05f4-4ad9-a610-5f573abc4363",
+  "persistent": true,
+  "insertionIndex": 4
+}
diff --git a/...ke/github/GHRepositoryTest/wiremock/addCollaborators/mappings/users_jimmysombrero2-7.json b/...ke/github/GHRepositoryTest/wiremock/addCollaborators/mappings/users_jimmysombrero2-7.json
@@ -0,0 +1,45 @@
+{
+  "id": "6685376c-451b-486d-88cd-502af9a7c5d2",
+  "name": "users_jimmysombrero2",
+  "request": {
+    "url": "/users/jimmysombrero2",
+    "method": "GET",
+    "headers": {
+      "Accept": {
+        "equalTo": "text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2"
+      }
+    }
+  },
+  "response": {
+    "status": 200,
+    "bodyFileName": "users_jimmysombrero2.json",
+    "headers": {
+      "Server": "GitHub.com",
+      "Date": "Mon, 03 Feb 2020 03:50:14 GMT",
+      "Content-Type": "application/json; charset=utf-8",
+      "Status": "200 OK",
+      "X-RateLimit-Limit": "5000",
+      "X-RateLimit-Remaining": "4907",
+      "X-RateLimit-Reset": "1580704799",
+      "Cache-Control": "private, max-age=60, s-maxage=60",
+      "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP",
+      "ETag": "W/\"7a0206b47e995649c88218afeb2266a6\"",
+      "Last-Modified": "Sun, 02 Feb 2020 04:43:58 GMT",
+      "X-OAuth-Scopes": "admin:enterprise, admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete:packages, delete_repo, gist, notifications, read:packages, repo, user, workflow, write:discussion, write:packages",
+      "X-Accepted-OAuth-Scopes": "",
+      "X-GitHub-Media-Type": "unknown, github.v3",
+      "Access-Control-Expose-Headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type",
+      "Access-Control-Allow-Origin": "*",
+      "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
+      "X-Frame-Options": "deny",
+      "X-Content-Type-Options": "nosniff",
+      "X-XSS-Protection": "1; mode=block",
+      "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
+      "Content-Security-Policy": "default-src 'none'",
+      "X-GitHub-Request-Id": "CDFE:768D:1021273:26DC788:5E379876"
+    }
+  },
+  "uuid": "6685376c-451b-486d-88cd-502af9a7c5d1",
+  "persistent": true,
+  "insertionIndex": 6
+}