yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/NormalizedNodesToXmlTest.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.Collections;
  18 import java.util.HashMap;
  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.XMLTestCase;
  35 import org.custommonkey.xmlunit.XMLUnit;
  36 import org.junit.Before;
  37 import org.junit.Test;
  38 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  39 import org.opendaylight.yangtools.yang.common.QName;
  40 import org.opendaylight.yangtools.yang.common.QNameModule;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  45 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  53 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  55 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  56 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  57 import org.w3c.dom.Document;
  58 import org.w3c.dom.Node;
  59 import org.xml.sax.SAXException;
  60
  61 public class NormalizedNodesToXmlTest {
  62
  63     private QNameModule bazModule;
  64
  65     private QName outerContainer;
  66
  67     private QName myContainer1;
  68     private QName myKeyedList;
  69     private QName myKeyLeaf;
  70     private QName myLeafInList1;
  71     private QName myLeafInList2;
  72     private QName myLeaf1;
  73     private QName myLeafList;
  74
  75     private QName myContainer2;
  76     private QName innerContainer;
  77     private QName myLeaf2;
  78     private QName myLeaf3;
  79     private QName myChoice;
  80     private QName myLeafInCase2;
  81
  82     private QName myContainer3;
  83     private QName myDoublyKeyedList;
  84     private QName myFirstKeyLeaf;
  85     private QName mySecondKeyLeaf;
  86     private QName myLeafInList3;
  87
  88     @Before
  89     public void setup() {
  90         bazModule = QNameModule.create(URI.create("baz-namespace"), QName.parseRevision("1970-01-01"));
  91
  92         outerContainer = QName.create(bazModule, "outer-container");
  93
  94         myContainer1 = QName.create(bazModule, "my-container-1");
  95         myKeyedList = QName.create(bazModule, "my-keyed-list");
  96         myKeyLeaf = QName.create(bazModule, "my-key-leaf");
  97         myLeafInList1 = QName.create(bazModule, "my-leaf-in-list-1");
  98         myLeafInList2 = QName.create(bazModule, "my-leaf-in-list-2");
  99         myLeaf1 = QName.create(bazModule, "my-leaf-1");
 100         myLeafList = QName.create(bazModule, "my-leaf-list");
 101
 102         myContainer2 = QName.create(bazModule, "my-container-2");
 103         innerContainer = QName.create(bazModule, "inner-container");
 104         myLeaf2 = QName.create(bazModule, "my-leaf-2");
 105         myLeaf3 = QName.create(bazModule, "my-leaf-3");
 106         myChoice = QName.create(bazModule, "my-choice");
 107         myLeafInCase2 = QName.create(bazModule, "my-leaf-in-case-2");
 108
 109         myContainer3 = QName.create(bazModule, "my-container-3");
 110         myDoublyKeyedList = QName.create(bazModule, "my-doubly-keyed-list");
 111         myFirstKeyLeaf = QName.create(bazModule, "my-first-key-leaf");
 112         mySecondKeyLeaf = QName.create(bazModule, "my-second-key-leaf");
 113         myLeafInList3 = QName.create(bazModule, "my-leaf-in-list-3");
 114     }
 115
 116     @Test
 117     public void testNormalizedNodeToXmlSerialization() throws XMLStreamException, IOException, SAXException {
 118         final SchemaContext schemaContext = YangParserTestUtils.parseYangResource("/baz.yang");
 119
 120         final Document doc = loadDocument("/baz.xml");
 121
 122         final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
 123
 124         final XMLOutputFactory factory = XMLOutputFactory.newInstance();
 125         factory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
 126
 127         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
 128
 129         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
 130                 xmlStreamWriter, schemaContext);
 131
 132         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 133                 xmlNormalizedNodeStreamWriter);
 134
 135         normalizedNodeWriter.write(buildOuterContainerNode());
 136
 137         XMLUnit.setIgnoreWhitespace(true);
 138         XMLUnit.setNormalize(true);
 139
 140         final String expectedXml = toString(doc.getDocumentElement());
 141         final String serializedXml = toString(domResult.getNode());
 142         final Diff diff = new Diff(expectedXml, serializedXml);
 143
 144         final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
 145         diff.overrideDifferenceListener(differenceListener);
 146
 147         new XMLTestCase() {}.assertXMLEqual(diff, true);
 148     }
 149
 150     private NormalizedNode<?, ?> buildOuterContainerNode() {
 151         // my-container-1
 152         MapNode myKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myKeyedList))
 153                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 154                         new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue1"))
 155                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
 156                                 .withValue("listleafvalue1").build())
 157                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
 158                                 .withValue("listleafvalue2").build()).build())
 159                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 160                         new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue2"))
 161                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
 162                                 .withValue("listleafvalue12").build())
 163                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
 164                                 .withValue("listleafvalue22").build()).build()).build();
 165
 166         LeafNode<?> myLeaf1Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf1))
 167                 .withValue("value1").build();
 168
 169         LeafSetNode<?> myLeafListNode = Builders.leafSetBuilder().withNodeIdentifier(new NodeIdentifier(myLeafList))
 170                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 171                         new NodeWithValue<>(myLeafList, "lflvalue1")).withValue("lflvalue1").build())
 172                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 173                         new NodeWithValue<>(myLeafList, "lflvalue2")).withValue("lflvalue2").build()).build();
 174
 175         ContainerNode myContainer1Node = Builders.containerBuilder().withNodeIdentifier(
 176                 new NodeIdentifier(myContainer1))
 177                 .withChild(myKeyedListNode)
 178                 .withChild(myLeaf1Node)
 179                 .withChild(myLeafListNode).build();
 180
 181         // my-container-2
 182         ContainerNode innerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 183                 new NodeIdentifier(innerContainer))
 184                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf2))
 185                         .withValue("value2").build()).build();
 186
 187         LeafNode<?> myLeaf3Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf3))
 188                 .withValue("value3").build();
 189
 190         ChoiceNode myChoiceNode = Builders.choiceBuilder().withNodeIdentifier(new NodeIdentifier(myChoice))
 191                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInCase2))
 192                         .withValue("case2value").build()).build();
 193
 194         ContainerNode myContainer2Node = Builders.containerBuilder().withNodeIdentifier(
 195                 new NodeIdentifier(myContainer2))
 196                 .withChild(innerContainerNode)
 197                 .withChild(myLeaf3Node)
 198                 .withChild(myChoiceNode).build();
 199
 200         // my-container-3
 201         Map<QName, Object> keys = new HashMap<>();
 202         keys.put(myFirstKeyLeaf, "listkeyvalue1");
 203         keys.put(mySecondKeyLeaf, "listkeyvalue2");
 204
 205         MapNode myDoublyKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myDoublyKeyedList))
 206                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 207                         new NodeIdentifierWithPredicates(myDoublyKeyedList, keys))
 208                         .withChild(Builders.leafBuilder().withNodeIdentifier(
 209                                 new NodeIdentifier(myLeafInList3)).withValue("listleafvalue1").build()).build())
 210                 .build();
 211
 212         AugmentationNode myDoublyKeyedListAugNode = Builders.augmentationBuilder().withNodeIdentifier(
 213                 new AugmentationIdentifier(Collections.singleton(myDoublyKeyedList)))
 214                 .withChild(myDoublyKeyedListNode).build();
 215
 216         ContainerNode myContainer3Node = Builders.containerBuilder().withNodeIdentifier(
 217                 new NodeIdentifier(myContainer3))
 218                 .withChild(myDoublyKeyedListAugNode).build();
 219
 220         AugmentationNode myContainer3AugNode = Builders.augmentationBuilder().withNodeIdentifier(
 221                 new AugmentationIdentifier(Collections.singleton(myContainer3)))
 222                 .withChild(myContainer3Node).build();
 223
 224         ContainerNode outerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 225                 new NodeIdentifier(outerContainer))
 226                 .withChild(myContainer1Node)
 227                 .withChild(myContainer2Node)
 228                 .withChild(myContainer3AugNode).build();
 229
 230         return outerContainerNode;
 231     }
 232
 233     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 234         final InputStream resourceAsStream = NormalizedNodesToXmlTest.class.getResourceAsStream(xmlPath);
 235         return requireNonNull(readXmlToDocument(resourceAsStream));
 236     }
 237
 238     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 239         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 240         doc.getDocumentElement().normalize();
 241         return doc;
 242     }
 243
 244     private static String toString(final Node xml) {
 245         try {
 246             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 247             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 248             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 249
 250             final StreamResult result = new StreamResult(new StringWriter());
 251             final DOMSource source = new DOMSource(xml);
 252             transformer.transform(source, result);
 253
 254             return result.getWriter().toString();
 255         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 256             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 257         }
 258     }
 259 }