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