Consider already existing images as successful pull (docker-java#2335)

n-g · eddumelendez · web-flow · commit b28b0dc267bc · 2024-07-09T15:05:48.000-05:00
Co-authored-by: Edd&uacute; Mel&eacute;ndez Gonzales &lt;eddu.melendez@gmail.com&gt;
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/PullResponseItem.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/PullResponseItem.java
@@ -19,6 +19,8 @@ public class PullResponseItem extends ResponseItem {
 
     private static final String DOWNLOADED_SWARM = ": downloaded";
 
+    private static final String ALREADY_EXISTS = "Already exists";
+
     /**
      * Returns whether the status indicates a successful pull operation
      *
@@ -34,7 +36,8 @@ public boolean isPullSuccessIndicated() {
                 getStatus().contains(IMAGE_UP_TO_DATE) ||
                 getStatus().contains(DOWNLOADED_NEWER_IMAGE) ||
                 getStatus().contains(LEGACY_REGISTRY) ||
-                getStatus().contains(DOWNLOADED_SWARM)
+                getStatus().contains(DOWNLOADED_SWARM) ||
+                getStatus().contains(ALREADY_EXISTS)
         );
     }
 }
diff --git a/docker-java/src/test/java/com/github/dockerjava/api/model/PullResponseItemTest.java b/docker-java/src/test/java/com/github/dockerjava/api/model/PullResponseItemTest.java
@@ -29,6 +29,14 @@
  * @author Zach Marshall
  */
 public class PullResponseItemTest {
+    @Test
+    public void imageAlreadyExists() throws IOException {
+        PullResponseItem response = testRoundTrip(PullResponseJSONSamples.pullImageResponse_alreadyExists,
+                PullResponseItem.class);
+        assertTrue(response.isPullSuccessIndicated());
+        assertFalse(response.isErrorIndicated());
+    }
+
     @Test
     public void pullNewerImage() throws IOException {
         PullResponseItem response = testRoundTrip(PullResponseJSONSamples.pullImageResponse_newerImage,
diff --git a/docker-java/src/test/java/com/github/dockerjava/api/model/PullResponseJSONSamples.java b/docker-java/src/test/java/com/github/dockerjava/api/model/PullResponseJSONSamples.java
@@ -23,7 +23,9 @@
  * @author Zach Marshall
  */
 public enum PullResponseJSONSamples implements JSONResourceRef {
-    pullImageResponse_legacy, pullImageResponse_error, pullImageResponse_newerImage, pullImageResponse_upToDate;
+    pullImageResponse_legacy, pullImageResponse_error, 
+    pullImageResponse_newerImage, pullImageResponse_upToDate,
+    pullImageResponse_alreadyExists;
 
     @Override
     public String getFileName() {
diff --git a/docker-java/src/test/resources/com/github/dockerjava/api/model/pullImageResponse_alreadyExists.json b/docker-java/src/test/resources/com/github/dockerjava/api/model/pullImageResponse_alreadyExists.json
@@ -0,0 +1 @@
+{"status":"Already exists"}

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@ public class PullResponseItem extends ResponseItem {`
`19`	`19`
`20`	`20`	`private static final String DOWNLOADED_SWARM = ": downloaded";`
`21`	`21`
	`22`	`+ private static final String ALREADY_EXISTS = "Already exists";`
	`23`	`+`
`22`	`24`	`/**`
`23`	`25`	`* Returns whether the status indicates a successful pull operation`
`24`	`26`	`*`
`@@ -34,7 +36,8 @@ public boolean isPullSuccessIndicated() {`
`34`	`36`	`getStatus().contains(IMAGE_UP_TO_DATE) \|\|`
`35`	`37`	`getStatus().contains(DOWNLOADED_NEWER_IMAGE) \|\|`
`36`	`38`	`getStatus().contains(LEGACY_REGISTRY) \|\|`
`37`		`- getStatus().contains(DOWNLOADED_SWARM)`
	`39`	`+ getStatus().contains(DOWNLOADED_SWARM) \|\|`
	`40`	`+ getStatus().contains(ALREADY_EXISTS)`
`38`	`41`	`);`
`39`	`42`	`}`
`40`	`43`	`}`