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