codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/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 package org.opendaylight.yangtools.yang.data.codec.binfmt;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertThrows;
  12
  13 import com.google.common.io.ByteStreams;
  14 import java.io.ByteArrayInputStream;
  15 import java.io.ByteArrayOutputStream;
  16 import java.io.IOException;
  17 import java.io.ObjectInputStream;
  18 import java.io.ObjectOutputStream;
  19 import java.io.Serializable;
  20 import java.io.StringReader;
  21 import java.io.StringWriter;
  22 import java.util.List;
  23 import javax.xml.parsers.DocumentBuilderFactory;
  24 import javax.xml.transform.OutputKeys;
  25 import javax.xml.transform.TransformerFactory;
  26 import javax.xml.transform.dom.DOMSource;
  27 import javax.xml.transform.stream.StreamResult;
  28 import org.junit.jupiter.api.Test;
  29 import org.junit.jupiter.params.ParameterizedTest;
  30 import org.junit.jupiter.params.provider.Arguments;
  31 import org.junit.jupiter.params.provider.MethodSource;
  32 import org.opendaylight.yangtools.yang.common.Empty;
  33 import org.opendaylight.yangtools.yang.common.QName;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  39 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  40 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  41 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  42 import org.xml.sax.InputSource;
  43
  44 class NormalizedNodeStreamReaderWriterTest {
  45     @ParameterizedTest
  46     @MethodSource
  47     void testNormalizedNodeStreaming(final NormalizedNodeStreamVersion version, final int size) throws Exception {
  48         final var bos = new ByteArrayOutputStream();
  49         final var nnout = version.newDataOutput(ByteStreams.newDataOutput(bos));
  50
  51         final var testContainer = createTestContainer();
  52         nnout.writeNormalizedNode(testContainer);
  53
  54         final var toaster = QName.create("http://netconfcentral.org/ns/toaster","2009-11-20","toaster");
  55         final var darknessFactor = QName.create("http://netconfcentral.org/ns/toaster","2009-11-20","darknessFactor");
  56         final var description = QName.create("http://netconfcentral.org/ns/toaster","2009-11-20","description");
  57         final var toasterNode = ImmutableNodes.newContainerBuilder().withNodeIdentifier(new NodeIdentifier(toaster))
  58                 .withChild(ImmutableNodes.leafNode(darknessFactor, "1000"))
  59                 .withChild(ImmutableNodes.leafNode(description, largeString(20))).build();
  60
  61         final var toasterContainer = ImmutableNodes.newContainerBuilder()
  62                 .withNodeIdentifier(new NodeIdentifier(SchemaContext.NAME)).withChild(toasterNode).build();
  63         nnout.writeNormalizedNode(toasterContainer);
  64
  65         final byte[] bytes = bos.toByteArray();
  66         assertEquals(size, bytes.length);
  67
  68         final var nnin = NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(bytes));
  69
  70         assertEquals(testContainer, nnin.readNormalizedNode());
  71         assertEquals(toasterContainer, nnin.readNormalizedNode());
  72     }
  73
  74     static List<Arguments> testNormalizedNodeStreaming() {
  75         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM, 1_049_587));
  76     }
  77
  78     private static ContainerNode createTestContainer() {
  79         final byte[] bytes1 = {1, 2, 3};
  80         final byte[] bytes2 = {};
  81
  82         return TestModel.createBaseTestContainerBuilder()
  83             .withChild(ImmutableNodes.newSystemLeafSetBuilder()
  84                 .withNodeIdentifier(new NodeIdentifier(TestModel.BINARY_LEAF_LIST_QNAME))
  85                 .withChild(ImmutableNodes.leafSetEntry(TestModel.BINARY_LEAF_LIST_QNAME, bytes1))
  86                 .withChild(ImmutableNodes.leafSetEntry(TestModel.BINARY_LEAF_LIST_QNAME, bytes2))
  87                 .build())
  88             .withChild(ImmutableNodes.leafNode(TestModel.SOME_BINARY_DATA_QNAME, new byte[]{1, 2, 3, 4}))
  89             .withChild(ImmutableNodes.leafNode(TestModel.EMPTY_QNAME, Empty.value()))
  90             .withChild(ImmutableNodes.newUserMapBuilder()
  91                 .withNodeIdentifier(new NodeIdentifier(TestModel.ORDERED_LIST_QNAME))
  92                 .withChild(ImmutableNodes.newMapEntryBuilder()
  93                     .withNodeIdentifier(
  94                         NodeIdentifierWithPredicates.of(TestModel.ORDERED_LIST_ENTRY_QNAME, TestModel.ID_QNAME, 11))
  95                     .withChild(ImmutableNodes.leafNode(TestModel.ID_QNAME, 11))
  96                     .build())
  97                 .build())
  98             .build();
  99     }
 100
 101     @ParameterizedTest
 102     @MethodSource
 103     void testYangInstanceIdentifierStreaming(final NormalizedNodeStreamVersion version, final int size)
 104             throws Exception {
 105         final var path = YangInstanceIdentifier.builder(TestModel.TEST_PATH).node(TestModel.OUTER_LIST_QNAME)
 106             .nodeWithKey(TestModel.INNER_LIST_QNAME, TestModel.ID_QNAME, 10).build();
 107
 108         final var bos = new ByteArrayOutputStream();
 109         final var nnout = version.newDataOutput(ByteStreams.newDataOutput(bos));
 110
 111         nnout.writeYangInstanceIdentifier(path);
 112
 113         final byte[] bytes = bos.toByteArray();
 114         assertEquals(size, bytes.length);
 115
 116         final var nnin = NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(bytes));
 117         assertEquals(path, nnin.readYangInstanceIdentifier());
 118     }
 119
 120     static List<Arguments> testYangInstanceIdentifierStreaming() {
 121         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM, 139));
 122     }
 123
 124     @ParameterizedTest
 125     @MethodSource
 126     void testNormalizedNodeAndYangInstanceIdentifierStreaming(final NormalizedNodeStreamVersion version, final int size)
 127             throws Exception {
 128         final var testContainer = TestModel.createBaseTestContainerBuilder().build();
 129         final var path = YangInstanceIdentifier.builder(TestModel.TEST_PATH)
 130             .node(TestModel.OUTER_LIST_QNAME)
 131             .nodeWithKey(TestModel.INNER_LIST_QNAME, TestModel.ID_QNAME, 10)
 132             .build();
 133
 134         final var bos = new ByteArrayOutputStream();
 135         try (var writer = version.newDataOutput(ByteStreams.newDataOutput(bos))) {
 136             writer.writeNormalizedNode(testContainer);
 137             writer.writeYangInstanceIdentifier(path);
 138         }
 139
 140         final byte[] bytes = bos.toByteArray();
 141         assertEquals(size, bytes.length);
 142
 143         final var reader = NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(bytes));
 144         assertEquals(testContainer, reader.readNormalizedNode());
 145         assertEquals(path, reader.readYangInstanceIdentifier());
 146     }
 147
 148     static List<Arguments> testNormalizedNodeAndYangInstanceIdentifierStreaming() {
 149         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM, 794));
 150     }
 151
 152     @Test
 153     void testInvalidNormalizedNodeStream() {
 154         final var ex = assertThrows(InvalidNormalizedNodeStreamException.class,
 155             () -> NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(new byte[] { 1, 2, 3})));
 156         assertEquals("Invalid signature marker: 1", ex.getMessage());
 157     }
 158
 159     @ParameterizedTest
 160     @MethodSource
 161     void testWithSerializable(final NormalizedNodeStreamVersion version) {
 162         var input = TestModel.createTestContainer();
 163         var serializable = new SampleNormalizedNodeSerializable(version, input);
 164         var clone = clone(serializable);
 165         assertEquals(input, clone.getInput());
 166     }
 167
 168     static List<Arguments> testWithSerializable() {
 169         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM));
 170     }
 171
 172     @ParameterizedTest
 173     @MethodSource
 174     void testAnyXmlStreaming(final NormalizedNodeStreamVersion version, final int size) throws Exception {
 175         var xml = "<foo xmlns=\"http://www.w3.org/TR/html4/\" x=\"123\"><bar>one</bar><bar>two</bar></foo>";
 176         final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 177         factory.setNamespaceAware(true);
 178
 179         final var xmlNode = factory.newDocumentBuilder().parse(
 180                 new InputSource(new StringReader(xml))).getDocumentElement();
 181
 182         assertEquals("http://www.w3.org/TR/html4/", xmlNode.getNamespaceURI());
 183
 184         final var anyXmlContainer = ImmutableNodes.newContainerBuilder()
 185             .withNodeIdentifier(new NodeIdentifier(TestModel.TEST_QNAME))
 186             .withChild(ImmutableNodes.newAnyxmlBuilder(DOMSource.class)
 187                 .withNodeIdentifier(new NodeIdentifier(TestModel.ANY_XML_QNAME))
 188                 .withValue(new DOMSource(xmlNode))
 189                 .build())
 190             .build();
 191
 192         final var bos = new ByteArrayOutputStream();
 193         final var nnout = version.newDataOutput(ByteStreams.newDataOutput(bos));
 194
 195         nnout.writeNormalizedNode(anyXmlContainer);
 196
 197         final byte[] bytes = bos.toByteArray();
 198         assertEquals(size, bytes.length);
 199
 200         final var nnin = NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(bytes));
 201
 202         final var deserialized = (ContainerNode)nnin.readNormalizedNode();
 203
 204         final var child = deserialized.findChildByArg(new NodeIdentifier(TestModel.ANY_XML_QNAME));
 205         assertEquals("AnyXml child present", true, child.isPresent());
 206
 207         final var xmlOutput = new StreamResult(new StringWriter());
 208         final var transformer = TransformerFactory.newInstance().newTransformer();
 209         transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
 210         transformer.transform(((DOMSourceAnyxmlNode)child.orElseThrow()).body(), xmlOutput);
 211
 212         assertEquals("XML", xml, xmlOutput.getWriter().toString());
 213         assertEquals("http://www.w3.org/TR/html4/",
 214             ((DOMSourceAnyxmlNode)child.orElseThrow()).body().getNode().getNamespaceURI());
 215     }
 216
 217     static List<Arguments> testAnyXmlStreaming() {
 218         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM, 229));
 219     }
 220
 221     @ParameterizedTest
 222     @MethodSource
 223     void testSchemaPathSerialization(final NormalizedNodeStreamVersion version, final int size) throws Exception {
 224         final var expected = Absolute.of(TestModel.ANY_XML_QNAME);
 225
 226         final var bos = new ByteArrayOutputStream();
 227         try (var nnout = version.newDataOutput(ByteStreams.newDataOutput(bos))) {
 228             nnout.writeSchemaNodeIdentifier(expected);
 229         }
 230
 231         final byte[] bytes = bos.toByteArray();
 232         assertEquals(size, bytes.length);
 233
 234         var nnin = NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(bytes));
 235         assertEquals(expected, nnin.readSchemaNodeIdentifier());
 236     }
 237
 238     static List<Arguments> testSchemaPathSerialization() {
 239         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM, 99));
 240     }
 241
 242     @ParameterizedTest
 243     @MethodSource
 244     void testWritePathArgument(final NormalizedNodeStreamVersion version, final int size) throws Exception {
 245         final var expected = new NodeIdentifier(TestModel.BOOLEAN_LEAF_QNAME);
 246         final var bos = new ByteArrayOutputStream();
 247         try (var nnout = version.newDataOutput(ByteStreams.newDataOutput(bos))) {
 248             nnout.writePathArgument(expected);
 249         }
 250
 251         final byte[] bytes = bos.toByteArray();
 252         assertEquals(size, bytes.length);
 253
 254         final var nnin = NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(bytes));
 255         assertEquals(expected, nnin.readPathArgument());
 256     }
 257
 258     static List<Arguments> testWritePathArgument() {
 259         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM, 103));
 260     }
 261
 262     /*
 263      * This tests the encoding of a MapNode with a lot of entries, each of them having the key leaf (a string)
 264      * and an integer.
 265      */
 266     @ParameterizedTest
 267     @MethodSource
 268     void testHugeEntries(final NormalizedNodeStreamVersion version, final int size) throws Exception {
 269         final var mapBuilder = ImmutableNodes.newSystemMapBuilder()
 270             .withNodeIdentifier(new NodeIdentifier(TestModel.TEST_QNAME));
 271         final var entryBuilder = ImmutableNodes.newMapEntryBuilder()
 272             .withChild(ImmutableNodes.leafNode(TestModel.DESC_QNAME, (byte) 42));
 273
 274         for (int i = 0; i < 100_000; ++i) {
 275             final String key = "xyzzy" + i;
 276             mapBuilder.addChild(entryBuilder
 277                 .withNodeIdentifier(NodeIdentifierWithPredicates.of(TestModel.TEST_QNAME,
 278                     TestModel.CHILD_NAME_QNAME, key))
 279                 .withChild(ImmutableNodes.leafNode(TestModel.CHILD_NAME_QNAME, key))
 280                 .build());
 281         }
 282
 283         final var expected = mapBuilder.build();
 284         final var bos = new ByteArrayOutputStream();
 285
 286         try (var nnout = version.newDataOutput(ByteStreams.newDataOutput(bos))) {
 287             nnout.writeNormalizedNode(expected);
 288         }
 289
 290         final byte[] bytes = bos.toByteArray();
 291         assertEquals(size, bytes.length);
 292
 293         var nnin = NormalizedNodeDataInput.newDataInput(ByteStreams.newDataInput(bytes));
 294         assertEquals(expected, nnin.readNormalizedNode());
 295     }
 296
 297     static List<Arguments> testHugeEntries() {
 298         return List.of(Arguments.of(NormalizedNodeStreamVersion.POTASSIUM, 2_289_103));
 299     }
 300
 301     private static <T extends Serializable> T clone(final T obj) {
 302         final var baos = new ByteArrayOutputStream(512);
 303         try (var oos = new ObjectOutputStream(baos)) {
 304             oos.writeObject(obj);
 305         } catch (IOException e) {
 306             throw new AssertionError("Failed to serialize object", e);
 307         }
 308
 309         final byte[] bytes = baos.toByteArray();
 310         try (var ois = new ObjectInputStream(new ByteArrayInputStream(bytes))) {
 311             return (T) ois.readObject();
 312         } catch (ClassNotFoundException | IOException e) {
 313             throw new AssertionError("Failed to deserialize object", e);
 314         }
 315     }
 316
 317     private static String largeString(final int pow) {
 318         final var sb = new StringBuilder("X");
 319         for (int i = 0; i < pow; i++) {
 320             sb.append(sb);
 321         }
 322         return sb.toString();
 323     }
 324 }