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