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.net.URISyntaxException;
  18 import java.text.ParseException;
  19 import java.util.Collections;
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import javax.xml.stream.XMLOutputFactory;
  23 import javax.xml.stream.XMLStreamException;
  24 import javax.xml.stream.XMLStreamWriter;
  25 import javax.xml.transform.OutputKeys;
  26 import javax.xml.transform.Transformer;
  27 import javax.xml.transform.TransformerException;
  28 import javax.xml.transform.TransformerFactory;
  29 import javax.xml.transform.TransformerFactoryConfigurationError;
  30 import javax.xml.transform.dom.DOMResult;
  31 import javax.xml.transform.dom.DOMSource;
  32 import javax.xml.transform.stream.StreamResult;
  33 import org.custommonkey.xmlunit.Diff;
  34 import org.custommonkey.xmlunit.DifferenceListener;
  35 import org.custommonkey.xmlunit.IgnoreTextAndAttributeValuesDifferenceListener;
  36 import org.custommonkey.xmlunit.XMLTestCase;
  37 import org.custommonkey.xmlunit.XMLUnit;
  38 import org.junit.Before;
  39 import org.junit.Test;
  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.SimpleDateFormatUtil;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  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.AugmentationNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  56 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  58 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  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 XMLStreamException, IOException, SAXException {
 122         final SchemaContext schemaContext = YangParserTestUtils.parseYangResource("/baz.yang");
 123
 124         final Document doc = loadDocument("/baz.xml");
 125
 126         final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
 127
 128         final XMLOutputFactory factory = XMLOutputFactory.newInstance();
 129         factory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
 130
 131         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
 132
 133         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
 134                 xmlStreamWriter, schemaContext);
 135
 136         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 137                 xmlNormalizedNodeStreamWriter);
 138
 139         normalizedNodeWriter.write(buildOuterContainerNode());
 140
 141         XMLUnit.setIgnoreWhitespace(true);
 142         XMLUnit.setNormalize(true);
 143
 144         final String expectedXml = toString(doc.getDocumentElement());
 145         final String serializedXml = toString(domResult.getNode());
 146         final Diff diff = new Diff(expectedXml, serializedXml);
 147
 148         final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
 149         diff.overrideDifferenceListener(differenceListener);
 150
 151         new XMLTestCase() {}.assertXMLEqual(diff, true);
 152     }
 153
 154     private NormalizedNode<?, ?> buildOuterContainerNode() {
 155         // my-container-1
 156         MapNode myKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myKeyedList))
 157                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 158                         new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue1"))
 159                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
 160                                 .withValue("listleafvalue1").build())
 161                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
 162                                 .withValue("listleafvalue2").build()).build())
 163                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 164                         new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue2"))
 165                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
 166                                 .withValue("listleafvalue12").build())
 167                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
 168                                 .withValue("listleafvalue22").build()).build()).build();
 169
 170         LeafNode<?> myLeaf1Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf1))
 171                 .withValue("value1").build();
 172
 173         LeafSetNode<?> myLeafListNode = Builders.leafSetBuilder().withNodeIdentifier(new NodeIdentifier(myLeafList))
 174                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 175                         new NodeWithValue<>(myLeafList, "lflvalue1")).withValue("lflvalue1").build())
 176                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 177                         new NodeWithValue<>(myLeafList, "lflvalue2")).withValue("lflvalue2").build()).build();
 178
 179         ContainerNode myContainer1Node = Builders.containerBuilder().withNodeIdentifier(
 180                 new NodeIdentifier(myContainer1))
 181                 .withChild(myKeyedListNode)
 182                 .withChild(myLeaf1Node)
 183                 .withChild(myLeafListNode).build();
 184
 185         // my-container-2
 186         ContainerNode innerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 187                 new NodeIdentifier(innerContainer))
 188                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf2))
 189                         .withValue("value2").build()).build();
 190
 191         LeafNode<?> myLeaf3Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf3))
 192                 .withValue("value3").build();
 193
 194         ChoiceNode myChoiceNode = Builders.choiceBuilder().withNodeIdentifier(new NodeIdentifier(myChoice))
 195                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInCase2))
 196                         .withValue("case2value").build()).build();
 197
 198         ContainerNode myContainer2Node = Builders.containerBuilder().withNodeIdentifier(
 199                 new NodeIdentifier(myContainer2))
 200                 .withChild(innerContainerNode)
 201                 .withChild(myLeaf3Node)
 202                 .withChild(myChoiceNode).build();
 203
 204         // my-container-3
 205         Map<QName, Object> keys = new HashMap<>();
 206         keys.put(myFirstKeyLeaf, "listkeyvalue1");
 207         keys.put(mySecondKeyLeaf, "listkeyvalue2");
 208
 209         MapNode myDoublyKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myDoublyKeyedList))
 210                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 211                         new NodeIdentifierWithPredicates(myDoublyKeyedList, keys))
 212                         .withChild(Builders.leafBuilder().withNodeIdentifier(
 213                                 new NodeIdentifier(myLeafInList3)).withValue("listleafvalue1").build()).build())
 214                 .build();
 215
 216         AugmentationNode myDoublyKeyedListAugNode = Builders.augmentationBuilder().withNodeIdentifier(
 217                 new AugmentationIdentifier(Collections.singleton(myDoublyKeyedList)))
 218                 .withChild(myDoublyKeyedListNode).build();
 219
 220         ContainerNode myContainer3Node = Builders.containerBuilder().withNodeIdentifier(
 221                 new NodeIdentifier(myContainer3))
 222                 .withChild(myDoublyKeyedListAugNode).build();
 223
 224         AugmentationNode myContainer3AugNode = Builders.augmentationBuilder().withNodeIdentifier(
 225                 new AugmentationIdentifier(Collections.singleton(myContainer3)))
 226                 .withChild(myContainer3Node).build();
 227
 228         ContainerNode outerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 229                 new NodeIdentifier(outerContainer))
 230                 .withChild(myContainer1Node)
 231                 .withChild(myContainer2Node)
 232                 .withChild(myContainer3AugNode).build();
 233
 234         return outerContainerNode;
 235     }
 236
 237     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 238         final InputStream resourceAsStream = NormalizedNodesToXmlTest.class.getResourceAsStream(xmlPath);
 239         return requireNonNull(readXmlToDocument(resourceAsStream));
 240     }
 241
 242     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 243         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 244         doc.getDocumentElement().normalize();
 245         return doc;
 246     }
 247
 248     private static String toString(final Node xml) {
 249         try {
 250             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 251             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 252             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 253
 254             final StreamResult result = new StreamResult(new StringWriter());
 255             final DOMSource source = new DOMSource(xml);
 256             transformer.transform(source, result);
 257
 258             return result.getWriter().toString();
 259         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 260             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 261         }
 262     }
 263 }