opendaylight/md-sal/sal-clustering-commons/src/test/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/NormalizedNodeStreamReaderWriterTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.cluster.datastore.node.utils.stream;
  10
  11 import static org.junit.Assert.assertEquals;
  12
  13 import com.google.common.base.Optional;
  14 import com.google.common.io.ByteStreams;
  15 import java.io.ByteArrayOutputStream;
  16 import java.io.IOException;
  17 import java.io.StringReader;
  18 import java.io.StringWriter;
  19 import javax.xml.parsers.DocumentBuilderFactory;
  20 import javax.xml.transform.OutputKeys;
  21 import javax.xml.transform.Transformer;
  22 import javax.xml.transform.TransformerFactory;
  23 import javax.xml.transform.dom.DOMSource;
  24 import javax.xml.transform.stream.StreamResult;
  25 import org.apache.commons.lang.SerializationUtils;
  26 import org.junit.Assert;
  27 import org.junit.Test;
  28 import org.opendaylight.controller.cluster.datastore.util.TestModel;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  34 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  37 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  45 import org.w3c.dom.Node;
  46 import org.xml.sax.InputSource;
  47
  48 public class NormalizedNodeStreamReaderWriterTest {
  49
  50     @SuppressWarnings("deprecation")
  51     @Test
  52     public void testNormalizedNodeStreaming() throws IOException {
  53
  54         ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
  55         NormalizedNodeOutputStreamWriter writer = new NormalizedNodeOutputStreamWriter(
  56             ByteStreams.newDataOutput(byteArrayOutputStream));
  57
  58         NormalizedNode<?, ?> testContainer = createTestContainer();
  59         writer.writeNormalizedNode(testContainer);
  60
  61         QName toaster = QName.create("http://netconfcentral.org/ns/toaster","2009-11-20","toaster");
  62         QName darknessFactor = QName.create("http://netconfcentral.org/ns/toaster","2009-11-20","darknessFactor");
  63         QName description = QName.create("http://netconfcentral.org/ns/toaster","2009-11-20","description");
  64         ContainerNode toasterNode = Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(toaster))
  65                 .withChild(ImmutableNodes.leafNode(darknessFactor, "1000"))
  66                 .withChild(ImmutableNodes.leafNode(description, largeString(20))).build();
  67
  68         ContainerNode toasterContainer = Builders.containerBuilder()
  69                 .withNodeIdentifier(new NodeIdentifier(SchemaContext.NAME)).withChild(toasterNode).build();
  70         writer.writeNormalizedNode(toasterContainer);
  71
  72         NormalizedNodeInputStreamReader reader = new NormalizedNodeInputStreamReader(
  73             ByteStreams.newDataInput(byteArrayOutputStream.toByteArray()));
  74
  75         NormalizedNode<?,?> node = reader.readNormalizedNode();
  76         Assert.assertEquals(testContainer, node);
  77
  78         node = reader.readNormalizedNode();
  79         Assert.assertEquals(toasterContainer, node);
  80
  81         writer.close();
  82     }
  83
  84     private static NormalizedNode<?, ?> createTestContainer() {
  85         byte[] bytes1 = {1,2,3};
  86         LeafSetEntryNode<Object> entry1 = ImmutableLeafSetEntryNodeBuilder.create().withNodeIdentifier(
  87                 new NodeWithValue<>(TestModel.BINARY_LEAF_LIST_QNAME, bytes1)).withValue(bytes1).build();
  88
  89         byte[] bytes2 = {};
  90         LeafSetEntryNode<Object> entry2 = ImmutableLeafSetEntryNodeBuilder.create().withNodeIdentifier(
  91                 new NodeWithValue<>(TestModel.BINARY_LEAF_LIST_QNAME, bytes2)).withValue(bytes2).build();
  92
  93         LeafSetEntryNode<Object> entry3 = ImmutableLeafSetEntryNodeBuilder.create().withNodeIdentifier(
  94                 new NodeWithValue<>(TestModel.BINARY_LEAF_LIST_QNAME, null)).withValue(null).build();
  95
  96         return TestModel.createBaseTestContainerBuilder()
  97                 .withChild(ImmutableLeafSetNodeBuilder.create().withNodeIdentifier(
  98                         new NodeIdentifier(TestModel.BINARY_LEAF_LIST_QNAME))
  99                         .withChild(entry1).withChild(entry2).withChild(entry3).build())
 100                 .withChild(ImmutableNodes.leafNode(TestModel.SOME_BINARY_DATA_QNAME, new byte[]{1,2,3,4}))
 101                 .withChild(Builders.orderedMapBuilder()
 102                       .withNodeIdentifier(new NodeIdentifier(TestModel.ORDERED_LIST_QNAME))
 103                       .withChild(ImmutableNodes.mapEntry(TestModel.ORDERED_LIST_ENTRY_QNAME,
 104                               TestModel.ID_QNAME, 11)).build()).build();
 105     }
 106
 107     @SuppressWarnings("deprecation")
 108     @Test
 109     public void testYangInstanceIdentifierStreaming() throws IOException  {
 110         YangInstanceIdentifier path = YangInstanceIdentifier.builder(TestModel.TEST_PATH)
 111                 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(
 112                         TestModel.INNER_LIST_QNAME, TestModel.ID_QNAME, 10).build();
 113
 114         ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
 115         NormalizedNodeOutputStreamWriter writer =
 116                 new NormalizedNodeOutputStreamWriter(ByteStreams.newDataOutput(byteArrayOutputStream));
 117         writer.writeYangInstanceIdentifier(path);
 118
 119         NormalizedNodeInputStreamReader reader = new NormalizedNodeInputStreamReader(
 120             ByteStreams.newDataInput(byteArrayOutputStream.toByteArray()));
 121
 122         YangInstanceIdentifier newPath = reader.readYangInstanceIdentifier();
 123         Assert.assertEquals(path, newPath);
 124
 125         writer.close();
 126     }
 127
 128     @Test
 129     public void testNormalizedNodeAndYangInstanceIdentifierStreaming() throws IOException {
 130
 131         ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
 132         NormalizedNodeOutputStreamWriter writer = new NormalizedNodeOutputStreamWriter(
 133             ByteStreams.newDataOutput(byteArrayOutputStream));
 134
 135         NormalizedNode<?, ?> testContainer = TestModel.createBaseTestContainerBuilder().build();
 136         writer.writeNormalizedNode(testContainer);
 137
 138         YangInstanceIdentifier path = YangInstanceIdentifier.builder(TestModel.TEST_PATH)
 139                 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(
 140                         TestModel.INNER_LIST_QNAME, TestModel.ID_QNAME, 10).build();
 141
 142         writer.writeYangInstanceIdentifier(path);
 143
 144         NormalizedNodeDataInput reader = NormalizedNodeInputOutput.newDataInput(
 145             ByteStreams.newDataInput(byteArrayOutputStream.toByteArray()));
 146
 147         NormalizedNode<?,?> node = reader.readNormalizedNode();
 148         Assert.assertEquals(testContainer, node);
 149
 150         YangInstanceIdentifier newPath = reader.readYangInstanceIdentifier();
 151         Assert.assertEquals(path, newPath);
 152
 153         writer.close();
 154     }
 155
 156     @Test(expected = InvalidNormalizedNodeStreamException.class, timeout = 10000)
 157     public void testInvalidNormalizedNodeStream() throws IOException {
 158         byte[] invalidBytes = {1,2,3};
 159         NormalizedNodeDataInput reader = NormalizedNodeInputOutput.newDataInput(
 160                 ByteStreams.newDataInput(invalidBytes));
 161
 162         reader.readNormalizedNode();
 163     }
 164
 165     @Test(expected = InvalidNormalizedNodeStreamException.class, timeout = 10000)
 166     public void testInvalidYangInstanceIdentifierStream() throws IOException {
 167         byte[] invalidBytes = {1,2,3};
 168         NormalizedNodeDataInput reader = NormalizedNodeInputOutput.newDataInput(
 169             ByteStreams.newDataInput(invalidBytes));
 170
 171         reader.readYangInstanceIdentifier();
 172     }
 173
 174     @Test
 175     public void testWithSerializable() {
 176         NormalizedNode<?, ?> input = TestModel.createTestContainer();
 177         SampleNormalizedNodeSerializable serializable = new SampleNormalizedNodeSerializable(input );
 178         SampleNormalizedNodeSerializable clone =
 179                 (SampleNormalizedNodeSerializable)SerializationUtils.clone(serializable);
 180
 181         Assert.assertEquals(input, clone.getInput());
 182
 183     }
 184
 185     @SuppressWarnings("deprecation")
 186     @Test
 187     public void testAnyXmlStreaming() throws Exception {
 188         String xml = "<foo xmlns=\"http://www.w3.org/TR/html4/\" x=\"123\"><bar>one</bar><bar>two</bar></foo>";
 189         final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 190         factory.setNamespaceAware(true);
 191
 192         Node xmlNode = factory.newDocumentBuilder().parse(
 193                 new InputSource(new StringReader(xml))).getDocumentElement();
 194
 195         assertEquals("http://www.w3.org/TR/html4/", xmlNode.getNamespaceURI());
 196
 197         NormalizedNode<?, ?> anyXmlContainer = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 198                 new YangInstanceIdentifier.NodeIdentifier(TestModel.TEST_QNAME)).withChild(
 199                         Builders.anyXmlBuilder().withNodeIdentifier(new NodeIdentifier(TestModel.ANY_XML_QNAME))
 200                             .withValue(new DOMSource(xmlNode)).build()).build();
 201
 202         ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
 203         NormalizedNodeOutputStreamWriter writer = new NormalizedNodeOutputStreamWriter(
 204             ByteStreams.newDataOutput(byteArrayOutputStream));
 205
 206         writer.writeNormalizedNode(anyXmlContainer);
 207
 208         NormalizedNodeInputStreamReader reader = new NormalizedNodeInputStreamReader(
 209                 ByteStreams.newDataInput(byteArrayOutputStream.toByteArray()));
 210
 211         ContainerNode deserialized = (ContainerNode)reader.readNormalizedNode();
 212
 213         Optional<DataContainerChild<? extends PathArgument, ?>> child =
 214                 deserialized.getChild(new NodeIdentifier(TestModel.ANY_XML_QNAME));
 215         assertEquals("AnyXml child present", true, child.isPresent());
 216
 217         StreamResult xmlOutput = new StreamResult(new StringWriter());
 218         Transformer transformer = TransformerFactory.newInstance().newTransformer();
 219         transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
 220         transformer.transform(((AnyXmlNode)child.get()).getValue(), xmlOutput);
 221
 222         assertEquals("XML", xml, xmlOutput.getWriter().toString());
 223         assertEquals("http://www.w3.org/TR/html4/", ((AnyXmlNode)child.get()).getValue().getNode().getNamespaceURI());
 224
 225         writer.close();
 226     }
 227
 228     private static String largeString(final int pow) {
 229         String str = "X";
 230         for (int i = 0; i < pow; i++) {
 231             StringBuilder buf = new StringBuilder();
 232             buf.append(str).append(str);
 233             str = buf.toString();
 234         }
 235         return str;
 236     }
 237 }