HONEYCOMB-61: Restore configuration and context from persisted files

Change-Id: I6edce127f8895f5d65998b4be71a0a111ca2e8bb
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>

5 files changed, 245 insertions, 0 deletions

diff --git a/v3po/translate-utils/pom.xml b/v3po/translate-utils/pom.xml
index 346757cc2..9cb6590d8 100644
--- a/v3po/translate-utils/pom.xml
+++ b/v3po/translate-utils/pom.xml
@@ -66,6 +66,10 @@
             <groupId>org.opendaylight.mdsal</groupId>
             <artifactId>mdsal-binding-dom-codec</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.opendaylight.yangtools</groupId>
+            <artifactId>yang-data-codec-gson</artifactId>
+        </dependency>
 
         <!-- Testing Dependencies -->
         <dependency>
diff --git a/v3po/translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/util/JsonUtils.java b/v3po/translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/util/JsonUtils.java
new file mode 100644
index 000000000..be6ffa235
--- /dev/null
+++ b/v3po/translate-utils/src/main/java/io/fd/honeycomb/v3po/translate/util/JsonUtils.java
@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.v3po.translate.util;
+
+import com.google.common.base.Charsets;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
+import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
+import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
+import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
+import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public class JsonUtils {
+
+    private JsonUtils() {}
+
+    /**
+     * Serialize normalized node root structure into provided output stream
+     *
+     * @throws IOException if serialized data cannot be written into provided output stream
+     */
+    public static void writeJsonRoot(@Nonnull final NormalizedNode<?, ?> rootData,
+                                     @Nonnull final SchemaContext schemaContext,
+                                     @Nonnull final OutputStream outputStream) throws IOException {
+        final JsonWriter
+            jsonWriter = createJsonWriter(outputStream, true);
+        final NormalizedNodeStreamWriter streamWriter = JSONNormalizedNodeStreamWriter
+            .createNestedWriter(JSONCodecFactory.create(schemaContext), SchemaPath.ROOT, null, jsonWriter);
+        final NormalizedNodeWriter normalizedNodeWriter =
+            NormalizedNodeWriter.forStreamWriter(streamWriter, true);
+        jsonWriter.beginObject();
+        writeChildren(normalizedNodeWriter,(ContainerNode) rootData);
+        jsonWriter.endObject();
+        jsonWriter.flush();
+    }
+
+    /**
+     * Read json serialized normalized node root structure and parse them into normalized nodes
+     *
+     * @return artificial normalized node holding all the top level nodes from provided stream as children. In case
+     *         the stream is empty, empty artificial normalized node is returned
+     *
+     * @throws IllegalArgumentException if content in the provided input stream is not restore-able
+     */
+    public static ContainerNode readJsonRoot(@Nonnull final SchemaContext schemaContext,
+                                             @Nonnull final InputStream stream) {
+        final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> builder =
+            Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()));
+        final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(builder);
+
+        final JsonParserStream jsonParser = JsonParserStream.create(writer, schemaContext);
+        final JsonReader reader = new JsonReader(new InputStreamReader(stream));
+        jsonParser.parse(reader);
+
+        return builder.build();
+    }
+
+    private static void writeChildren(final NormalizedNodeWriter nnWriter, final ContainerNode data) throws IOException {
+        for(final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> child : data.getValue()) {
+            nnWriter.write(child);
+        }
+    }
+
+    private static JsonWriter createJsonWriter(final OutputStream entityStream, boolean prettyPrint) {
+        if (prettyPrint) {
+            return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, Charsets.UTF_8), 2);
+        } else {
+            return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, Charsets.UTF_8));
+        }
+    }
+}
diff --git a/v3po/translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/util/JsonUtilsTest.java b/v3po/translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/util/JsonUtilsTest.java
new file mode 100644
index 000000000..bd48cb446
--- /dev/null
+++ b/v3po/translate-utils/src/test/java/io/fd/honeycomb/v3po/translate/util/JsonUtilsTest.java
@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.v3po.translate.util;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import com.google.common.io.ByteStreams;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.MockitoAnnotations;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
+import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangStatementSourceImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveSchemaContext;
+
+public class JsonUtilsTest {
+
+    public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:test:persistence";
+
+    private static final QName ROOT_QNAME = QName.create("urn:ietf:params:xml:ns:netconf:base:1.0",  "data");
+    private static final QName TOP_CONTAINER_NAME = QName.create(NAMESPACE, "2015-01-05", "top-container");
+    private static final QName TOP_CONTAINER2_NAME = QName.create(NAMESPACE, "2015-01-05", "top-container2");
+    private static final QName STRING_LEAF_QNAME = QName.create(TOP_CONTAINER_NAME, "string");
+
+    private Path tmpPersistFile;
+    private EffectiveSchemaContext effectiveSchemaContext;
+
+    @Before
+    public void setUp() throws Exception {
+        MockitoAnnotations.initMocks(this);
+        tmpPersistFile = Files.createTempFile("testing-hc-persistence", "json");
+
+        final CrossSourceStatementReactor.BuildAction buildAction = YangInferencePipeline.RFC6020_REACTOR.newBuild();
+        buildAction.addSource(new YangStatementSourceImpl(getClass().getResourceAsStream("/test-persistence.yang")));
+        effectiveSchemaContext = buildAction.buildEffective();
+    }
+
+    @Test
+    public void testPersist() throws Exception {
+
+        NormalizedNode<?, ?> data = getData("testing");
+        JsonUtils.writeJsonRoot(data, effectiveSchemaContext, Files.newOutputStream(tmpPersistFile, StandardOpenOption.CREATE));
+        assertTrue(Files.exists(tmpPersistFile));
+
+        String persisted = new String(Files.readAllBytes(tmpPersistFile));
+        String expected =
+            new String(ByteStreams.toByteArray(getClass().getResourceAsStream("/expected-persisted-output.txt")));
+
+        assertEquals(expected, persisted);
+
+        data = getData("testing2");
+        JsonUtils.writeJsonRoot(data, effectiveSchemaContext, Files.newOutputStream(tmpPersistFile, StandardOpenOption.CREATE));
+        persisted = new String(Files.readAllBytes(tmpPersistFile));
+        assertEquals(expected.replace("testing", "testing2"), persisted);
+
+        // File has to stay even after close
+        assertTrue(Files.exists(tmpPersistFile));
+    }
+
+    @Test
+    public void testRestore() throws Exception {
+        final ContainerNode normalizedNodeOptional = JsonUtils
+            .readJsonRoot(effectiveSchemaContext, getClass().getResourceAsStream("/expected-persisted-output.txt"));
+        assertEquals(getData("testing"), normalizedNodeOptional);
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testRestoreInvalidFile() throws Exception {
+        JsonUtils.readJsonRoot(effectiveSchemaContext, getClass().getResourceAsStream("/test-persistence.yang"));
+    }
+
+    private ContainerNode getData(final String stringValue) {
+        return Builders.containerBuilder()
+            .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(ROOT_QNAME))
+            .withChild(Builders.containerBuilder()
+                .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TOP_CONTAINER_NAME))
+                .withChild(ImmutableNodes.leafNode(STRING_LEAF_QNAME, stringValue))
+                .build())
+            .withChild(Builders.containerBuilder()
+                .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TOP_CONTAINER2_NAME))
+                .withChild(ImmutableNodes.leafNode(STRING_LEAF_QNAME, stringValue))
+                .build())
+            .build();
+    }
+}
\ No newline at end of file
diff --git a/v3po/translate-utils/src/test/resources/expected-persisted-output.txt b/v3po/translate-utils/src/test/resources/expected-persisted-output.txt
new file mode 100644
index 000000000..f0f5902e2
--- /dev/null
+++ b/v3po/translate-utils/src/test/resources/expected-persisted-output.txt
@@ -0,0 +1,8 @@
+{
+  "test-persistence:top-container": {
+    "string": "testing"
+  },
+  "test-persistence:top-container2": {
+    "string": "testing"
+  }
+}
\ No newline at end of file
diff --git a/v3po/translate-utils/src/test/resources/test-persistence.yang b/v3po/translate-utils/src/test/resources/test-persistence.yang
new file mode 100644
index 000000000..6dca9f2d5
--- /dev/null
+++ b/v3po/translate-utils/src/test/resources/test-persistence.yang
@@ -0,0 +1,22 @@
+module test-persistence {
+    yang-version 1;
+    namespace "urn:opendaylight:params:xml:ns:yang:test:persistence";
+    prefix "tp";
+
+    revision "2015-01-05" {
+        description "Initial revision";
+    }
+
+    container top-container {
+        leaf string {
+            type string;
+        }
+    }
+
+    container top-container2 {
+        leaf string {
+            type string;
+        }
+    }
+
+}