2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.yangtools.yang.data.codec.xml;
11 import static java.util.Objects.requireNonNull;
13 import java.io.IOException;
14 import java.io.InputStream;
15 import java.io.StringWriter;
17 import java.util.ArrayList;
18 import java.util.Collections;
19 import java.util.HashMap;
20 import java.util.List;
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.XMLAssert;
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.Revision;
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.AnyXmlNode;
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.OrderedMapNode;
57 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
59 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
60 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
61 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
62 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
63 import org.w3c.dom.Document;
64 import org.w3c.dom.Node;
65 import org.xml.sax.SAXException;
67 public class SchemalessXMLStreamNormalizedNodeStreamWriterTest {
69 private QNameModule foobarModule;
71 private QName outerContainer;
73 private QName myContainer1;
74 private QName myKeyedList;
75 private QName myKeyLeaf;
76 private QName myLeafInList1;
77 private QName myLeafInList2;
78 private QName myOrderedList;
79 private QName myKeyLeafInOrderedList;
80 private QName myLeafInOrderedList1;
81 private QName myLeafInOrderedList2;
82 private QName myUnkeyedList;
83 private QName myLeafInUnkeyedList;
84 private QName myLeaf1;
85 private QName myLeafList;
86 private QName myOrderedLeafList;
88 private QName myContainer2;
89 private QName innerContainer;
90 private QName myLeaf2;
91 private QName myLeaf3;
92 private QName myChoice;
93 private QName myLeafInCase2;
94 private QName myAnyxml;
96 private QName myContainer3;
97 private QName myDoublyKeyedList;
98 private QName myFirstKeyLeaf;
99 private QName mySecondKeyLeaf;
100 private QName myLeafInList3;
102 private DOMSource anyxmlDomSource;
105 public void setup() {
106 foobarModule = QNameModule.create(URI.create("foobar-namespace"), Revision.valueOf("2016-09-19"));
108 outerContainer = QName.create(foobarModule, "outer-container");
110 myContainer1 = QName.create(foobarModule, "my-container-1");
111 myKeyedList = QName.create(foobarModule, "my-keyed-list");
112 myKeyLeaf = QName.create(foobarModule, "my-key-leaf");
113 myLeafInList1 = QName.create(foobarModule, "my-leaf-in-list-1");
114 myLeafInList2 = QName.create(foobarModule, "my-leaf-in-list-2");
115 myOrderedList = QName.create(foobarModule, "my-ordered-list");
116 myKeyLeafInOrderedList = QName.create(foobarModule, "my-key-leaf-in-ordered-list");
117 myLeafInOrderedList1 = QName.create(foobarModule, "my-leaf-in-ordered-list-1");
118 myLeafInOrderedList2 = QName.create(foobarModule, "my-leaf-in-ordered-list-2");
119 myUnkeyedList = QName.create(foobarModule, "my-unkeyed-list");
120 myLeafInUnkeyedList = QName.create(foobarModule, "my-leaf-in-unkeyed-list");
121 myLeaf1 = QName.create(foobarModule, "my-leaf-1");
122 myLeafList = QName.create(foobarModule, "my-leaf-list");
123 myOrderedLeafList = QName.create(foobarModule, "my-ordered-leaf-list");
125 myContainer2 = QName.create(foobarModule, "my-container-2");
126 innerContainer = QName.create(foobarModule, "inner-container");
127 myLeaf2 = QName.create(foobarModule, "my-leaf-2");
128 myLeaf3 = QName.create(foobarModule, "my-leaf-3");
129 myChoice = QName.create(foobarModule, "my-choice");
130 myLeafInCase2 = QName.create(foobarModule, "my-leaf-in-case-2");
131 myAnyxml = QName.create(foobarModule, "my-anyxml");
133 myContainer3 = QName.create(foobarModule, "my-container-3");
134 myDoublyKeyedList = QName.create(foobarModule, "my-doubly-keyed-list");
135 myFirstKeyLeaf = QName.create(foobarModule, "my-first-key-leaf");
136 mySecondKeyLeaf = QName.create(foobarModule, "my-second-key-leaf");
137 myLeafInList3 = QName.create(foobarModule, "my-leaf-in-list-3");
139 anyxmlDomSource = new DOMSource();
143 public void testWrite() throws XMLStreamException, IOException, SAXException {
144 final Document doc = loadDocument("/foobar.xml");
146 final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
148 final XMLOutputFactory factory = XMLOutputFactory.newInstance();
149 factory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
151 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
153 final NormalizedNodeStreamWriter schemalessXmlNormalizedNodeStreamWriter =
154 XMLStreamNormalizedNodeStreamWriter.createSchemaless(xmlStreamWriter);
156 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
157 schemalessXmlNormalizedNodeStreamWriter);
159 normalizedNodeWriter.write(buildOuterContainerNode());
161 XMLUnit.setIgnoreWhitespace(true);
162 XMLUnit.setNormalize(true);
164 final String expectedXml = toString(doc.getDocumentElement());
165 final String serializedXml = toString(domResult.getNode());
166 final Diff diff = new Diff(expectedXml, serializedXml);
168 final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
169 diff.overrideDifferenceListener(differenceListener);
171 XMLAssert.assertXMLEqual(diff, true);
174 private NormalizedNode<?, ?> buildOuterContainerNode() {
176 MapNode myKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myKeyedList))
177 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
178 new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue1"))
179 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
180 .withValue("listleafvalue1").build())
181 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
182 .withValue("listleafvalue2").build()).build())
183 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
184 new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue2"))
185 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
186 .withValue("listleafvalue12").build())
187 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
188 .withValue("listleafvalue22").build()).build()).build();
190 OrderedMapNode myOrderedListNode = Builders.orderedMapBuilder().withNodeIdentifier(
191 new NodeIdentifier(myOrderedList)).withChild(Builders.mapEntryBuilder().withNodeIdentifier(
192 new NodeIdentifierWithPredicates(myOrderedList, myKeyLeafInOrderedList, "olistkeyvalue1"))
193 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList1))
194 .withValue("olistleafvalue1").build())
195 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList2))
196 .withValue("olistleafvalue2").build()).build())
197 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
198 new NodeIdentifierWithPredicates(myOrderedList, myKeyLeafInOrderedList, "olistkeyvalue2"))
199 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList1))
200 .withValue("olistleafvalue12").build())
201 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList2))
202 .withValue("olistleafvalue22").build()).build()).build();
204 final UnkeyedListEntryNode unkeyedListEntry = Builders.unkeyedListEntryBuilder()
205 .withNodeIdentifier(new NodeIdentifier(myUnkeyedList))
206 .withChild(ImmutableNodes.leafNode(myLeafInUnkeyedList, "foo")).build();
208 final List<UnkeyedListEntryNode> unkeyedListEntries = new ArrayList<>();
209 unkeyedListEntries.add(unkeyedListEntry);
211 UnkeyedListNode myUnkeyedListNode = Builders.unkeyedListBuilder().withNodeIdentifier(
212 new NodeIdentifier(myUnkeyedList))
213 .withValue(unkeyedListEntries).build();
215 LeafNode<?> myLeaf1Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf1))
216 .withValue("value1").build();
218 LeafSetNode<?> myLeafListNode = Builders.leafSetBuilder().withNodeIdentifier(new NodeIdentifier(myLeafList))
219 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
220 new NodeWithValue<>(myLeafList, "lflvalue1")).withValue("lflvalue1").build())
221 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
222 new NodeWithValue<>(myLeafList, "lflvalue2")).withValue("lflvalue2").build()).build();
224 LeafSetNode<?> myOrderedLeafListNode = Builders.orderedLeafSetBuilder().withNodeIdentifier(
225 new NodeIdentifier(myOrderedLeafList))
226 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
227 new NodeWithValue<>(myOrderedLeafList, "olflvalue1")).withValue("olflvalue1").build())
228 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
229 new NodeWithValue<>(myOrderedLeafList, "olflvalue2")).withValue("olflvalue2").build()).build();
231 ContainerNode myContainer1Node = Builders.containerBuilder().withNodeIdentifier(
232 new NodeIdentifier(myContainer1))
233 .withChild(myKeyedListNode)
234 .withChild(myOrderedListNode)
235 .withChild(myUnkeyedListNode)
236 .withChild(myLeaf1Node)
237 .withChild(myLeafListNode)
238 .withChild(myOrderedLeafListNode)
242 ContainerNode innerContainerNode = Builders.containerBuilder().withNodeIdentifier(
243 new NodeIdentifier(innerContainer))
244 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf2))
245 .withValue("value2").build()).build();
247 LeafNode<?> myLeaf3Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf3))
248 .withValue("value3").build();
250 ChoiceNode myChoiceNode = Builders.choiceBuilder().withNodeIdentifier(new NodeIdentifier(myChoice))
251 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInCase2))
252 .withValue("case2value").build()).build();
254 AnyXmlNode myAnyxmlNode = Builders.anyXmlBuilder().withNodeIdentifier(new NodeIdentifier(myAnyxml))
255 .withValue(anyxmlDomSource).build();
257 ContainerNode myContainer2Node = Builders.containerBuilder().withNodeIdentifier(
258 new NodeIdentifier(myContainer2))
259 .withChild(innerContainerNode)
260 .withChild(myLeaf3Node)
261 .withChild(myChoiceNode).build();
262 //.withChild(myAnyxmlNode).build();
265 Map<QName, Object> keys = new HashMap<>();
266 keys.put(myFirstKeyLeaf, "listkeyvalue1");
267 keys.put(mySecondKeyLeaf, "listkeyvalue2");
269 MapNode myDoublyKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myDoublyKeyedList))
270 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
271 new NodeIdentifierWithPredicates(myDoublyKeyedList, keys))
272 .withChild(Builders.leafBuilder().withNodeIdentifier(
273 new NodeIdentifier(myLeafInList3)).withValue("listleafvalue1").build()).build())
276 AugmentationNode myDoublyKeyedListAugNode = Builders.augmentationBuilder().withNodeIdentifier(
277 new AugmentationIdentifier(Collections.singleton(myDoublyKeyedList)))
278 .withChild(myDoublyKeyedListNode).build();
280 ContainerNode myContainer3Node = Builders.containerBuilder().withNodeIdentifier(
281 new NodeIdentifier(myContainer3))
282 .withChild(myDoublyKeyedListAugNode).build();
284 AugmentationNode myContainer3AugNode = Builders.augmentationBuilder().withNodeIdentifier(
285 new AugmentationIdentifier(Collections.singleton(myContainer3)))
286 .withChild(myContainer3Node).build();
288 ContainerNode outerContainerNode = Builders.containerBuilder().withNodeIdentifier(
289 new NodeIdentifier(outerContainer))
290 .withChild(myContainer1Node)
291 .withChild(myContainer2Node)
292 .withChild(myContainer3AugNode).build();
294 return outerContainerNode;
297 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
298 final InputStream resourceAsStream = SchemalessXMLStreamNormalizedNodeStreamWriterTest.class
299 .getResourceAsStream(xmlPath);
300 return requireNonNull(readXmlToDocument(resourceAsStream));
303 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
304 final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
305 doc.getDocumentElement().normalize();
309 private static String toString(final Node xml) {
311 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
312 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
313 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
315 final StreamResult result = new StreamResult(new StringWriter());
316 final DOMSource source = new DOMSource(xml);
317 transformer.transform(source, result);
319 return result.getWriter().toString();
320 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
321 throw new RuntimeException("Unable to serialize xml element " + xml, e);