yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemalessXMLStreamNormalizedNodeStreamWriterTest.java

   1 /*
   2  * Copyright (c) 2016 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.yangtools.yang.data.codec.xml;
  10
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.io.IOException;
  14 import java.io.InputStream;
  15 import java.io.StringWriter;
  16 import java.net.URI;
  17 import java.util.ArrayList;
  18 import java.util.Collections;
  19 import java.util.HashMap;
  20 import java.util.List;
  21 import java.util.Map;
  22 import javax.xml.stream.XMLOutputFactory;
  23 import javax.xml.stream.XMLStreamException;
  24 import javax.xml.stream.XMLStreamWriter;
  25 import javax.xml.transform.OutputKeys;
  26 import javax.xml.transform.Transformer;
  27 import javax.xml.transform.TransformerException;
  28 import javax.xml.transform.TransformerFactory;
  29 import javax.xml.transform.TransformerFactoryConfigurationError;
  30 import javax.xml.transform.dom.DOMResult;
  31 import javax.xml.transform.dom.DOMSource;
  32 import javax.xml.transform.stream.StreamResult;
  33 import org.custommonkey.xmlunit.Diff;
  34 import org.custommonkey.xmlunit.DifferenceListener;
  35 import org.custommonkey.xmlunit.IgnoreTextAndAttributeValuesDifferenceListener;
  36 import org.custommonkey.xmlunit.XMLAssert;
  37 import org.custommonkey.xmlunit.XMLUnit;
  38 import org.junit.Before;
  39 import org.junit.Test;
  40 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  41 import org.opendaylight.yangtools.yang.common.QName;
  42 import org.opendaylight.yangtools.yang.common.QNameModule;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  47 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  58 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  59 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  60 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  62 import org.w3c.dom.Document;
  63 import org.w3c.dom.Node;
  64 import org.xml.sax.SAXException;
  65
  66 public class SchemalessXMLStreamNormalizedNodeStreamWriterTest {
  67
  68     private QNameModule foobarModule;
  69
  70     private QName outerContainer;
  71
  72     private QName myContainer1;
  73     private QName myKeyedList;
  74     private QName myKeyLeaf;
  75     private QName myLeafInList1;
  76     private QName myLeafInList2;
  77     private QName myOrderedList;
  78     private QName myKeyLeafInOrderedList;
  79     private QName myLeafInOrderedList1;
  80     private QName myLeafInOrderedList2;
  81     private QName myUnkeyedList;
  82     private QName myLeafInUnkeyedList;
  83     private QName myLeaf1;
  84     private QName myLeafList;
  85     private QName myOrderedLeafList;
  86
  87     private QName myContainer2;
  88     private QName innerContainer;
  89     private QName myLeaf2;
  90     private QName myLeaf3;
  91     private QName myChoice;
  92     private QName myLeafInCase2;
  93     private QName myAnyxml;
  94
  95     private QName myContainer3;
  96     private QName myDoublyKeyedList;
  97     private QName myFirstKeyLeaf;
  98     private QName mySecondKeyLeaf;
  99     private QName myLeafInList3;
 100
 101     private DOMSource anyxmlDomSource;
 102
 103     @Before
 104     public void setup() {
 105         foobarModule = QNameModule.create(URI.create("foobar-namespace"), QName.parseRevision("2016-09-19"));
 106
 107         outerContainer = QName.create(foobarModule, "outer-container");
 108
 109         myContainer1 = QName.create(foobarModule, "my-container-1");
 110         myKeyedList = QName.create(foobarModule, "my-keyed-list");
 111         myKeyLeaf = QName.create(foobarModule, "my-key-leaf");
 112         myLeafInList1 = QName.create(foobarModule, "my-leaf-in-list-1");
 113         myLeafInList2 = QName.create(foobarModule, "my-leaf-in-list-2");
 114         myOrderedList = QName.create(foobarModule, "my-ordered-list");
 115         myKeyLeafInOrderedList = QName.create(foobarModule, "my-key-leaf-in-ordered-list");
 116         myLeafInOrderedList1 = QName.create(foobarModule, "my-leaf-in-ordered-list-1");
 117         myLeafInOrderedList2 = QName.create(foobarModule, "my-leaf-in-ordered-list-2");
 118         myUnkeyedList = QName.create(foobarModule, "my-unkeyed-list");
 119         myLeafInUnkeyedList = QName.create(foobarModule, "my-leaf-in-unkeyed-list");
 120         myLeaf1 = QName.create(foobarModule, "my-leaf-1");
 121         myLeafList = QName.create(foobarModule, "my-leaf-list");
 122         myOrderedLeafList = QName.create(foobarModule, "my-ordered-leaf-list");
 123
 124         myContainer2 = QName.create(foobarModule, "my-container-2");
 125         innerContainer = QName.create(foobarModule, "inner-container");
 126         myLeaf2 = QName.create(foobarModule, "my-leaf-2");
 127         myLeaf3 = QName.create(foobarModule, "my-leaf-3");
 128         myChoice = QName.create(foobarModule, "my-choice");
 129         myLeafInCase2 = QName.create(foobarModule, "my-leaf-in-case-2");
 130         myAnyxml = QName.create(foobarModule, "my-anyxml");
 131
 132         myContainer3 = QName.create(foobarModule, "my-container-3");
 133         myDoublyKeyedList = QName.create(foobarModule, "my-doubly-keyed-list");
 134         myFirstKeyLeaf = QName.create(foobarModule, "my-first-key-leaf");
 135         mySecondKeyLeaf = QName.create(foobarModule, "my-second-key-leaf");
 136         myLeafInList3 = QName.create(foobarModule, "my-leaf-in-list-3");
 137
 138         anyxmlDomSource = new DOMSource();
 139     }
 140
 141     @Test
 142     public void testWrite() throws XMLStreamException, IOException, SAXException {
 143         final Document doc = loadDocument("/foobar.xml");
 144
 145         final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
 146
 147         final XMLOutputFactory factory = XMLOutputFactory.newInstance();
 148         factory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
 149
 150         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
 151
 152         final NormalizedNodeStreamWriter schemalessXmlNormalizedNodeStreamWriter =
 153                 XMLStreamNormalizedNodeStreamWriter.createSchemaless(xmlStreamWriter);
 154
 155         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 156                 schemalessXmlNormalizedNodeStreamWriter);
 157
 158         normalizedNodeWriter.write(buildOuterContainerNode());
 159
 160         XMLUnit.setIgnoreWhitespace(true);
 161         XMLUnit.setNormalize(true);
 162
 163         final String expectedXml = toString(doc.getDocumentElement());
 164         final String serializedXml = toString(domResult.getNode());
 165         final Diff diff = new Diff(expectedXml, serializedXml);
 166
 167         final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
 168         diff.overrideDifferenceListener(differenceListener);
 169
 170         XMLAssert.assertXMLEqual(diff, true);
 171     }
 172
 173     private NormalizedNode<?, ?> buildOuterContainerNode() {
 174         // my-container-1
 175         MapNode myKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myKeyedList))
 176                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 177                         new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue1"))
 178                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
 179                                 .withValue("listleafvalue1").build())
 180                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
 181                                 .withValue("listleafvalue2").build()).build())
 182                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 183                         new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue2"))
 184                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
 185                                 .withValue("listleafvalue12").build())
 186                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
 187                                 .withValue("listleafvalue22").build()).build()).build();
 188
 189         OrderedMapNode myOrderedListNode = Builders.orderedMapBuilder().withNodeIdentifier(
 190                 new NodeIdentifier(myOrderedList)).withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 191                         new NodeIdentifierWithPredicates(myOrderedList, myKeyLeafInOrderedList, "olistkeyvalue1"))
 192                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList1))
 193                                 .withValue("olistleafvalue1").build())
 194                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList2))
 195                                 .withValue("olistleafvalue2").build()).build())
 196                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 197                         new NodeIdentifierWithPredicates(myOrderedList, myKeyLeafInOrderedList, "olistkeyvalue2"))
 198                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList1))
 199                                 .withValue("olistleafvalue12").build())
 200                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList2))
 201                                 .withValue("olistleafvalue22").build()).build()).build();
 202
 203         final UnkeyedListEntryNode unkeyedListEntry = Builders.unkeyedListEntryBuilder()
 204                 .withNodeIdentifier(new NodeIdentifier(myUnkeyedList))
 205                 .withChild(ImmutableNodes.leafNode(myLeafInUnkeyedList, "foo")).build();
 206
 207         final List<UnkeyedListEntryNode> unkeyedListEntries = new ArrayList<>();
 208         unkeyedListEntries.add(unkeyedListEntry);
 209
 210         UnkeyedListNode myUnkeyedListNode = Builders.unkeyedListBuilder().withNodeIdentifier(
 211                 new NodeIdentifier(myUnkeyedList))
 212                 .withValue(unkeyedListEntries).build();
 213
 214         LeafNode<?> myLeaf1Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf1))
 215                 .withValue("value1").build();
 216
 217         LeafSetNode<?> myLeafListNode = Builders.leafSetBuilder().withNodeIdentifier(new NodeIdentifier(myLeafList))
 218                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 219                         new NodeWithValue<>(myLeafList, "lflvalue1")).withValue("lflvalue1").build())
 220                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 221                         new NodeWithValue<>(myLeafList, "lflvalue2")).withValue("lflvalue2").build()).build();
 222
 223         LeafSetNode<?> myOrderedLeafListNode = Builders.orderedLeafSetBuilder().withNodeIdentifier(
 224                 new NodeIdentifier(myOrderedLeafList))
 225                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 226                         new NodeWithValue<>(myOrderedLeafList, "olflvalue1")).withValue("olflvalue1").build())
 227                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 228                         new NodeWithValue<>(myOrderedLeafList, "olflvalue2")).withValue("olflvalue2").build()).build();
 229
 230         ContainerNode myContainer1Node = Builders.containerBuilder().withNodeIdentifier(
 231                 new NodeIdentifier(myContainer1))
 232                 .withChild(myKeyedListNode)
 233                 .withChild(myOrderedListNode)
 234                 .withChild(myUnkeyedListNode)
 235                 .withChild(myLeaf1Node)
 236                 .withChild(myLeafListNode)
 237                 .withChild(myOrderedLeafListNode)
 238                 .build();
 239
 240         // my-container-2
 241         ContainerNode innerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 242                 new NodeIdentifier(innerContainer))
 243                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf2))
 244                         .withValue("value2").build()).build();
 245
 246         LeafNode<?> myLeaf3Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf3))
 247                 .withValue("value3").build();
 248
 249         ChoiceNode myChoiceNode = Builders.choiceBuilder().withNodeIdentifier(new NodeIdentifier(myChoice))
 250                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInCase2))
 251                         .withValue("case2value").build()).build();
 252
 253         AnyXmlNode myAnyxmlNode = Builders.anyXmlBuilder().withNodeIdentifier(new NodeIdentifier(myAnyxml))
 254                 .withValue(anyxmlDomSource).build();
 255
 256         ContainerNode myContainer2Node = Builders.containerBuilder().withNodeIdentifier(
 257                 new NodeIdentifier(myContainer2))
 258                 .withChild(innerContainerNode)
 259                 .withChild(myLeaf3Node)
 260                 .withChild(myChoiceNode).build();
 261                 //.withChild(myAnyxmlNode).build();
 262
 263         // my-container-3
 264         Map<QName, Object> keys = new HashMap<>();
 265         keys.put(myFirstKeyLeaf, "listkeyvalue1");
 266         keys.put(mySecondKeyLeaf, "listkeyvalue2");
 267
 268         MapNode myDoublyKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myDoublyKeyedList))
 269                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 270                         new NodeIdentifierWithPredicates(myDoublyKeyedList, keys))
 271                         .withChild(Builders.leafBuilder().withNodeIdentifier(
 272                                 new NodeIdentifier(myLeafInList3)).withValue("listleafvalue1").build()).build())
 273                 .build();
 274
 275         AugmentationNode myDoublyKeyedListAugNode = Builders.augmentationBuilder().withNodeIdentifier(
 276                 new AugmentationIdentifier(Collections.singleton(myDoublyKeyedList)))
 277                 .withChild(myDoublyKeyedListNode).build();
 278
 279         ContainerNode myContainer3Node = Builders.containerBuilder().withNodeIdentifier(
 280                 new NodeIdentifier(myContainer3))
 281                 .withChild(myDoublyKeyedListAugNode).build();
 282
 283         AugmentationNode myContainer3AugNode = Builders.augmentationBuilder().withNodeIdentifier(
 284                 new AugmentationIdentifier(Collections.singleton(myContainer3)))
 285                 .withChild(myContainer3Node).build();
 286
 287         ContainerNode outerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 288                 new NodeIdentifier(outerContainer))
 289                 .withChild(myContainer1Node)
 290                 .withChild(myContainer2Node)
 291                 .withChild(myContainer3AugNode).build();
 292
 293         return outerContainerNode;
 294     }
 295
 296     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 297         final InputStream resourceAsStream = SchemalessXMLStreamNormalizedNodeStreamWriterTest.class
 298             .getResourceAsStream(xmlPath);
 299         return requireNonNull(readXmlToDocument(resourceAsStream));
 300     }
 301
 302     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 303         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 304         doc.getDocumentElement().normalize();
 305         return doc;
 306     }
 307
 308     private static String toString(final Node xml) {
 309         try {
 310             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 311             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 312             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 313
 314             final StreamResult result = new StreamResult(new StringWriter());
 315             final DOMSource source = new DOMSource(xml);
 316             transformer.transform(source, result);
 317
 318             return result.getWriter().toString();
 319         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 320             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 321         }
 322     }
 323 }