Add functionality to list branches of repository (spotify#20)

Lirick · marthast · web-flow · commit 26f84d3fe718 · 2020-06-08T16:05:16.000+02:00
Co-authored-by: marthast &lt;marthast@spotify.com&gt;
diff --git a/src/main/java/com/spotify/github/v3/clients/GitHubClient.java b/src/main/java/com/spotify/github/v3/clients/GitHubClient.java
@@ -31,6 +31,7 @@
 import com.spotify.github.v3.exceptions.ReadOnlyRepositoryException;
 import com.spotify.github.v3.exceptions.RequestNotOkException;
 import com.spotify.github.v3.prs.PullRequestItem;
+import com.spotify.github.v3.repos.Branch;
 import com.spotify.github.v3.repos.CommitItem;
 import com.spotify.github.v3.repos.FolderContent;
 import com.spotify.github.v3.repos.Status;
@@ -77,6 +78,8 @@ public class GitHubClient {
       new TypeReference<>() {};
   static final TypeReference<List<PullRequestItem>> LIST_PR_TYPE_REFERENCE =
       new TypeReference<>() {};
+  static final TypeReference<List<Branch>> LIST_BRANCHES =
+      new TypeReference<>() {};
 
   private static final String GET_ACCESS_TOKEN_URL = "app/installations/%s/access_tokens";
 
diff --git a/src/main/java/com/spotify/github/v3/clients/RepositoryClient.java b/src/main/java/com/spotify/github/v3/clients/RepositoryClient.java
@@ -24,6 +24,7 @@
 import static com.spotify.github.v3.clients.GitHubClient.LIST_COMMIT_TYPE_REFERENCE;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_FOLDERCONTENT_TYPE_REFERENCE;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_STATUS_TYPE_REFERENCE;
+import static com.spotify.github.v3.clients.GitHubClient.LIST_BRANCHES;
 
 import com.google.common.collect.ImmutableMap;
 import com.spotify.github.async.AsyncPage;
@@ -69,6 +70,7 @@ public class RepositoryClient {
   private static final String TREE_SHA_URI_TEMPLATE = "/repos/%s/%s/git/trees/%s";
   private static final String COMPARE_COMMIT_TEMPLATE = "/repos/%s/%s/compare/%s...%s";
   private static final String BRANCH_TEMPLATE = "/repos/%s/%s/branches/%s";
+  private static final String LIST_BRANCHES_TEMPLATE = "/repos/%s/%s/branches";
   private static final String CREATE_COMMENT_TEMPLATE = "/repos/%s/%s/commits/%s/comments";
   private static final String COMMENT_TEMPLATE = "/repos/%s/%s/comments/%s";
   private static final String LANGUAGES_TEMPLATE = "/repos/%s/%s/languages";
@@ -342,6 +344,16 @@ public CompletableFuture<Branch> getBranch(final String branch) {
     return github.request(path, Branch.class);
   }
 
+  /**
+   * Get a specific branch.
+   *
+   * @return list of all branches in repository
+   */
+  public CompletableFuture<List<Branch>> listBranches() {
+    final String path = String.format(LIST_BRANCHES_TEMPLATE, owner, repo);
+    return github.request(path, LIST_BRANCHES);
+  }
+
   /**
    * Delete a comment for a given id.
    *
diff --git a/src/test/java/com/spotify/github/v3/clients/RepositoryClientTest.java b/src/test/java/com/spotify/github/v3/clients/RepositoryClientTest.java
@@ -24,6 +24,7 @@
 import static com.spotify.github.FixtureHelper.loadFixture;
 import static com.spotify.github.v3.UserTest.assertUser;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_COMMIT_TYPE_REFERENCE;
+import static com.spotify.github.v3.clients.GitHubClient.LIST_BRANCHES;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_FOLDERCONTENT_TYPE_REFERENCE;
 import static com.spotify.github.v3.clients.MockHelper.createMockResponse;
 import static com.spotify.github.v3.clients.RepositoryClient.STATUS_URI_TEMPLATE;
@@ -198,6 +199,18 @@ public void getBranch() throws Exception {
     assertThat(branch.commit().sha(), is("6dcb09b5b57875f334f61aebed695e2e4193db5e"));
   }
 
+  @Test
+  public void listBranches() throws Exception {
+    final CompletableFuture<List<Branch>> fixture =
+        completedFuture(json.fromJson(getFixture("list_branches.json"), LIST_BRANCHES));
+    when(github.request("/repos/someowner/somerepo/branches", LIST_BRANCHES))
+        .thenReturn(fixture);
+    final List<Branch> branches = repoClient.listBranches().get();
+    assertThat(branches.get(0).commit().sha(), is("c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"));
+    assertThat(branches.size(), is(1));
+  }
+
+
   @Test
   public void testCommentCreated() throws IOException {
     final String expectedRequestBody = json.toJsonUnchecked(ImmutableMap.of("body", "Me too"));
diff --git a/src/test/resources/com/spotify/github/v3/repos/list_branches.json b/src/test/resources/com/spotify/github/v3/repos/list_branches.json
@@ -0,0 +1,21 @@
+[
+    {
+      "name": "master",
+      "commit": {
+        "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+        "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+      },
+      "protected": true,
+      "protection": {
+        "enabled": true,
+        "required_status_checks": {
+          "enforcement_level": "non_admins",
+          "contexts": [
+            "ci-test",
+            "linter"
+          ]
+        }
+      },
+      "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection"
+    }
+  ]
