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