Merge pull request #543 from salesforce/all-blob

Read BLOB for all sub-command

Author: jeetchoudhary

dockerfile-image-update/src/main/java/com/salesforce/dockerfileimageupdate/storage/GitHubJsonStore.java

@@ -24,7 +24,6 @@
 import java.util.stream.Collectors;
 import org.kohsuke.github.GHBlob;
 import org.kohsuke.github.GHCommit;
-import org.kohsuke.github.GHContent;
 import org.kohsuke.github.GHMyself;
 import org.kohsuke.github.GHRepository;
 import org.slf4j.Logger;
@@ -137,13 +136,13 @@ protected String getAndModifyJsonString(JsonElement json, String img, String tag
     }
 
     public Set<Map.Entry<String, JsonElement>> parseStoreToImagesMap(DockerfileGitHubUtil dockerfileGitHubUtil, String storeName)
-            throws IOException, InterruptedException {
+            throws IOException {
         GHMyself myself = dockerfileGitHubUtil.getMyself();
         String login = myself.getLogin();
         GHRepository store = dockerfileGitHubUtil.getRepo(Paths.get(login, storeName).toString());
 
-        GHContent storeContent = dockerfileGitHubUtil.tryRetrievingContent(store, Constants.STORE_JSON_FILE,
-                store.getDefaultBranch());
+        GHBlob storeContent = dockerfileGitHubUtil.tryRetrievingBlob(store,
+                Constants.STORE_JSON_FILE, store.getDefaultBranch());
 
         if (storeContent == null) {
             return Collections.emptySet();
@@ -163,7 +162,8 @@ public Set<Map.Entry<String, JsonElement>> parseStoreToImagesMap(DockerfileGitHu
         return imagesJson.getAsJsonObject().entrySet();
     }
 
-    public List<ImageTagStoreContent> getStoreContent(DockerfileGitHubUtil dockerfileGitHubUtil, String storeName) throws IOException, InterruptedException {
+    public List<ImageTagStoreContent> getStoreContent(DockerfileGitHubUtil dockerfileGitHubUtil, String storeName)
+            throws IOException {
         Set<Map.Entry<String, JsonElement>> imageToTagStore = parseStoreToImagesMap(dockerfileGitHubUtil, storeName);
         return imageToTagStore.stream()
                 .map(entry -> new ImageTagStoreContent(entry.getKey(), entry.getValue().getAsString()))

dockerfile-image-update/src/main/java/com/salesforce/dockerfileimageupdate/storage/S3BackedImageTagStore.java

@@ -69,7 +69,7 @@ public List<ImageTagStoreContent> getStoreContent(DockerfileGitHubUtil dockerfil
         return imageNamesWithTag;
     }
 
-    private List<ImageTagStoreContent> getStoreContentSortedByAccessDate(Map<String, Date> imageNameWithAccessTime) throws InterruptedException {
+    private List<ImageTagStoreContent> getStoreContentSortedByAccessDate(Map<String, Date> imageNameWithAccessTime) {
         List<ImageTagStoreContent> imageNameWithTagSortedByAccessDate = new ArrayList<>();
         LinkedHashMap<String, Date> sortedResult = new LinkedHashMap<>();
         // Sort the content by the access date so that the file which was accessed most recently gets processed first

dockerfile-image-update/src/main/java/com/salesforce/dockerfileimageupdate/utils/DockerfileGitHubUtil.java

@@ -257,6 +257,11 @@ public GHContent tryRetrievingContent(GHRepository repo, String path, String bra
         return gitHubUtil.tryRetrievingContent(repo, path, branch);
     }
 
+    public GHBlob tryRetrievingBlob(GHRepository repo, String path, String branch)
+            throws IOException {
+        return gitHubUtil.tryRetrievingBlob(repo, path, branch);
+    }
+
     public void modifyOnGithub(GHContent content,
                                String branch, String img, String tag,
                                String customMessage, String ignoreImageString) throws IOException {

dockerfile-image-update/src/main/java/com/salesforce/dockerfileimageupdate/utils/GitHubUtil.java

@@ -196,6 +196,11 @@ public GHContent tryRetrievingContent(GHRepository repo, String path, String bra
         return content;
     }
 
+    public GHBlob tryRetrievingBlob(GHRepository repo, String path, String branch)
+            throws IOException {
+        return repo.getCommit(branch).getTree().getEntry(path).asBlob();
+    }
+
     /* Workaround: The GitHub API caches API calls for up to 60 seconds, so back-to-back API calls with the same
      * command will return the same thing. i.e. the above command listRepositories will return the same output if
      * this tool is invoked twice in a row, even though it should return different lists, because of the new forks.

dockerfile-image-update/src/test/java/com/salesforce/dockerfileimageupdate/utils/DockerfileGitHubUtilTest.java

@@ -406,6 +406,26 @@ public void testTryRetrievingContent() throws Exception {
         assertEquals(dockerfileGitHubUtil.tryRetrievingContent(new GHRepository(), "path", "branch"), content);
     }
 
+    @Test
+    public void testTryRetrievingBlob() throws IOException {
+        gitHubUtil = mock(GitHubUtil.class);
+        GHBlob content = mock(GHBlob.class);
+        when(gitHubUtil.tryRetrievingBlob(any(), anyString(), anyString())).thenReturn(content);
+        dockerfileGitHubUtil = new DockerfileGitHubUtil(gitHubUtil);
+        assertEquals(dockerfileGitHubUtil.tryRetrievingBlob(new GHRepository(), "path", "branch"), content);
+    }
+
+    @Test(
+            expectedExceptions = IOException.class,
+            expectedExceptionsMessageRegExp = "error while reading blob")
+    public void testTryRetrievingBlobException() throws IOException {
+        gitHubUtil = mock(GitHubUtil.class);
+        GHBlob content = mock(GHBlob.class);
+        when(gitHubUtil.tryRetrievingBlob(any(), anyString(), anyString())).thenThrow(new IOException("error while reading blob"));
+        dockerfileGitHubUtil = new DockerfileGitHubUtil(gitHubUtil);
+        assertNotEquals(dockerfileGitHubUtil.tryRetrievingBlob(new GHRepository(), "path", "branch"), content);
+    }
+
 
     @DataProvider
     public Object[][] inputBranchesImagesAndTags() {

dockerfile-image-update/src/test/java/com/salesforce/dockerfileimageupdate/utils/GitHubUtilTest.java

@@ -153,6 +153,46 @@ public void testTryRetrievingContent() throws Exception {
         verify(repo, times(1)).getFileContent(eq("path"), eq("branch"));
     }
 
+    @Test
+    public void testTryRetrievingBlobSuccess() throws Exception {
+
+        GitHub github = mock(GitHub.class);
+        GHRepository repo = mock(GHRepository.class);
+        GHCommit commit = mock(GHCommit.class);
+        GHTree ghTree = mock(GHTree.class);
+        GHTreeEntry ghTreeEntry = mock(GHTreeEntry.class);
+        GHBlob ghBlob = mock(GHBlob.class);
+        when(repo.getCommit(anyString())).thenReturn(commit);
+        when(commit.getTree()).thenReturn(ghTree);
+        when(ghTree.getEntry(anyString())).thenReturn(ghTreeEntry);
+        when(ghTreeEntry.asBlob()).thenReturn(ghBlob);
+
+        GitHubUtil gitHubUtil = new GitHubUtil(github);
+        assertEquals(gitHubUtil.tryRetrievingBlob(repo, "path", "branch"), ghBlob);
+
+        verify(commit, times(1)).getTree();
+        verify(ghTreeEntry, times(1)).asBlob();
+    }
+
+    @Test(
+            expectedExceptions = IOException.class,
+            expectedExceptionsMessageRegExp = "error while reading commit")
+    public void testTryRetrievingBlobException() throws Exception {
+
+        GitHub github = mock(GitHub.class);
+        GHRepository repo = mock(GHRepository.class);
+        GHCommit commit = mock(GHCommit.class);
+        GHTreeEntry ghTreeEntry = mock(GHTreeEntry.class);
+        GHBlob ghBlob = mock(GHBlob.class);
+        when(repo.getCommit(anyString())).thenThrow(new IOException("error while reading commit"));
+
+        GitHubUtil gitHubUtil = new GitHubUtil(github);
+        assertEquals(gitHubUtil.tryRetrievingBlob(repo, "path", "branch"), ghBlob);
+
+        verify(commit, times(0)).getTree();
+        verify(ghTreeEntry, times(0)).asBlob();
+    }
+
     /* There is a timeout because if this part of the code is broken, it might enter 60 seconds of sleep. */
     @Test(timeOut = 1000)
     public void testGetGHRepositories() throws Exception {
@@ -335,4 +375,4 @@ public void testRepoHasBranchFalseForGHFileNotFoundException() throws IOExceptio
         when(repo.getBranch(branchName)).thenThrow(new GHFileNotFoundException());
         assertFalse(gitHubUtil.repoHasBranch(repo, branchName));
     }
-}
+}