Add mapping annotations to custom constructor (docker-java#1047)

Felix Mai · KostyaSha · commit 70d9cab71f54 · 2018-07-02T19:41:02.000+03:00
* Add mapping annotations to custom constructor * Annotate Volume's custom constructor * Add simple test and appropriate data * Fix docker-java#1046 * Add annotated factory method for inconsistent JSON * Enable to handle both JSON responses (w/ and w/o path key) * Add additional test case and data * Rename test data file due to alternative version * Add JavaDocs describing why we need both single-argument constructor and factory method * Fix docker-java#1046
diff --git a/src/main/java/com/github/dockerjava/api/model/Volume.java b/src/main/java/com/github/dockerjava/api/model/Volume.java
@@ -1,20 +1,46 @@
 package com.github.dockerjava.api.model;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 
+import javax.annotation.Nonnull;
 import java.io.Serializable;
 
 /**
  * Represents a bind mounted volume in a Docker container.
+ * <p>
+ * Due to an inconsistency in the Docker REST API implementation the response to a container
+ * command might include either {@code "Mounts" : [ { "Destination" : "/path/to/mount" } ]} or
+ * {@code "Mounts" : [ { "Destination" : { "path" : "/path/to/mount" } } ]} JSON snippets. However,
+ * both variants have to be mapped to this class. Therefore, both a single-argument constructor
+ * as well as a single-argument factory method is provided either of which handles the former or
+ * latter variant (with {@code path} key), respectively.
  *
  * @see Bind
  */
 public class Volume implements Serializable {
     private static final long serialVersionUID = 1L;
 
+    /**
+     * Handles the {@code { "Destination" : { "path" : "/path/to/mount" } }} variant.
+     * @param path the destination path of the bind mounted volume
+     * @return a volume instance referring to the given path.
+     */
+    @Nonnull
+    @JsonCreator
+    public static Volume parse(@JsonProperty("path") String path) {
+        return new Volume(path);
+    }
+
     private String path;
 
+    /**
+     * Creates a volume referring to the given path.
+     * Handles the {@code { "Destination" : "/path/to/mount" }} variant.
+     * @param path the destination path of the bind mounted volume
+     */
     public Volume(String path) {
         this.path = path;
     }
diff --git a/src/test/java/com/github/dockerjava/api/command/CommandJSONSamples.java b/src/test/java/com/github/dockerjava/api/command/CommandJSONSamples.java
@@ -24,7 +24,11 @@
  */
 public enum CommandJSONSamples implements JSONResourceRef {
 
-    inspectContainerResponse_full, inspectContainerResponse_full_1_21, inspectContainerResponse_empty;
+    inspectContainerResponse_full,
+    inspectContainerResponse_full_1_21,
+    inspectContainerResponse_full_1_26a,
+    inspectContainerResponse_full_1_26b,
+    inspectContainerResponse_empty;
 
     @Override
     public String getFileName() {
diff --git a/src/test/java/com/github/dockerjava/api/command/InspectContainerResponseTest.java b/src/test/java/com/github/dockerjava/api/command/InspectContainerResponseTest.java
@@ -17,10 +17,12 @@
 
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.github.dockerjava.api.model.Volume;
 import com.github.dockerjava.core.RemoteApiVersion;
 import org.junit.Test;
 
 import java.io.IOException;
+import java.util.List;
 
 import static com.github.dockerjava.test.serdes.JSONSamples.testRoundTrip;
 import static com.github.dockerjava.test.serdes.JSONTestHelper.testRoundTrip;
@@ -93,6 +95,38 @@ public void roundTrip_1_21_full() throws IOException {
         assertThat(state.getError(), isEmptyString());
     }
 
+    @Test
+    public void roundTrip_1_26a_full() throws IOException {
+        InspectContainerResponse[] responses = testRoundTrip(CommandJSONSamples.inspectContainerResponse_full_1_26a,
+                InspectContainerResponse[].class);
+
+        assertEquals(1, responses.length);
+        final InspectContainerResponse response = responses[0];
+
+        final List<InspectContainerResponse.Mount> mounts = response.getMounts();
+        assertEquals(mounts.size(), 1);
+
+        final InspectContainerResponse.Mount mount = mounts.get(0);
+        final Volume volume = mount.getDestination();
+        assertEquals(volume.getPath(), "/var/lib/postgresql/data");
+    }
+
+    @Test
+    public void roundTrip_1_26b_full() throws IOException {
+        InspectContainerResponse[] responses = testRoundTrip(CommandJSONSamples.inspectContainerResponse_full_1_26b,
+                InspectContainerResponse[].class);
+
+        assertEquals(1, responses.length);
+        final InspectContainerResponse response = responses[0];
+
+        final List<InspectContainerResponse.Mount> mounts = response.getMounts();
+        assertEquals(mounts.size(), 1);
+
+        final InspectContainerResponse.Mount mount = mounts.get(0);
+        final Volume volume = mount.getDestination();
+        assertEquals(volume.getPath(), "/srv/test");
+    }
+
     @Test
     public void roundTrip_empty() throws IOException {
         testRoundTrip(CommandJSONSamples.inspectContainerResponse_empty, InspectContainerResponse[].class);
diff --git a/src/test/resources/com/github/dockerjava/api/command/inspectContainerResponse_full_1_26a.json b/src/test/resources/com/github/dockerjava/api/command/inspectContainerResponse_full_1_26a.json
@@ -0,0 +1,155 @@
+[
+  {
+    "Driver" : "aufs",
+    "Path" : "docker-entrypoint.sh",
+    "Args" : [
+      "postgres"
+    ],
+    "SizeRootFs" : null,
+    "HostConfig" : {
+      "KernelMemory" : 0,
+      "MemorySwappiness" : -1,
+      "PidMode" : "",
+      "CpuPeriod" : 0,
+      "LogConfig" : {
+        "Type" : "json-file",
+        "Config" : {}
+      },
+      "ReadonlyRootfs" : false,
+      "CgroupParent" : "",
+      "PublishAllPorts" : false,
+      "VolumeDriver" : "",
+      "NetworkMode" : "default",
+      "BlkioWeight" : 0,
+      "OomKillDisable" : false,
+      "Privileged" : false,
+      "CpusetMems" : "",
+      "ContainerIDFile" : "",
+      "ShmSize" : 67108864,
+      "CpusetCpus" : "",
+      "CpuShares" : 0,
+      "PidsLimit" : 0,
+      "RestartPolicy" : {
+        "Name" : "",
+        "MaximumRetryCount" : 0
+      },
+      "Memory" : 0,
+      "MemorySwap" : 0,
+      "CpuQuota" : 0,
+      "OomScoreAdj" : false,
+      "MemoryReservation" : 0
+    },
+    "Id" : "58fd1abe8e43a65fb6231b76a9678e7bb4e91686f838945e782a4b74119ce959",
+    "Volumes" : null,
+    "State" : {
+      "Pid" : 0,
+      "ExitCode" : 0,
+      "FinishedAt" : "0001-01-01T00:00:00Z",
+      "Paused" : false,
+      "Error" : "",
+      "Status" : "created",
+      "OOMKilled" : false,
+      "Health" : null,
+      "oomkilled" : false,
+      "StartedAt" : "0001-01-01T00:00:00Z",
+      "Dead" : false,
+      "Running" : false,
+      "Restarting" : false
+    },
+    "Config" : {
+      "OpenStdin" : false,
+      "Hostname" : "58fd1abe8e43",
+      "StdinOnce" : false,
+      "Domainname" : "",
+      "Env" : [
+        "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/postgresql/10/bin",
+        "GOSU_VERSION=1.10",
+        "LANG=en_US.utf8",
+        "PG_MAJOR=10",
+        "PG_VERSION=10.4-2.pgdg90+1",
+        "PGDATA=/var/lib/postgresql/data"
+      ],
+      "Entrypoint" : [
+        "docker-entrypoint.sh"
+      ],
+      "User" : "",
+      "AttachStdout" : false,
+      "Cmd" : [
+        "postgres"
+      ],
+      "ExposedPorts" : {
+        "5432/tcp" : {}
+      },
+      "Image" : "postgres:latest",
+      "AttachStderr" : false,
+      "Labels" : {},
+      "Volumes" : {
+        "/var/lib/postgresql/data" : {}
+      },
+      "Tty" : false,
+      "WorkingDir" : "",
+      "AttachStdin" : false
+    },
+    "ProcessLabel" : "",
+    "HostsPath" : "",
+    "Name" : "/fmi-test01",
+    "ExecDriver" : null,
+    "LogPath" : "",
+    "ExecIDs" : null,
+    "MountLabel" : "",
+    "Created" : "2018-05-30T08:37:12.308001081Z",
+    "Image" : "sha256:61d053fc271ce1313896a2edf7719fb3b68637b53397e61d8114793b39e9ae65",
+    "ResolvConfPath" : "",
+    "HostnamePath" : "",
+    "RestartCount" : 0,
+    "NetworkSettings" : {
+      "GlobalIPv6PrefixLen" : 0,
+      "LinkLocalIPv6PrefixLen" : 0,
+      "EndpointID" : "",
+      "SandboxID" : "",
+      "GlobalIPv6Address" : "",
+      "LinkLocalIPv6Address" : "",
+      "HairpinMode" : false,
+      "PortMapping" : null,
+      "SecondaryIPv6Addresses" : null,
+      "SecondaryIPAddresses" : null,
+      "Gateway" : "",
+      "Ports" : null,
+      "MacAddress" : "",
+      "Networks" : {
+        "bridge" : {
+          "IPv6Gateway" : "",
+          "IPPrefixLen" : 0,
+          "GlobalIPv6Address" : "",
+          "IPAddress" : "",
+          "EndpointID" : "",
+          "Aliases" : null,
+          "GlobalIPv6PrefixLen" : 0,
+          "Gateway" : "",
+          "NetworkID" : "",
+          "IPAMConfig" : null,
+          "Links" : null,
+          "MacAddress" : ""
+        }
+      },
+      "IPAddress" : "",
+      "Bridge" : "",
+      "IPPrefixLen" : 0,
+      "IPv6Gateway" : "",
+      "SandboxKey" : ""
+    },
+    "VolumesRW" : null,
+    "Mounts" : [
+      {
+        "RW" : true,
+        "Driver" : "local",
+        "Name" : "d9e76cbb4f797b0b8d62f5f4cd46ee6502fc520c6ce1187a62d200bc8364dd74",
+        "Source" : "/var/lib/docker/volumes/d9e76cbb4f797b0b8d62f5f4cd46ee6502fc520c6ce1187a62d200bc8364dd74/_data",
+        "Mode" : "",
+        "Destination" : {
+          "path" : "/var/lib/postgresql/data"
+        }
+      }
+    ]
+  }
+]
diff --git a/src/test/resources/com/github/dockerjava/api/command/inspectContainerResponse_full_1_26b.json b/src/test/resources/com/github/dockerjava/api/command/inspectContainerResponse_full_1_26b.json
