fix(docker-java#806): filter config.json before unmarshalling

David Leischnig · KostyaSha · commit 23d7e80bc1bd · 2017-06-29T11:16:27.000+03:00
As ObjectMapper expects all propeties of json content to match AuthConfig it fails on any other
like "credStore" or "HttpHeaders". As only "auths" is used the json is mapped to ObjectNode so
we can remove any other property. The content of this filtered node can be used as source for
unmarshalling AuthConfig.
diff --git a/src/main/java/com/github/dockerjava/core/AuthConfigFile.java b/src/main/java/com/github/dockerjava/core/AuthConfigFile.java
@@ -13,6 +13,7 @@
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.github.dockerjava.api.model.AuthConfig;
 import com.github.dockerjava.api.model.AuthConfigurations;
 
@@ -26,11 +27,12 @@ public class AuthConfigFile {
     private static final TypeReference<Map<String, Map<String, AuthConfig>>> CONFIG_JSON_MAP_TYPE =
         new TypeReference<Map<String, Map<String, AuthConfig>>>() {
         };
+    private static final String AUTHS_PROPERTY = "auths";
 
     private final Map<String, AuthConfig> authConfigMap;
 
     public AuthConfigFile() {
-        authConfigMap = new HashMap<String, AuthConfig>();
+        authConfigMap = new HashMap<>();
     }
 
     void addConfig(AuthConfig config) {
@@ -114,10 +116,12 @@ public static AuthConfigFile loadConfig(File confFile) throws IOException {
          */
         try {
             // try registry version 2
-            Map<String, Map<String, AuthConfig>>  configJson = MAPPER.readValue(confFile, CONFIG_JSON_MAP_TYPE);
-            if (configJson != null) {
-                configMap = configJson.get("auths");
+            final ObjectNode node = filterNonAuthsFromJSON(confFile);
+            Map<String, Map<String, AuthConfig>>  configJson = MAPPER.convertValue(node, CONFIG_JSON_MAP_TYPE);
+            if (configJson != null && !configJson.isEmpty()) {
+                configMap = configJson.get(AUTHS_PROPERTY);
             }
+
         } catch (IOException e1) {
             try {
                 // try registry version 1
@@ -130,7 +134,10 @@ public static AuthConfigFile loadConfig(File confFile) throws IOException {
         if (configMap != null) {
             for (Map.Entry<String, AuthConfig> entry : configMap.entrySet()) {
                 AuthConfig authConfig = entry.getValue();
-                decodeAuth(authConfig.getAuth(), authConfig);
+                final String auth = authConfig.getAuth();
+                if (auth == null) continue;
+
+                decodeAuth(auth, authConfig);
                 authConfig.withAuth(null);
                 authConfig.withRegistryAddress(entry.getKey());
                 configFile.addConfig(authConfig);
@@ -158,6 +165,15 @@ public static AuthConfigFile loadConfig(File confFile) throws IOException {
 
     }
 
+    private static ObjectNode filterNonAuthsFromJSON(final File confFile) throws IOException {
+        final ObjectNode node = MAPPER.readValue(confFile, ObjectNode.class);
+        if (!node.has(AUTHS_PROPERTY)) {
+            throw new IOException("No Auth Config contained");
+        }
+        node.retain(AUTHS_PROPERTY);
+        return node;
+    }
+
     static void decodeAuth(String auth, AuthConfig config) throws IOException {
         String str = new String(Base64.decodeBase64(auth), Charset.forName("UTF-8"));
         String[] parts = str.split(":", 2);
diff --git a/src/test/java/com/github/dockerjava/core/AuthConfigFileTest.java b/src/test/java/com/github/dockerjava/core/AuthConfigFileTest.java
@@ -64,10 +64,23 @@ public void validJson() throws IOException {
         expected.addConfig(authConfig1);
         expected.addConfig(authConfig2);
 
-        Assert.assertEquals(runTest("validJson"), expected);
+        Assert.assertEquals(runTest("validJson.json"), expected);
 
     }
 
+    @Test
+    public void validJsonWithUnknown() throws IOException {
+        AuthConfig authConfig1 = new AuthConfig()
+                .withEmail("foo@example.com")
+                .withUsername("foo")
+                .withPassword("bar")
+                .withRegistryAddress("quay.io");
+
+        AuthConfigFile expected = new AuthConfigFile();
+        expected.addConfig(authConfig1);
+        runTest("validJsonWithUnknown.json");
+    }
+
     @Test
     public void validLegacy() throws IOException {
         AuthConfig authConfig = new AuthConfig()
diff --git a/src/test/java/com/github/dockerjava/core/command/ListContainersCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/ListContainersCmdImplTest.java
@@ -57,9 +57,6 @@ public void testListContainers() throws Exception {
 
         String testImage = "busybox";
 
-        // need to block until image is pulled completely
-        dockerClient.pullImageCmd(testImage).exec(new PullImageResultCallback()).awaitSuccess();
-
         List<Container> containers = dockerClient.listContainersCmd().withShowAll(true).exec();
         assertThat(containers, notNullValue());
         LOG.info("Container List: {}", containers);
diff --git a/src/test/java/com/github/dockerjava/netty/exec/ListContainersCmdExecTest.java b/src/test/java/com/github/dockerjava/netty/exec/ListContainersCmdExecTest.java
@@ -59,9 +59,6 @@ public void testListContainers() throws Exception {
 
         String testImage = "busybox";
 
-        // // need to block until image is pulled completely
-        // dockerClient.pullImageCmd(testImage).exec(new PullImageResultCallback()).awaitSuccess();
-
         List<Container> containers = dockerClient.listContainersCmd().withShowAll(true).exec();
         assertThat(containers, notNullValue());
         LOG.info("Container List: {}", containers);
@@ -107,9 +104,6 @@ public void testListContainersWithLabelsFilter() throws Exception {
 
         String testImage = "busybox";
 
-        // need to block until image is pulled completely
-        dockerClient.pullImageCmd(testImage).exec(new PullImageResultCallback()).awaitCompletion();
-
         List<Container> containers = dockerClient.listContainersCmd().withShowAll(true).exec();
         assertThat(containers, notNullValue());
         LOG.info("Container List: {}", containers);
@@ -152,16 +146,25 @@ public void testListContainersWithLabelsFilter() throws Exception {
         Map<String, String> labels = ImmutableMap.of("test", "docker-java");
 
         // list with filter by label
-        dockerClient.createContainerCmd(testImage).withCmd("echo").withLabels(labels).exec();
-        filteredContainers = dockerClient.listContainersCmd().withShowAll(true)
-                .withLabelFilter(labels).exec();
+        dockerClient.createContainerCmd(testImage)
+                .withCmd("echo")
+                .withLabels(labels)
+                .exec();
+
+        filteredContainers = dockerClient.listContainersCmd()
+                .withShowAll(true)
+                .withLabelFilter(labels)
+                .exec();
+
         assertThat(filteredContainers.size(), is(equalTo(1)));
         Container container3 = filteredContainers.get(0);
         assertThat(container3.getCommand(), not(isEmptyString()));
         assertThat(container3.getImage(), startsWith(testImage));
 
         filteredContainers = dockerClient.listContainersCmd().withShowAll(true)
-                .withLabelFilter("test").exec();
+                .withLabelFilter("test")
+                .exec();
+
         assertThat(filteredContainers.size(), is(equalTo(1)));
         container3 = filteredContainers.get(0);
         assertThat(container3.getCommand(), not(isEmptyString()));
diff --git a/src/test/resources/testAuthConfigFile/validJson b/src/test/resources/testAuthConfigFile/validJson
diff --git a/src/test/resources/testAuthConfigFile/validJson.json b/src/test/resources/testAuthConfigFile/validJson.json
@@ -0,0 +1,10 @@
+{
+  "quay.io": {
+    "auth": "Zm9vOmJhcg==",
+    "email": "foo@example.com"
+  },
+  "https://index.docker.io/v1/": {
+    "auth": "Zm9vMTpiYXIx",
+    "email": "moo@example.com"
+  }
+}
diff --git a/src/test/resources/testAuthConfigFile/validJsonWithUnknown.json b/src/test/resources/testAuthConfigFile/validJsonWithUnknown.json
@@ -0,0 +1,12 @@
+{
+  "auths": {
+    "192.168.99.100:32768": {},
+    "https://index.docker.io/v1/": {
+      "auth": "Zm9vOmJhcg==",
+      "email": "foo@example.com"
+    }
+  },
+  "HttpHeaders": {
+    "User-Agent": "user agent"
+  }
+}
