Rework RestCompatTestTransformTask to CC compatibility

To keep supporting configuration cache we need to avoid Serializing JsonNode instances

Author: breskeby

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/compat/compat/RestCompatTestTransformTask.java

@@ -26,6 +26,7 @@
 import org.elasticsearch.gradle.VersionProperties;
 import org.elasticsearch.gradle.internal.test.rest.transform.RestTestTransform;
 import org.elasticsearch.gradle.internal.test.rest.transform.RestTestTransformer;
+import org.elasticsearch.gradle.internal.test.rest.transform.SerializableJsonNode;
 import org.elasticsearch.gradle.internal.test.rest.transform.close_to.ReplaceValueInCloseTo;
 import org.elasticsearch.gradle.internal.test.rest.transform.do_.ReplaceKeyInDo;
 import org.elasticsearch.gradle.internal.test.rest.transform.headers.InjectHeaders;
@@ -169,7 +170,7 @@ public void skipTestsByFilePattern(String filePattern, String reason) {
      * @param value  the value used in the replacement. For example "bar"
      */
     public void replaceValueInMatch(String subKey, Object value) {
-        getTransformations().add(new ReplaceValueInMatch(subKey, MAPPER.convertValue(value, JsonNode.class)));
+        getTransformations().add(new ReplaceValueInMatch(subKey, SerializableJsonNode.of(value, JsonNode.class)));
     }
 
     /**
@@ -180,7 +181,7 @@ public void replaceValueInMatch(String subKey, Object value) {
      * @param testName the testName to apply replacement
      */
     public void replaceValueInMatch(String subKey, Object value, String testName) {
-        getTransformations().add(new ReplaceValueInMatch(subKey, MAPPER.convertValue(value, JsonNode.class), testName));
+        getTransformations().add(new ReplaceValueInMatch(subKey, SerializableJsonNode.of(value, JsonNode.class), testName));
     }
 
     /**
@@ -225,7 +226,7 @@ public void replaceKeyInLength(String oldKeyName, String newKeyName) {
      * @param value  the value used in the replacement. For example 99
      */
     public void replaceValueInLength(String subKey, int value) {
-        getTransformations().add(new ReplaceValueInLength(subKey, MAPPER.convertValue(value, NumericNode.class)));
+        getTransformations().add(new ReplaceValueInLength(subKey, SerializableJsonNode.of(value, NumericNode.class)));
     }
 
     /**
@@ -237,7 +238,7 @@ public void replaceValueInLength(String subKey, int value) {
      * @param testName the testName to apply replacement
      */
     public void replaceValueInLength(String subKey, int value, String testName) {
-        getTransformations().add(new ReplaceValueInLength(subKey, MAPPER.convertValue(value, NumericNode.class), testName));
+        getTransformations().add(new ReplaceValueInLength(subKey, SerializableJsonNode.of(value, NumericNode.class), testName));
     }
 
     /**
@@ -260,7 +261,7 @@ public void replaceKeyInMatch(String oldKeyName, String newKeyName) {
      * @param testName the testName to apply replacement
      */
     public void replaceValueInCloseTo(String subKey, double newValue, String testName) {
-        getTransformations().add(new ReplaceValueInCloseTo(subKey, MAPPER.convertValue(newValue, NumericNode.class), testName));
+        getTransformations().add(new ReplaceValueInCloseTo(subKey, SerializableJsonNode.of(newValue, NumericNode.class), testName));
     }
 
     /**
@@ -271,7 +272,7 @@ public void replaceValueInCloseTo(String subKey, double newValue, String testNam
      * @param newValue the value used in the replacement. For example 9.5
      */
     public void replaceValueInCloseTo(String subKey, double newValue) {
-        getTransformations().add(new ReplaceValueInCloseTo(subKey, MAPPER.convertValue(newValue, NumericNode.class)));
+        getTransformations().add(new ReplaceValueInCloseTo(subKey, SerializableJsonNode.of(newValue, NumericNode.class)));
     }
 
     /**
@@ -282,7 +283,7 @@ public void replaceValueInCloseTo(String subKey, double newValue) {
      * @param newValue the value used in the replacement
      */
     public void replaceIsTrue(String oldValue, Object newValue) {
-        getTransformations().add(new ReplaceIsTrue(oldValue, MAPPER.convertValue(newValue, TextNode.class)));
+        getTransformations().add(new ReplaceIsTrue(oldValue, SerializableJsonNode.of(newValue, TextNode.class)));
     }
 
     /**
@@ -294,7 +295,7 @@ public void replaceIsTrue(String oldValue, Object newValue) {
      * @param testName the testName to apply replacement
      */
     public void replaceIsTrue(String oldValue, Object newValue, String testName) {
-        getTransformations().add(new ReplaceIsTrue(oldValue, MAPPER.convertValue(newValue, TextNode.class), testName));
+        getTransformations().add(new ReplaceIsTrue(oldValue, SerializableJsonNode.of(newValue, TextNode.class), testName));
     }
 
     /**
@@ -305,7 +306,7 @@ public void replaceIsTrue(String oldValue, Object newValue, String testName) {
      * @param newValue the value used in the replacement
      */
     public void replaceIsFalse(String oldValue, Object newValue) {
-        getTransformations().add(new ReplaceIsFalse(oldValue, MAPPER.convertValue(newValue, TextNode.class)));
+        getTransformations().add(new ReplaceIsFalse(oldValue, SerializableJsonNode.of(newValue, TextNode.class)));
     }
 
     /**
@@ -317,7 +318,7 @@ public void replaceIsFalse(String oldValue, Object newValue) {
      * @param testName the testName to apply replacement
      */
     public void replaceIsFalse(String oldValue, Object newValue, String testName) {
-        getTransformations().add(new ReplaceIsFalse(oldValue, MAPPER.convertValue(newValue, TextNode.class), testName));
+        getTransformations().add(new ReplaceIsFalse(oldValue, SerializableJsonNode.of(newValue, TextNode.class), testName));
     }
 
     /**
@@ -329,7 +330,7 @@ public void replaceIsFalse(String oldValue, Object newValue, String testName) {
      * @param newValue the value used in the replacement
      */
     public void replaceValueTextByKeyValue(String key, String oldValue, Object newValue) {
-        getTransformations().add(new ReplaceTextual(key, oldValue, MAPPER.convertValue(newValue, TextNode.class)));
+        getTransformations().add(new ReplaceTextual(key, oldValue, SerializableJsonNode.of(newValue, TextNode.class)));
     }
 
     /**
@@ -342,7 +343,7 @@ public void replaceValueTextByKeyValue(String key, String oldValue, Object newVa
      * @param testName the testName to apply replacement
      */
     public void replaceValueTextByKeyValue(String key, String oldValue, Object newValue, String testName) {
-        getTransformations().add(new ReplaceTextual(key, oldValue, MAPPER.convertValue(newValue, TextNode.class), testName));
+        getTransformations().add(new ReplaceTextual(key, oldValue, SerializableJsonNode.of(newValue, TextNode.class), testName));
     }
 
     /**
@@ -376,7 +377,7 @@ public void removeMatch(String subKey, String testName) {
      * @param testName the testName to apply addition
      */
     public void addMatch(String subKey, Object value, String testName) {
-        getTransformations().add(new AddMatch(subKey, MAPPER.convertValue(value, JsonNode.class), testName));
+        getTransformations().add(new AddMatch(subKey, SerializableJsonNode.of(value, JsonNode.class), testName));
     }
 
     /**

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/ReplaceByKey.java

@@ -10,6 +10,7 @@
 package org.elasticsearch.gradle.internal.test.rest.transform;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.Optional;
@@ -25,18 +26,23 @@
 public abstract class ReplaceByKey implements RestTestTransformByParentObject {
     private final String requiredChildKey;
     private final String newChildKey;
-    private final JsonNode replacementNode;
+    private final SerializableJsonNode replacementNode;
     private final String testName;
 
-    public ReplaceByKey(String requiredChildKey, JsonNode replacementNode) {
+    public ReplaceByKey(String requiredChildKey, SerializableJsonNode<JsonNode> replacementNode) {
         this(requiredChildKey, replacementNode, null);
     }
 
-    public ReplaceByKey(String requiredChildKey, JsonNode replacementNode, String testName) {
+    public ReplaceByKey(String requiredChildKey, SerializableJsonNode<JsonNode> replacementNode, String testName) {
         this(requiredChildKey, requiredChildKey, replacementNode, testName);
     }
 
-    public ReplaceByKey(String requiredChildKey, String newChildKey, JsonNode replacementNode, String testName) {
+    public ReplaceByKey(
+        String requiredChildKey,
+        String newChildKey,
+        SerializableJsonNode<? extends JsonNode> replacementNode,
+        String testName
+    ) {
         this.requiredChildKey = requiredChildKey;
         this.newChildKey = newChildKey;
         this.replacementNode = replacementNode;
@@ -60,7 +66,7 @@ public boolean shouldApply(RestTestContext testContext) {
 
     @Input
     @Optional
-    public JsonNode getReplacementNode() {
+    public SerializableJsonNode<? extends JsonNode> getReplacementNode() {
         return replacementNode;
     }
 
@@ -69,4 +75,10 @@ public JsonNode getReplacementNode() {
     public String getTestName() {
         return testName;
     }
+
+    protected void updateReplacement(ObjectNode matchNode) {
+        matchNode.remove(requiredChildKey());
+        matchNode.set(getNewChildKey(), replacementNode.toJsonNode());
+    }
+
 }

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/SerializableJsonNode.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+package org.elasticsearch.gradle.internal.test.rest.transform;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+
+import java.io.Serializable;
+
+/**
+ * A serializable wrapper for a JsonNode that can be used as Gradle task inputs.
+ * This is necessary because JsonNode serialization is not supported by Gradle configuration cache
+ * as it relies on DataInput.readFully which is unsupported by Gradle.
+ *
+ * @param <T> The type of JsonNode this wrapper will hold.
+ */
+public class SerializableJsonNode<T extends JsonNode> implements Serializable {
+
+    private Object value;
+    private Class<? extends JsonNode> type;
+
+    SerializableJsonNode(Object value, Class<? extends JsonNode> type) {
+        this.value = value;
+        this.type = type;
+    }
+
+    public static SerializableJsonNode of(Object value, Class<? extends JsonNode> type) {
+        return new SerializableJsonNode(value, type);
+    }
+
+    public T toJsonNode() {
+        YAMLFactory YAML_FACTORY = new YAMLFactory();
+        ObjectMapper MAPPER = new ObjectMapper(YAML_FACTORY);
+        return (T) MAPPER.convertValue(value, type);
+    }
+}

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/close_to/ReplaceValueInCloseTo.java

@@ -13,6 +13,7 @@
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import org.elasticsearch.gradle.internal.test.rest.transform.ReplaceByKey;
+import org.elasticsearch.gradle.internal.test.rest.transform.SerializableJsonNode;
 import org.gradle.api.tasks.Internal;
 
 /**
@@ -22,11 +23,11 @@
  */
 public class ReplaceValueInCloseTo extends ReplaceByKey {
 
-    public ReplaceValueInCloseTo(String replaceKey, NumericNode replacementNode) {
+    public ReplaceValueInCloseTo(String replaceKey, SerializableJsonNode<NumericNode> replacementNode) {
         this(replaceKey, replacementNode, null);
     }
 
-    public ReplaceValueInCloseTo(String replaceKey, NumericNode replacementNode, String testName) {
+    public ReplaceValueInCloseTo(String replaceKey, SerializableJsonNode<NumericNode> replacementNode, String testName) {
         super(replaceKey, replaceKey, replacementNode, testName);
     }
 
@@ -41,6 +42,7 @@ public void transformTest(ObjectNode matchParent) {
         ObjectNode closeToNode = (ObjectNode) matchParent.get(getKeyToFind());
         ObjectNode subNode = (ObjectNode) closeToNode.get(requiredChildKey());
         subNode.remove("value");
-        subNode.set("value", getReplacementNode());
+        subNode.set("value", getReplacementNode().toJsonNode());
     }
+
 }

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/length/ReplaceValueInLength.java

@@ -9,10 +9,10 @@
 
 package org.elasticsearch.gradle.internal.test.rest.transform.length;
 
-import com.fasterxml.jackson.databind.node.NumericNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import org.elasticsearch.gradle.internal.test.rest.transform.ReplaceByKey;
+import org.elasticsearch.gradle.internal.test.rest.transform.SerializableJsonNode;
 import org.gradle.api.tasks.Internal;
 
 /**
@@ -21,11 +21,11 @@
  */
 public class ReplaceValueInLength extends ReplaceByKey {
 
-    public ReplaceValueInLength(String replaceKey, NumericNode replacementNode) {
+    public ReplaceValueInLength(String replaceKey, SerializableJsonNode replacementNode) {
         this(replaceKey, replacementNode, null);
     }
 
-    public ReplaceValueInLength(String replaceKey, NumericNode replacementNode, String testName) {
+    public ReplaceValueInLength(String replaceKey, SerializableJsonNode replacementNode, String testName) {
         super(replaceKey, replaceKey, replacementNode, testName);
     }
 
@@ -38,7 +38,7 @@ public String getKeyToFind() {
     @Override
     public void transformTest(ObjectNode matchParent) {
         ObjectNode matchNode = (ObjectNode) matchParent.get(getKeyToFind());
-        matchNode.remove(requiredChildKey());
-        matchNode.set(getNewChildKey(), getReplacementNode());
+        updateReplacement(matchNode);
     }
+
 }

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/match/AddMatch.java

@@ -16,6 +16,7 @@
 
 import org.elasticsearch.gradle.internal.test.rest.transform.RestTestContext;
 import org.elasticsearch.gradle.internal.test.rest.transform.RestTestTransformByParentArray;
+import org.elasticsearch.gradle.internal.test.rest.transform.SerializableJsonNode;
 import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.Internal;
 
@@ -28,9 +29,9 @@ public class AddMatch implements RestTestTransformByParentArray {
     private static JsonNodeFactory jsonNodeFactory = JsonNodeFactory.withExactBigDecimals(false);
     private final String matchKey;
     private final String testName;
-    private final JsonNode matchValue;
+    private final SerializableJsonNode<JsonNode> matchValue;
 
-    public AddMatch(String matchKey, JsonNode matchValue, String testName) {
+    public AddMatch(String matchKey, SerializableJsonNode<JsonNode> matchValue, String testName) {
         this.matchKey = matchKey;
         this.matchValue = matchValue;
         this.testName = Objects.requireNonNull(testName, "adding matches is only supported for named tests");
@@ -45,7 +46,7 @@ public boolean shouldApply(RestTestContext testContext) {
     public void transformTest(ArrayNode matchParent) {
         ObjectNode matchObject = new ObjectNode(jsonNodeFactory);
         ObjectNode matchContent = new ObjectNode(jsonNodeFactory);
-        matchContent.set(matchKey, matchValue);
+        matchContent.set(matchKey, matchValue.toJsonNode());
         matchObject.set("match", matchContent);
         matchParent.add(matchObject);
     }
@@ -70,6 +71,6 @@ public String getTestName() {
 
     @Input
     public JsonNode getMatchValue() {
-        return matchValue;
+        return matchValue.toJsonNode();
     }
 }

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/match/ReplaceValueInMatch.java

@@ -13,18 +13,19 @@
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import org.elasticsearch.gradle.internal.test.rest.transform.ReplaceByKey;
+import org.elasticsearch.gradle.internal.test.rest.transform.SerializableJsonNode;
 import org.gradle.api.tasks.Internal;
 
 /**
  * A transformation to replace the value of a match. For example, change from "match":{"_type": "foo"} to "match":{"_type": "bar"}
  */
 public class ReplaceValueInMatch extends ReplaceByKey {
 
-    public ReplaceValueInMatch(String replaceKey, JsonNode replacementNode) {
+    public ReplaceValueInMatch(String replaceKey, SerializableJsonNode<JsonNode> replacementNode) {
         this(replaceKey, replacementNode, null);
     }
 
-    public ReplaceValueInMatch(String replaceKey, JsonNode replacementNode, String testName) {
+    public ReplaceValueInMatch(String replaceKey, SerializableJsonNode<JsonNode> replacementNode, String testName) {
         super(replaceKey, replaceKey, replacementNode, testName);
     }
 
@@ -37,7 +38,6 @@ public String getKeyToFind() {
     @Override
     public void transformTest(ObjectNode matchParent) {
         ObjectNode matchNode = (ObjectNode) matchParent.get(getKeyToFind());
-        matchNode.remove(requiredChildKey());
-        matchNode.set(getNewChildKey(), getReplacementNode());
+        updateReplacement(matchNode);
     }
 }

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/text/ReplaceIsFalse.java

@@ -11,12 +11,14 @@
 
 import com.fasterxml.jackson.databind.node.TextNode;
 
+import org.elasticsearch.gradle.internal.test.rest.transform.SerializableJsonNode;
+
 public class ReplaceIsFalse extends ReplaceTextual {
-    public ReplaceIsFalse(String valueToBeReplaced, TextNode replacementNode) {
+    public ReplaceIsFalse(String valueToBeReplaced, SerializableJsonNode<TextNode> replacementNode) {
         super("is_false", valueToBeReplaced, replacementNode);
     }
 
-    public ReplaceIsFalse(String valueToBeReplaced, TextNode replacementNode, String testName) {
+    public ReplaceIsFalse(String valueToBeReplaced, SerializableJsonNode<TextNode> replacementNode, String testName) {
         super("is_false", valueToBeReplaced, replacementNode, testName);
     }
 }

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/transform/text/ReplaceIsTrue.java

@@ -11,12 +11,14 @@
 
 import com.fasterxml.jackson.databind.node.TextNode;
 
+import org.elasticsearch.gradle.internal.test.rest.transform.SerializableJsonNode;
+
 public class ReplaceIsTrue extends ReplaceTextual {
-    public ReplaceIsTrue(String valueToBeReplaced, TextNode replacementNode) {
+    public ReplaceIsTrue(String valueToBeReplaced, SerializableJsonNode<TextNode> replacementNode) {
         super("is_true", valueToBeReplaced, replacementNode);
     }
 
-    public ReplaceIsTrue(String valueToBeReplaced, TextNode replacementNode, String testName) {
+    public ReplaceIsTrue(String valueToBeReplaced, SerializableJsonNode<TextNode> replacementNode, String testName) {
         super("is_true", valueToBeReplaced, replacementNode, testName);
     }
 }