fix(docker): resolve the issue of Failed to parse ResponseBody : Unrecognized field "child" when google cloud artifact registry responds with additional fields upon invoking tags list api

Author: kirangodishala

clouddriver-docker/src/main/groovy/com/netflix/spinnaker/clouddriver/docker/registry/api/v2/client/DockerRegistryClient.groovy

@@ -16,6 +16,7 @@
 
 package com.netflix.spinnaker.clouddriver.docker.registry.api.v2.client
 
+import com.fasterxml.jackson.databind.DeserializationFeature
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.google.gson.Gson
 import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.DockerUserAgent
@@ -163,6 +164,15 @@ class DockerRegistryClient {
 
   final static String userAgent = DockerUserAgent.getUserAgent()
   final int paginateSize
+  static ObjectMapper objectMapper
+
+  private static ObjectMapper getObjectMapper() {
+    if (objectMapper == null) {
+      objectMapper = new ObjectMapper()
+      objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
+    }
+    return objectMapper
+  }
 
   String getBasicAuth() {
     return tokenService?.basicAuth
@@ -317,9 +327,8 @@ class DockerRegistryClient {
       throw new DockerRegistryOperationException("ResponseBody cannot be null")
     }
     try {
-      def objectMapper = new ObjectMapper()
       def jsonString = responseBody.string()
-      return objectMapper.readValue(jsonString, aClass)
+      return getObjectMapper().readValue(jsonString, aClass)
     } catch (Exception e) {
       throw new DockerRegistryOperationException("Failed to parse ResponseBody : ${e.message}", e)
     }

clouddriver-docker/src/test/java/com/netflix/spinnaker/clouddriver/docker/registry/api/v2/client/DockerRegistryClientTest.java

@@ -23,7 +23,6 @@
 import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertIterableEquals;
-import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.anyString;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -32,7 +31,6 @@
 import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
 import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.auth.DockerBearerToken;
 import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.auth.DockerBearerTokenService;
-import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.exception.DockerRegistryOperationException;
 import com.netflix.spinnaker.kork.retrofit.ErrorHandlingExecutorCallAdapterFactory;
 import java.util.Arrays;
 import java.util.Map;
@@ -246,12 +244,8 @@ public void testTagsResponse_With_AdditionalFields() throws JsonProcessingExcept
                     .withStatus(HttpStatus.OK.value())
                     .withBody(objectMapper.writeValueAsString(tagsResponse))));
 
-    // TODO: Fix this issue by adding configuration to the ObjectMapper to ignore unknown fields
-    assertThrows(
-        DockerRegistryOperationException.class,
-        () -> dockerRegistryClient.getTags("library/nginx"),
-        "Failed to parse ResponseBody : Unrecognized field \"child\" "
-            + "(class com.netflix.spinnaker.clouddriver.docker.registry.api.v2.client.DockerRegistryTags), "
-            + "not marked as ignorable (3 known properties: \"tags\", \"name\", \"metaClass\"])");
+    DockerRegistryTags dockerRegistryTags = dockerRegistryClient.getTags("library/nginx");
+    String[] tags = (String[]) tagsResponse.get("tags");
+    assertIterableEquals(Arrays.asList(tags), dockerRegistryTags.getTags());
   }
 }