Create StandardYamlCoder

Created StandardYamlCoder which is like a StandardCoder, except that
the original converts to/from JSON, while the new class converts to/from
YAML.  Also added YamlMessageBodyHandler and incorporated it into the
http server so that it supports a media type of */yaml.

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

7 files changed, 585 insertions, 0 deletions

diff --git a/utils/pom.xml b/utils/pom.xml
index 78bddab0..96d9c96f 100644
--- a/utils/pom.xml
+++ b/utils/pom.xml
@@ -34,6 +34,10 @@
 
     <dependencies>
         <dependency>
+            <groupId>org.yaml</groupId>
+            <artifactId>snakeyaml</artifactId>
+        </dependency>
+        <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
         </dependency>
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 80eddb86..d3d69812 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
@@ -211,6 +211,16 @@ public class StandardCoder implements Coder {
     }
 
     /**
+     * Encodes an object into a json tree, without catching exceptions.
+     *
+     * @param object object to be encoded
+     * @return a json element representing the object
+     */
+    protected JsonElement toJsonTree(Object object) {
+        return GSON.toJsonTree(object);
+    }
+
+    /**
      * Encodes an object into json, without catching exceptions.
      *
      * @param object object to be encoded
@@ -232,6 +242,17 @@ public class StandardCoder implements Coder {
     }
 
     /**
+     * Decodes a json element into an object, without catching exceptions.
+     *
+     * @param json json element to be decoded
+     * @param clazz class of object to be decoded
+     * @return the object represented by the given json element
+     */
+    protected <T> T fromJson(JsonElement json, Class<T> clazz) {
+        return convertFromDouble(clazz, GSON.fromJson(json, clazz));
+    }
+
+    /**
      * Decodes a json string into an object, without catching exceptions.
      *
      * @param json json string to be decoded
diff --git a/utils/src/main/java/org/onap/policy/common/utils/coder/StandardYamlCoder.java b/utils/src/main/java/org/onap/policy/common/utils/coder/StandardYamlCoder.java
new file mode 100644
index 00000000..357b106e
--- /dev/null
+++ b/utils/src/main/java/org/onap/policy/common/utils/coder/StandardYamlCoder.java
@@ -0,0 +1,264 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2019 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.JsonArray;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonNull;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonPrimitive;
+import java.io.IOException;
+import java.io.Reader;
+import java.io.StringReader;
+import java.io.StringWriter;
+import java.io.Writer;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map.Entry;
+import org.yaml.snakeyaml.DumperOptions;
+import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.emitter.Emitter;
+import org.yaml.snakeyaml.error.YAMLException;
+import org.yaml.snakeyaml.nodes.MappingNode;
+import org.yaml.snakeyaml.nodes.Node;
+import org.yaml.snakeyaml.nodes.NodeTuple;
+import org.yaml.snakeyaml.nodes.ScalarNode;
+import org.yaml.snakeyaml.nodes.SequenceNode;
+import org.yaml.snakeyaml.nodes.Tag;
+import org.yaml.snakeyaml.resolver.Resolver;
+import org.yaml.snakeyaml.serializer.Serializer;
+
+/**
+ * YAML encoder and decoder using the "standard" mechanism, which is currently gson. All
+ * of the methods perform conversion to/from YAML (instead of JSON).
+ */
+public class StandardYamlCoder extends StandardCoder {
+
+    /**
+     * Constructs the object.
+     */
+    public StandardYamlCoder() {
+        super();
+    }
+
+    @Override
+    protected String toJson(Object object) {
+        StringWriter output = new StringWriter();
+        toJson(output, object);
+        return output.toString();
+    }
+
+    @Override
+    protected void toJson(Writer target, Object object) {
+        DumperOptions dumper = new DumperOptions();
+        Serializer serializer = new Serializer(new Emitter(target, dumper), new Resolver(), dumper, null);
+
+        try {
+            serializer.open();
+            serializer.serialize(makeYaml(toJsonTree(object)));
+            serializer.close();
+
+        } catch (IOException e) {
+            throw new YAMLException(e);
+        }
+    }
+
+    @Override
+    protected <T> T fromJson(String yaml, Class<T> clazz) {
+        Node node = new Yaml().compose(new StringReader(yaml));
+        return fromJson(makeGson(node), clazz);
+    }
+
+    @Override
+    protected <T> T fromJson(Reader source, Class<T> clazz) {
+        Node node = new Yaml().compose(source);
+        return fromJson(makeGson(node), clazz);
+    }
+
+    /**
+     * Converts an arbitrary gson element into a corresponding Yaml node.
+     *
+     * @param jel gson element to be converted
+     * @return a yaml node corresponding to the element
+     */
+    private Node makeYaml(JsonElement jel) {
+        if (jel.isJsonArray()) {
+            return makeYamlSequence((JsonArray) jel);
+
+        } else if (jel.isJsonObject()) {
+            return makeYamlMap((JsonObject) jel);
+
+        } else if (jel.isJsonPrimitive()) {
+            return makeYamlPrim((JsonPrimitive) jel);
+
+        } else {
+            return new ScalarNode(Tag.NULL, "", null, null, DumperOptions.ScalarStyle.PLAIN);
+        }
+    }
+
+    /**
+     * Converts an arbitrary gson array into a corresponding Yaml sequence.
+     *
+     * @param jel gson element to be converted
+     * @return a yaml node corresponding to the element
+     */
+    private Node makeYamlSequence(JsonArray jel) {
+        List<Node> nodes = new ArrayList<>(jel.size());
+        jel.forEach(item -> nodes.add(makeYaml(item)));
+
+        return new SequenceNode(Tag.SEQ, true, nodes, null, null, DumperOptions.FlowStyle.AUTO);
+    }
+
+    /**
+     * Converts an arbitrary gson object into a corresponding Yaml map.
+     *
+     * @param jel gson element to be converted
+     * @return a yaml node corresponding to the element
+     */
+    private Node makeYamlMap(JsonObject jel) {
+        List<NodeTuple> nodes = new ArrayList<>(jel.size());
+
+        for (Entry<String, JsonElement> entry : jel.entrySet()) {
+            Node key = new ScalarNode(Tag.STR, entry.getKey(), null, null, DumperOptions.ScalarStyle.PLAIN);
+            Node value = makeYaml(entry.getValue());
+
+            nodes.add(new NodeTuple(key, value));
+        }
+
+        return new MappingNode(Tag.MAP, true, nodes, null, null, DumperOptions.FlowStyle.AUTO);
+    }
+
+    /**
+     * Converts an arbitrary gson primitive into a corresponding Yaml scalar.
+     *
+     * @param jel gson element to be converted
+     * @return a yaml node corresponding to the element
+     */
+    private Node makeYamlPrim(JsonPrimitive jel) {
+        Tag tag;
+        if (jel.isNumber()) {
+            Class<? extends Number> clazz = jel.getAsNumber().getClass();
+
+            if (clazz == Double.class || clazz == Float.class) {
+                tag = Tag.FLOAT;
+
+            } else {
+                tag = Tag.INT;
+            }
+
+        } else if (jel.isBoolean()) {
+            tag = Tag.BOOL;
+
+        } else {
+            // treat anything else as a string
+            tag = Tag.STR;
+        }
+
+        return new ScalarNode(tag, jel.getAsString(), null, null, DumperOptions.ScalarStyle.PLAIN);
+    }
+
+    /**
+     * Converts an arbitrary Yaml node into a corresponding gson element.
+     *
+     * @param node node to be converted
+     * @return a gson element corresponding to the node
+     */
+    private JsonElement makeGson(Node node) {
+        if (node instanceof MappingNode) {
+            return makeGsonObject((MappingNode) node);
+
+        } else if (node instanceof SequenceNode) {
+            return makeGsonArray((SequenceNode) node);
+
+        } else {
+            return makeGsonPrim((ScalarNode) node);
+        }
+
+        // yaml doesn't appear to use anchor nodes when decoding so ignore them for now
+    }
+
+    /**
+     * Converts a Yaml sequence into a corresponding gson array.
+     *
+     * @param node node to be converted
+     * @return a gson element corresponding to the node
+     */
+    private JsonElement makeGsonArray(SequenceNode node) {
+        List<Node> nodes = node.getValue();
+
+        JsonArray array = new JsonArray(nodes.size());
+        nodes.forEach(subnode -> array.add(makeGson(subnode)));
+
+        return array;
+    }
+
+    /**
+     * Converts a Yaml map into a corresponding gson object.
+     *
+     * @param node node to be converted
+     * @return a gson element corresponding to the node
+     */
+    private JsonElement makeGsonObject(MappingNode node) {
+        JsonObject obj = new JsonObject();
+
+        for (NodeTuple tuple : node.getValue()) {
+            Node key = tuple.getKeyNode();
+            String skey = ((ScalarNode) key).getValue();
+
+            obj.add(skey, makeGson(tuple.getValueNode()));
+        }
+
+        return obj;
+    }
+
+    /**
+     * Converts a Yaml scalar into a corresponding gson primitive.
+     *
+     * @param node node to be converted
+     * @return a gson element corresponding to the node
+     */
+    private JsonElement makeGsonPrim(ScalarNode node) {
+        try {
+            Tag tag = node.getTag();
+
+            if (tag == Tag.INT) {
+                return new JsonPrimitive(Long.valueOf(node.getValue()));
+
+            } else if (tag == Tag.FLOAT) {
+                return new JsonPrimitive(Double.valueOf(node.getValue()));
+
+            } else if (tag == Tag.BOOL) {
+                return new JsonPrimitive(Boolean.valueOf(node.getValue()));
+
+            } else if (tag == Tag.NULL) {
+                return JsonNull.INSTANCE;
+
+            } else {
+                // treat anything else as a string
+                return new JsonPrimitive(node.getValue());
+            }
+
+        } catch (NumberFormatException ex) {
+            // just treat it as a string
+            return new JsonPrimitive(node.getValue());
+        }
+    }
+}
diff --git a/utils/src/main/java/org/onap/policy/common/utils/coder/YamlException.java b/utils/src/main/java/org/onap/policy/common/utils/coder/YamlException.java
new file mode 100644
index 00000000..d6591b3b
--- /dev/null
+++ b/utils/src/main/java/org/onap/policy/common/utils/coder/YamlException.java
@@ -0,0 +1,63 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2019 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 org.yaml.snakeyaml.error.Mark;
+
+/**
+ * Runtime Exception generated by StandardYamlCoder.
+ */
+public class YamlException extends RuntimeException {
+    private static final long serialVersionUID = 1L;
+
+    private final Mark problemMark;
+
+
+    /**
+     * Constructs the object.
+     *
+     * @param reason reason for the exception
+     * @param problemMark where the exception occurred within the input
+     */
+    public YamlException(String reason, Mark problemMark) {
+        super(reason);
+
+        this.problemMark = problemMark;
+    }
+
+    /**
+     * Constructs the object.
+     *
+     * @param reason reason for the exception
+     * @param problemMark where the exception occurred within the input
+     * @param cause cause of the exception
+     */
+    public YamlException(String reason, Mark problemMark, Throwable cause) {
+        super(reason, cause);
+
+        this.problemMark = problemMark;
+    }
+
+    @Override
+    public String getMessage() {
+        return super.getMessage() + problemMark;
+    }
+}
diff --git a/utils/src/test/java/org/onap/policy/common/utils/coder/StandardYamlCoderTest.java b/utils/src/test/java/org/onap/policy/common/utils/coder/StandardYamlCoderTest.java
new file mode 100644
index 00000000..6ec20663
--- /dev/null
+++ b/utils/src/test/java/org/onap/policy/common/utils/coder/StandardYamlCoderTest.java
@@ -0,0 +1,151 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2019 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.assertThatThrownBy;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.Writer;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.util.List;
+import java.util.Map;
+import lombok.EqualsAndHashCode;
+import org.junit.Before;
+import org.junit.Test;
+
+public class StandardYamlCoderTest {
+    private static final File YAML_FILE =
+                    new File("src/test/resources/org/onap/policy/common/utils/coder/StandardYamlCoder.yaml");
+
+    private StandardYamlCoder coder;
+    private Container cont;
+
+    @Before
+    public void setUp() throws CoderException {
+        coder = new StandardYamlCoder();
+        cont = coder.decode(YAML_FILE, Container.class);
+    }
+
+    @Test
+    public void testToJsonObject() throws CoderException {
+        String yaml = coder.encode(cont);
+
+        Container cont2 = coder.decode(yaml, Container.class);
+        assertEquals(cont, cont2);
+    }
+
+    @Test
+    public void testToJsonWriterObject() throws Exception {
+        IOException ex = new IOException("expected exception");
+
+        // writer that throws an exception when the write() method is invoked
+        Writer wtr = new Writer() {
+            @Override
+            public void write(char[] cbuf, int off, int len) throws IOException {
+                throw ex;
+            }
+
+            @Override
+            public void flush() throws IOException {
+                // do nothing
+            }
+
+            @Override
+            public void close() throws IOException {
+                // do nothing
+            }
+        };
+
+        assertThatThrownBy(() -> coder.encode(wtr, cont)).isInstanceOf(CoderException.class);
+
+        wtr.close();
+    }
+
+    @Test
+    public void testFromJsonStringClassOfT() throws Exception {
+        String yaml = new String(Files.readAllBytes(YAML_FILE.toPath()), StandardCharsets.UTF_8);
+        Container cont2 = coder.decode(yaml, Container.class);
+        assertEquals(cont, cont2);
+    }
+
+    @Test
+    public void testFromJsonReaderClassOfT() {
+        assertNotNull(cont.item);
+        assertTrue(cont.item.boolVal);
+        assertEquals(1000L, cont.item.longVal);
+        assertEquals(1010.1f, cont.item.floatVal, 0.00001);
+
+        assertEquals(4, cont.list.size());
+        assertNull(cont.list.get(1));
+
+        assertEquals(20, cont.list.get(0).intVal);
+        assertEquals("string 30", cont.list.get(0).stringVal);
+        assertNull(cont.list.get(0).nullVal);
+
+        assertEquals(40.0, cont.list.get(2).doubleVal, 0.000001);
+        assertNull(cont.list.get(2).nullVal);
+        assertNotNull(cont.list.get(2).another);
+        assertEquals(50, cont.list.get(2).another.intVal);
+
+        assertTrue(cont.list.get(3).boolVal);
+
+        assertNotNull(cont.map);
+        assertEquals(3, cont.map.size());
+
+        assertNotNull(cont.map.get("itemA"));
+        assertEquals("stringA", cont.map.get("itemA").stringVal);
+
+        assertNotNull(cont.map.get("itemB"));
+        assertEquals("stringB", cont.map.get("itemB").stringVal);
+
+        double dbl = 123456789012345678901234567890.0;
+        assertEquals(dbl, cont.map.get("itemB").doubleVal, 1000.0);
+
+        assertNotNull(cont.map.get("itemC"));
+        assertTrue(cont.map.get("itemC").boolVal);
+    }
+
+
+    @EqualsAndHashCode
+    public static class Container {
+        private Item item;
+        private List<Item> list;
+        private Map<String, Item> map;
+    }
+
+    @EqualsAndHashCode
+    public static class Item {
+        private boolean boolVal;
+        private int intVal;
+        private long longVal;
+        private double doubleVal;
+        private float floatVal;
+        private String stringVal;
+        private Object nullVal;
+        private Item another;
+    }
+}
diff --git a/utils/src/test/java/org/onap/policy/common/utils/coder/YamlExceptionTest.java b/utils/src/test/java/org/onap/policy/common/utils/coder/YamlExceptionTest.java
new file mode 100644
index 00000000..bfa6249e
--- /dev/null
+++ b/utils/src/test/java/org/onap/policy/common/utils/coder/YamlExceptionTest.java
@@ -0,0 +1,61 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2019 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.junit.Assert.assertSame;
+
+import java.io.IOException;
+import org.junit.Test;
+import org.yaml.snakeyaml.error.Mark;
+
+public class YamlExceptionTest {
+    private static final char[] str = {'d', 'a', 't', 'a'};
+    private static final String DATA = new String(str);
+    private static final String MESSAGE = "hello";
+
+    private static final Mark mark = new Mark("a file", 3, 5, 9, str, 0);
+
+    @Test
+    public void testYamlExceptionStringMark() {
+        YamlException ex = new YamlException(MESSAGE, mark);
+
+        String str = ex.getMessage();
+        assertThat(str).contains(MESSAGE).contains(DATA);
+
+        str = ex.toString();
+        assertThat(str).contains(MESSAGE).contains(DATA);
+    }
+
+    @Test
+    public void testYamlExceptionStringMarkThrowable() {
+        Throwable thr = new IOException("expected exception");
+        YamlException ex = new YamlException(MESSAGE, mark, thr);
+
+        assertSame(thr, ex.getCause());
+
+        String str = ex.getMessage();
+        assertThat(str).contains(MESSAGE).contains(DATA);
+
+        str = ex.toString();
+        assertThat(str).contains(MESSAGE).contains(DATA);
+    }
+}
diff --git a/utils/src/test/resources/org/onap/policy/common/utils/coder/StandardYamlCoder.yaml b/utils/src/test/resources/org/onap/policy/common/utils/coder/StandardYamlCoder.yaml
new file mode 100644
index 00000000..1da7bfa3
--- /dev/null
+++ b/utils/src/test/resources/org/onap/policy/common/utils/coder/StandardYamlCoder.yaml
@@ -0,0 +1,21 @@
+---
+item: &top
+  boolVal: true
+  longVal: 1000
+  floatVal: 1010.1
+list:
+- intVal: 20
+  stringVal: string 30
+  nullVal:
+-
+- doubleVal: 40
+  another:
+    intVal: 50
+- *top
+map:
+  itemA:
+    stringVal: stringA
+  itemB:
+    stringVal: stringB
+    doubleVal: 123456789012345678901234567890
+  itemC: *top