Add gson adapters for special field types

Added type adapters for Instant, LocalDateTime, and ZonedDateTime.  UUID
seems to work already.
Added new Coder that offers an alternative encoding for Instant.

Issue-ID: POLICY-1625
Signed-off-by: Jim Hahn <jrh3@att.com>
Change-Id: I5230fa7fe955d78c5f2da1316cb1504b5875ea84

3 files changed, 286 insertions, 1 deletions

diff --git a/utils/src/main/java/org/onap/policy/common/utils/coder/StandardCoder.java b/utils/src/main/java/org/onap/policy/common/utils/coder/StandardCoder.java
index 9d444cae..2548dea4 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/coder/StandardCoder.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/coder/StandardCoder.java
@@ -363,7 +363,7 @@ public class StandardCoder implements Coder {
     /**
      * Adapter for standard objects.
      */
-    private static class StandardTypeAdapter extends TypeAdapter<StandardCoderObject> {
+    protected static class StandardTypeAdapter extends TypeAdapter<StandardCoderObject> {
 
         /**
          * Used to read/write a JsonElement.
diff --git a/utils/src/main/java/org/onap/policy/common/utils/coder/StandardCoderInstantAsMillis.java b/utils/src/main/java/org/onap/policy/common/utils/coder/StandardCoderInstantAsMillis.java
new file mode 100644
index 00000000..fbb53b91
--- /dev/null
+++ b/utils/src/main/java/org/onap/policy/common/utils/coder/StandardCoderInstantAsMillis.java
@@ -0,0 +1,125 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.utils.coder;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonElement;
+import java.io.Reader;
+import java.io.Writer;
+import java.time.Instant;
+import lombok.AccessLevel;
+import lombok.Getter;
+import org.onap.policy.common.gson.GsonMessageBodyHandler;
+import org.onap.policy.common.gson.InstantAsMillisTypeAdapter;
+
+/**
+ * JSON encoder and decoder using the "standard" mechanism, but encodes Instant fields as
+ * Long milliseconds.
+ */
+public class StandardCoderInstantAsMillis extends StandardCoder {
+
+    /**
+     * Gson object used to encode and decode messages.
+     */
+    @Getter(AccessLevel.PROTECTED)
+    private static final Gson GSON;
+
+    /**
+     * Gson object used to encode messages in "pretty" format.
+     */
+    @Getter(AccessLevel.PROTECTED)
+    private static final Gson GSON_PRETTY;
+
+    static {
+        GsonBuilder builder = GsonMessageBodyHandler
+                        .configBuilder(new GsonBuilder().registerTypeAdapter(StandardCoderObject.class,
+                                        new StandardTypeAdapter()))
+                        .registerTypeAdapter(Instant.class, new InstantAsMillisTypeAdapter());
+
+        GSON = builder.create();
+        GSON_PRETTY = builder.setPrettyPrinting().create();
+    }
+
+    /**
+     * Constructs the object.
+     */
+    public StandardCoderInstantAsMillis() {
+        super();
+    }
+
+    @Override
+    protected String toPrettyJson(Object object) {
+        return GSON_PRETTY.toJson(object);
+    }
+
+    @Override
+    public StandardCoderObject toStandard(Object object) throws CoderException {
+        try {
+            return new StandardCoderObject(GSON.toJsonTree(object));
+
+        } catch (RuntimeException e) {
+            throw new CoderException(e);
+        }
+    }
+
+    @Override
+    public <T> T fromStandard(StandardCoderObject sco, Class<T> clazz) throws CoderException {
+        try {
+            return GSON.fromJson(sco.getData(), clazz);
+
+        } catch (RuntimeException e) {
+            throw new CoderException(e);
+        }
+    }
+
+    // the remaining methods are wrappers that can be overridden by junit tests
+
+    @Override
+    protected JsonElement toJsonTree(Object object) {
+        return GSON.toJsonTree(object);
+    }
+
+    @Override
+    protected String toJson(Object object) {
+        return GSON.toJson(object);
+    }
+
+    @Override
+    protected void toJson(Writer target, Object object) {
+        GSON.toJson(object, object.getClass(), target);
+    }
+
+    @Override
+    protected <T> T fromJson(JsonElement json, Class<T> clazz) {
+        return convertFromDouble(clazz, GSON.fromJson(json, clazz));
+    }
+
+    @Override
+    protected <T> T fromJson(String json, Class<T> clazz) {
+        return convertFromDouble(clazz, GSON.fromJson(json, clazz));
+    }
+
+    @Override
+    protected <T> T fromJson(Reader source, Class<T> clazz) {
+        return convertFromDouble(clazz, GSON.fromJson(source, clazz));
+    }
+}
diff --git a/utils/src/test/java/org/onap/policy/common/utils/coder/StandardCoderInstantAsMillisTest.java b/utils/src/test/java/org/onap/policy/common/utils/coder/StandardCoderInstantAsMillisTest.java
new file mode 100644
index 00000000..ec977da6
--- /dev/null
+++ b/utils/src/test/java/org/onap/policy/common/utils/coder/StandardCoderInstantAsMillisTest.java
@@ -0,0 +1,160 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP PAP
+ * ================================================================================
+ * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.utils.coder;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import com.google.gson.JsonElement;
+import java.io.StringReader;
+import java.io.StringWriter;
+import java.time.Instant;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import lombok.ToString;
+import org.junit.Before;
+import org.junit.Test;
+
+public class StandardCoderInstantAsMillisTest {
+    private static final long INSTANT_MILLIS = 1583249713500L;
+    private static final String INSTANT_TEXT = String.valueOf(INSTANT_MILLIS);
+
+    private StandardCoder coder;
+
+    @Before
+    public void setUp() {
+        coder = new StandardCoderInstantAsMillis();
+    }
+
+    @Test
+    public void testConvert() throws CoderException {
+        MyObject obj = makeObject();
+
+        @SuppressWarnings("unchecked")
+        Map<String, Object> map = coder.convert(obj, LinkedHashMap.class);
+
+        assertThat(map.toString()).contains(INSTANT_TEXT);
+
+        MyObject obj2 = coder.convert(map, MyObject.class);
+        assertEquals(obj.toString(), obj2.toString());
+    }
+
+    @Test
+    public void testEncodeDecode() throws CoderException {
+        MyObject obj = makeObject();
+        assertThat(coder.encode(obj, false)).contains(INSTANT_TEXT);
+        assertThat(coder.encode(obj, true)).contains(INSTANT_TEXT);
+
+        String json = coder.encode(obj);
+        MyObject obj2 = coder.decode(json, MyObject.class);
+        assertEquals(obj.toString(), obj2.toString());
+
+        StringWriter wtr = new StringWriter();
+        coder.encode(wtr, obj);
+        json = wtr.toString();
+        assertThat(json).contains(INSTANT_TEXT);
+
+        StringReader rdr = new StringReader(json);
+        obj2 = coder.decode(rdr, MyObject.class);
+        assertEquals(obj.toString(), obj2.toString());
+    }
+
+    @Test
+    public void testJson() {
+        MyObject obj = makeObject();
+        assertThat(coder.toPrettyJson(obj)).contains(INSTANT_TEXT);
+    }
+
+    @Test
+    public void testToJsonTree_testFromJsonJsonElementClassT() throws Exception {
+        MyMap map = new MyMap();
+        map.props = new LinkedHashMap<>();
+        map.props.put("jel keyA", "jel valueA");
+        map.props.put("jel keyB", "jel valueB");
+
+        JsonElement json = coder.toJsonTree(map);
+        assertEquals("{'props':{'jel keyA':'jel valueA','jel keyB':'jel valueB'}}".replace('\'', '"'), json.toString());
+
+        Object result = coder.fromJson(json, MyMap.class);
+
+        assertNotNull(result);
+        assertEquals("{jel keyA=jel valueA, jel keyB=jel valueB}", result.toString());
+    }
+
+    @Test
+    public void testConvertFromDouble() throws Exception {
+        String text = "[listA, {keyA=100}, 200]";
+        assertEquals(text, coder.decode(text, Object.class).toString());
+
+        text = "{keyB=200}";
+        assertEquals(text, coder.decode(text, Object.class).toString());
+    }
+
+    @Test
+    public void testToStandard() throws Exception {
+        MyObject obj = makeObject();
+        StandardCoderObject sco = coder.toStandard(obj);
+        assertNotNull(sco.getData());
+        assertEquals("{'abc':'xyz','instant':1583249713500}".replace('\'', '"'), sco.getData().toString());
+
+        // class instead of object -> exception
+        assertThatThrownBy(() -> coder.toStandard(String.class)).isInstanceOf(CoderException.class);
+    }
+
+    @Test
+    public void testFromStandard() throws Exception {
+        MyObject obj = new MyObject();
+        obj.abc = "pdq";
+        StandardCoderObject sco = coder.toStandard(obj);
+
+        MyObject obj2 = coder.fromStandard(sco, MyObject.class);
+        assertEquals(obj.toString(), obj2.toString());
+
+        // null class -> exception
+        assertThatThrownBy(() -> coder.fromStandard(sco, null)).isInstanceOf(CoderException.class);
+    }
+
+
+    private MyObject makeObject() {
+        MyObject obj = new MyObject();
+        obj.abc = "xyz";
+        obj.instant = Instant.ofEpochMilli(INSTANT_MILLIS);
+        return obj;
+    }
+
+
+    @ToString
+    private static class MyObject {
+        private String abc;
+        private Instant instant;
+    }
+
+    public static class MyMap {
+        private Map<String, Object> props;
+
+        @Override
+        public String toString() {
+            return props.toString();
+        }
+    }
+}