#168 RtExec, inspect() method and unit test

amihaiemil · Apr 16, 2020 · dbe3fed · dbe3fed
1 parent 941d6ea
commit dbe3fed
Show file tree

Hide file tree

Showing 6 changed files with 190 additions and 3 deletions.
diff --git a/src/main/java/com/amihaiemil/docker/Exec.java b/src/main/java/com/amihaiemil/docker/Exec.java
@@ -25,11 +25,25 @@
  */
 package com.amihaiemil.docker;
 
+import javax.json.JsonObject;
+import java.io.IOException;
+
 /**
  * Exec containing the commands to be run within a Container.
  * @author Mihai Andronache (amihaiemil@gmail.com)
  * @version $Id$
  * @since 0.0.1
  */
 public interface Exec {
+
+    /**
+     * Return JSON information about this Ezec.
+     * @return JsonObject information.
+     * @see <a href="https://docs.docker.com/engine/api/v1.40/#operation/ExecInspect">Inspect Exec</a>
+     * @throws IOException If something goes wrong.
+     * @throws UnexpectedResponseException If the status response is not
+     *  the expected one (200 OK).
+     */
+    JsonObject inspect() throws IOException, UnexpectedResponseException;
+
 }
diff --git a/src/main/java/com/amihaiemil/docker/Inspection.java b/src/main/java/com/amihaiemil/docker/Inspection.java
@@ -32,7 +32,7 @@
 import org.apache.http.client.methods.HttpGet;
 
 /**
- * An inpsection upon any of the Docker resources.
+ * An inspection upon any of the Docker resources.
  * @author George Aristy (george.aristy@gmail.com)
  * @version $Id$
  * @since 0.0.1

diff --git a/src/main/java/com/amihaiemil/docker/RtDocker.java b/src/main/java/com/amihaiemil/docker/RtDocker.java
@@ -124,6 +124,7 @@ public final Volumes volumes() {
     @Override
     public final Execs execs() {
         return new RtExecs(
+            this.client,
             URI.create(this.baseUri.toString() + "/exec"),
             this
         );

diff --git a/src/main/java/com/amihaiemil/docker/RtExec.java b/src/main/java/com/amihaiemil/docker/RtExec.java
@@ -0,0 +1,75 @@
+/**
+ * Copyright (c) 2018-2020, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of docker-java-api nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.amihaiemil.docker;
+
+import org.apache.http.client.HttpClient;
+
+import javax.json.JsonObject;
+import java.io.IOException;
+import java.net.URI;
+
+/**
+ * Exec. A batch of commands that are running inside a Container.
+ * @author Mihai Andronache (amihaiemil@gmail.com)
+ * @version $Id$
+ * @since 0.0.12
+ */
+final class RtExec implements Exec {
+    /**
+     * Apache HttpClient which sends the requests.
+     */
+    private final HttpClient client;
+
+    /**
+     * Base URI for Images API.
+     */
+    private final URI baseUri;
+
+    /**
+     * Docker API.
+     */
+    private final Docker docker;
+
+    /**
+     * Ctor.
+     * @param client HTTP Client used to send the requests.
+     * @param uri The URI for this Images API.
+     * @param dkr The docker entry point.
+     * @checkstyle ParameterNumber (10 lines)
+     */
+    RtExec(final HttpClient client, final URI uri, final Docker dkr) {
+        this.client = client;
+        this.baseUri = uri;
+        this.docker = dkr;
+    }
+
+    @Override
+    public JsonObject inspect()
+        throws IOException, UnexpectedResponseException {
+        return new Inspection(this.client, this.baseUri.toString() + "/json");
+    }
+
+}
diff --git a/src/main/java/com/amihaiemil/docker/RtExecs.java b/src/main/java/com/amihaiemil/docker/RtExecs.java
@@ -25,6 +25,8 @@
  */
 package com.amihaiemil.docker;
 
+import org.apache.http.client.HttpClient;
+
 import java.net.URI;
 
 /**
@@ -34,6 +36,10 @@
  * @since 0.0.12
  */
 final class RtExecs implements Execs {
+    /**
+     * Apache HttpClient which sends the requests.
+     */
+    private final HttpClient client;
 
     /**
      * Base URI for Images API.
@@ -47,18 +53,24 @@ final class RtExecs implements Execs {
 
     /**
      * Ctor.
+     * @param client HTTP Client used to send the requests.
      * @param uri The URI for this Images API.
      * @param dkr The docker entry point.
      * @checkstyle ParameterNumber (10 lines)
      */
-    RtExecs(final URI uri, final Docker dkr) {
+    RtExecs(final HttpClient client, final URI uri, final Docker dkr) {
+        this.client = client;
         this.baseUri = uri;
         this.docker = dkr;
     }
 
     @Override
     public Exec get(final String execId) {
-        return null;
+        return new RtExec(
+            this.client,
+            URI.create(this.baseUri.toString() + "/" + execId),
+            this.docker
+        );
     }
 
     @Override

diff --git a/src/test/java/com/amihaiemil/docker/RtExecsTestCase.java b/src/test/java/com/amihaiemil/docker/RtExecsTestCase.java
@@ -0,0 +1,85 @@
+/**
+ * Copyright (c) 2018-2020, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of docker-java-api nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.amihaiemil.docker;
+
+import com.amihaiemil.docker.mock.AssertRequest;
+import com.amihaiemil.docker.mock.Condition;
+import com.amihaiemil.docker.mock.Response;
+import org.apache.http.HttpStatus;
+import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
+import org.junit.Test;
+import org.mockito.Mockito;
+
+import javax.json.Json;
+import java.net.URI;
+
+/**
+ * Unit tests for {@link RtExecs}.
+ * @author Mihai Andronache (amihaiemil@gmail.com)
+ * @version $Id$
+ * @since 0.0.12
+ */
+public final class RtExecsTestCase {
+
+    /**
+     * An Exec can return its JSON inspection.
+     * @throws Exception If something goes wrong.
+     */
+    @Test
+    public void execReturnsItsInspection() throws Exception {
+        final Execs all = new RtExecs(
+            new AssertRequest(
+                new Response(
+                    HttpStatus.SC_OK,
+                    "{\"Id\": \"exec123\"}"
+                ),
+                new Condition(
+                    "inspect() must send a GET request",
+                    req -> "GET".equals(req.getRequestLine().getMethod())
+                ),
+                new Condition(
+                    "inspect() resource URL should end with '/exec123/json'",
+                    req -> req.getRequestLine()
+                            .getUri().endsWith("/exec123/json")
+                )
+            ),
+            URI.create("http://localhost/exec"),
+            Mockito.mock(Docker.class)
+        );
+        final Exec exec = all.get("exec123");
+        MatcherAssert.assertThat(exec, Matchers.notNullValue());
+        MatcherAssert.assertThat(
+            exec.inspect(),
+            Matchers.equalTo(
+                Json.createObjectBuilder()
+                    .add("Id", "exec123")
+                    .build()
+            )
+        );
+    }
+
+}