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