Add support for reference query param in List Images (docker-java#1941)

eddumelendez · web-flow · commit 3951333e3593 · 2022-10-06T09:33:38.000-05:00
`filter` query param was removed in Docker API 1.41. Using `reference` query param will allow to use format <image-name>[:<tag>]. Also, `withFilter(String name, Collection<String> value)` is provided. Fixes docker-java#1935
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/command/ListImagesCmd.java b/docker-java-api/src/main/java/com/github/dockerjava/api/command/ListImagesCmd.java
@@ -1,5 +1,6 @@
 package com.github.dockerjava.api.command;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 
@@ -44,6 +45,15 @@ public interface ListImagesCmd extends SyncDockerCmd<List<Image>> {
      */
     ListImagesCmd withLabelFilter(Map<String, String> labels);
 
+    /**
+     * Filter images by reference
+     *
+     * @param reference string in the form {@code <image-name>[:<tag>]}
+     */
+    ListImagesCmd withReferenceFilter(String reference);
+
+    ListImagesCmd withFilter(String key, Collection<String> values);
+
     interface Exec extends DockerCmdSyncExec<ListImagesCmd, List<Image>> {
     }
 
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/ListImagesCmdImpl.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/ListImagesCmdImpl.java
@@ -2,6 +2,8 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
+import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
@@ -46,7 +48,7 @@ public ListImagesCmd withShowAll(Boolean showAll) {
     @Override
     public ListImagesCmd withDanglingFilter(Boolean dangling) {
         checkNotNull(dangling, "dangling have not been specified");
-        filters.withFilter("dangling", dangling.toString());
+        withFilter("dangling", Collections.singletonList(dangling.toString()));
         return this;
     }
 
@@ -71,6 +73,21 @@ public ListImagesCmd withImageNameFilter(String imageNameFilter) {
         return this;
     }
 
+    @Override
+    public ListImagesCmd withReferenceFilter(String reference) {
+        checkNotNull(reference, "reference filter not specified");
+        withFilter("reference", Collections.singletonList(reference));
+        return this;
+    }
+
+    @Override
+    public ListImagesCmd withFilter(String key, Collection<String> values) {
+        checkNotNull(key, "key not specified");
+        checkNotNull(values, "values not specified");
+        filters.withFilter(key, values);
+        return this;
+    }
+
     @Override
     public String getImageNameFilter() {
         return this.imageNameFilter;
diff --git a/docker-java/src/test/java/com/github/dockerjava/cmd/ListImagesCmdIT.java b/docker-java/src/test/java/com/github/dockerjava/cmd/ListImagesCmdIT.java
@@ -4,17 +4,20 @@
 import com.github.dockerjava.api.exception.DockerException;
 import com.github.dockerjava.api.model.Image;
 import com.github.dockerjava.api.model.Info;
+import org.apache.commons.lang3.RandomUtils;
 import org.junit.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.Collections;
 import java.util.List;
 
 import static com.github.dockerjava.utils.TestUtils.isNotSwarm;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.emptyArray;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.greaterThan;
+import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.emptyString;
 import static org.hamcrest.Matchers.not;
@@ -54,6 +57,36 @@ public void listImagesWithDanglingFilter() throws DockerException {
         assertTrue(imageInFilteredList);
     }
 
+    @Test
+    public void listImagesWithReferenceFilter() throws DockerException {
+        String tag = "" + RandomUtils.nextInt(0, Integer.MAX_VALUE);
+
+        dockerRule.getClient().tagImageCmd("busybox:latest", "docker-java/busybox", tag).exec();
+        try {
+            List<Image> images = dockerRule.getClient().listImagesCmd().withReferenceFilter("docker-java/busybox")
+                .exec();
+            assertThat(images, hasSize(1));
+        }
+        finally {
+            dockerRule.getClient().removeImageCmd("docker-java/busybox:" + tag).exec();
+        }
+    }
+
+    @Test
+    public void listImagesWithFilter() throws DockerException {
+        String tag = "" + RandomUtils.nextInt(0, Integer.MAX_VALUE);
+
+        dockerRule.getClient().tagImageCmd("busybox:latest", "docker-java/busybox", tag).exec();
+        try {
+            List<Image> images = dockerRule.getClient().listImagesCmd().withFilter("reference", Collections.singletonList("docker-java/busybox"))
+                .exec();
+            assertThat(images, hasSize(1));
+        }
+        finally {
+            dockerRule.getClient().removeImageCmd("docker-java/busybox:" + tag).exec();
+        }
+    }
+
     private boolean isImageInFilteredList(List<Image> images, String expectedImageId) {
         for (Image image : images) {
             if (expectedImageId.equals(image.getId())) {
