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