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