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