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