(#154) Filters for ListedImages

src/main/java/com/amihaiemil/docker/ListedImages.java

@@ -28,7 +28,12 @@
 import org.apache.http.client.HttpClient;
 import org.apache.http.client.methods.HttpGet;
 import java.net.URI;
+import java.util.Collections;
 import java.util.Iterator;
+import java.util.Map;
+import javax.json.Json;
+import javax.json.JsonArrayBuilder;
+import javax.json.JsonObjectBuilder;
 
 /**
  * Listed images, which may have a filter applied.
@@ -41,23 +46,57 @@
  *  filters and one without filters.
  */
 final class ListedImages extends RtImages {
+    /**
+     * Image filters.
+     */
+    private final Map<String, Iterable<String>> filters;
 
     /**
      * Ctor.
      * @param client The http client.
      * @param uri The URI for this Images API.
      * @param dkr The docker entry point.
-     * @checkstyle ParameterNumber (10 lines)
+     * @checkstyle ParameterNumber (2 lines)
      */
     ListedImages(final HttpClient client, final URI uri, final Docker dkr) {
+        this(client, uri, dkr, Collections.emptyMap());
+    }
+
+    /**
+     * Ctor.
+     * @param client The http client.
+     * @param uri The URI for this Images API.
+     * @param dkr The docker entry point.
+     * @param filters Image filter
+     * @checkstyle ParameterNumber (2 lines)
+     */
+    ListedImages(
+        final HttpClient client, final URI uri,
+        final Docker dkr, final Map<String, Iterable<String>> filters
+    ) {
         super(client, uri, dkr);
+        this.filters = filters;
     }
 
     @Override
     public Iterator<Image> iterator() {
+        final UncheckedUriBuilder uri = new UncheckedUriBuilder(
+            super.baseUri().toString().concat("/json")
+        );
+        if (!this.filters.isEmpty()) {
+            final JsonObjectBuilder json = Json.createObjectBuilder();
+            this.filters.forEach(
+                (name, values) -> {
+                    final JsonArrayBuilder array = Json.createArrayBuilder();
+                    values.forEach(array::add);
+                    json.add(name, array);
+                }
+            );
+            uri.addParameter("filters", json.build().toString());
+        }
         return new ResourcesIterator<>(
             super.client(),
-            new HttpGet(super.baseUri().toString().concat("/json")),
+            new HttpGet(uri.build()),
             img -> new RtImage(
                 img,
                 super.client(),

src/test/java/com/amihaiemil/docker/ListedImagesTestCase.java

@@ -34,7 +34,12 @@
 import org.junit.Test;
 import org.mockito.Mockito;
 import java.net.URI;
+import java.util.Arrays;
+import java.util.HashMap;
 import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import org.apache.http.NameValuePair;
 
 /**
  * Unit tests for {@link ListedImages}.
@@ -82,4 +87,45 @@ public void iterateAll() {
 
     }
 
+    /**
+     * {@link ListedImages} can include filters in request to fetch images.
+     */
+    @Test
+    public void includeFiltersInRequest() {
+        final Map<String, Iterable<String>> filters = new HashMap<>();
+        filters.put(
+            "label",
+            Arrays.asList(
+                "maintainer=john@doe.org",
+                "randomLabel=test"
+            )
+        );
+        new ListedImages(
+            new AssertRequest(
+                new Response(
+                    HttpStatus.SC_OK,
+                    "[{\"Id\": \"abc1\"}, {\"Id\":\"cde2\"}]"
+                ),
+                new Condition(
+                    // @checkstyle LineLength (11 lines)
+                    "iterate() query parameters must include the filters provided",
+                    req -> {
+                        final List<NameValuePair> params = new UncheckedUriBuilder(
+                            req.getRequestLine().getUri()
+                        ).getQueryParams();
+                        // @checkstyle BooleanExpressionComplexity (5 lines)
+                        return params.size() == 1
+                            && "filters".equals(params.get(0).getName())
+                            && params.get(0).getValue().contains("label")
+                            && params.get(0).getValue().contains("\"maintainer=john@doe.org\"")
+                            && params.get(0).getValue().contains("\"randomLabel=test\"");
+                    }
+                )
+            ),
+            URI.create("http://localhost/images"),
+            Mockito.mock(Docker.class),
+            filters
+        ).iterator();
+    }
+
 }