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