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 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;
17 import java.net.URISyntaxException;
18 import java.text.ParseException;
19 import java.util.ArrayList;
20 import java.util.HashMap;
21 import java.util.List;
23 import javax.xml.stream.XMLOutputFactory;
24 import javax.xml.stream.XMLStreamException;
25 import javax.xml.stream.XMLStreamWriter;
26 import javax.xml.transform.OutputKeys;
27 import javax.xml.transform.Transformer;
28 import javax.xml.transform.TransformerException;
29 import javax.xml.transform.TransformerFactory;
30 import javax.xml.transform.TransformerFactoryConfigurationError;
31 import javax.xml.transform.dom.DOMResult;
32 import javax.xml.transform.dom.DOMSource;
33 import javax.xml.transform.stream.StreamResult;
34 import org.custommonkey.xmlunit.Diff;
35 import org.custommonkey.xmlunit.DifferenceListener;
36 import org.custommonkey.xmlunit.IgnoreTextAndAttributeValuesDifferenceListener;
37 import org.custommonkey.xmlunit.XMLAssert;
38 import org.custommonkey.xmlunit.XMLUnit;
39 import org.junit.Before;
40 import org.junit.Test;
41 import org.opendaylight.yangtools.util.xml.UntrustedXML;
42 import org.opendaylight.yangtools.yang.common.QName;
43 import org.opendaylight.yangtools.yang.common.QNameModule;
44 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
49 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
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.LeafSetNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
57 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
59 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
60 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
61 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
62 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
63 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
64 import org.w3c.dom.Document;
65 import org.w3c.dom.Node;
66 import org.xml.sax.SAXException;
68 public class SchemalessXMLStreamNormalizedNodeStreamWriterTest {
70 private QNameModule foobarModule;
72 private QName outerContainer;
74 private QName myContainer1;
75 private QName myKeyedList;
76 private QName myKeyLeaf;
77 private QName myLeafInList1;
78 private QName myLeafInList2;
79 private QName myOrderedList;
80 private QName myKeyLeafInOrderedList;
81 private QName myLeafInOrderedList1;
82 private QName myLeafInOrderedList2;
83 private QName myUnkeyedList;
84 private QName myLeafInUnkeyedList;
85 private QName myLeaf1;
86 private QName myLeafList;
87 private QName myOrderedLeafList;
89 private QName myContainer2;
90 private QName innerContainer;
91 private QName myLeaf2;
92 private QName myLeaf3;
93 private QName myChoice;
94 private QName myLeafInCase2;
95 private QName myAnyxml;
97 private QName myContainer3;
98 private QName myDoublyKeyedList;
99 private QName myFirstKeyLeaf;
100 private QName mySecondKeyLeaf;
101 private QName myLeafInList3;
103 private DOMSource anyxmlDomSource;
106 public void setup() throws URISyntaxException, ParseException {
107 foobarModule = QNameModule.create(new URI("foobar-namespace"), SimpleDateFormatUtil.getRevisionFormat().parse(
110 outerContainer = QName.create(foobarModule, "outer-container");
112 myContainer1 = QName.create(foobarModule, "my-container-1");
113 myKeyedList = QName.create(foobarModule, "my-keyed-list");
114 myKeyLeaf = QName.create(foobarModule, "my-key-leaf");
115 myLeafInList1 = QName.create(foobarModule, "my-leaf-in-list-1");
116 myLeafInList2 = QName.create(foobarModule, "my-leaf-in-list-2");
117 myOrderedList = QName.create(foobarModule, "my-ordered-list");
118 myKeyLeafInOrderedList = QName.create(foobarModule, "my-key-leaf-in-ordered-list");
119 myLeafInOrderedList1 = QName.create(foobarModule, "my-leaf-in-ordered-list-1");
120 myLeafInOrderedList2 = QName.create(foobarModule, "my-leaf-in-ordered-list-2");
121 myUnkeyedList = QName.create(foobarModule, "my-unkeyed-list");
122 myLeafInUnkeyedList = QName.create(foobarModule, "my-leaf-in-unkeyed-list");
123 myLeaf1 = QName.create(foobarModule, "my-leaf-1");
124 myLeafList = QName.create(foobarModule, "my-leaf-list");
125 myOrderedLeafList = QName.create(foobarModule, "my-ordered-leaf-list");
127 myContainer2 = QName.create(foobarModule, "my-container-2");
128 innerContainer = QName.create(foobarModule, "inner-container");
129 myLeaf2 = QName.create(foobarModule, "my-leaf-2");
130 myLeaf3 = QName.create(foobarModule, "my-leaf-3");
131 myChoice = QName.create(foobarModule, "my-choice");
132 myLeafInCase2 = QName.create(foobarModule, "my-leaf-in-case-2");
133 myAnyxml = QName.create(foobarModule, "my-anyxml");
135 myContainer3 = QName.create(foobarModule, "my-container-3");
136 myDoublyKeyedList = QName.create(foobarModule, "my-doubly-keyed-list");
137 myFirstKeyLeaf = QName.create(foobarModule, "my-first-key-leaf");
138 mySecondKeyLeaf = QName.create(foobarModule, "my-second-key-leaf");
139 myLeafInList3 = QName.create(foobarModule, "my-leaf-in-list-3");
141 anyxmlDomSource = new DOMSource();
145 public void testWrite() throws XMLStreamException, IOException, SAXException {
146 final Document doc = loadDocument("/foobar.xml");
148 final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
150 final XMLOutputFactory factory = XMLOutputFactory.newInstance();
151 factory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
153 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
155 final NormalizedNodeStreamWriter schemalessXmlNormalizedNodeStreamWriter =
156 XMLStreamNormalizedNodeStreamWriter.createSchemaless(xmlStreamWriter);
158 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
159 schemalessXmlNormalizedNodeStreamWriter);
161 normalizedNodeWriter.write(buildOuterContainerNode());
163 XMLUnit.setIgnoreWhitespace(true);
164 XMLUnit.setNormalize(true);
166 final String expectedXml = toString(doc.getDocumentElement());
167 final String serializedXml = toString(domResult.getNode());
168 final Diff diff = new Diff(expectedXml, serializedXml);
170 final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
171 diff.overrideDifferenceListener(differenceListener);
173 XMLAssert.assertXMLEqual(diff, true);
176 private NormalizedNode<?, ?> buildOuterContainerNode() {
178 MapNode myKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myKeyedList))
179 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
180 new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue1"))
181 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
182 .withValue("listleafvalue1").build())
183 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
184 .withValue("listleafvalue2").build()).build())
185 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
186 new NodeIdentifierWithPredicates(myKeyedList, myKeyLeaf, "listkeyvalue2"))
187 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList1))
188 .withValue("listleafvalue12").build())
189 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInList2))
190 .withValue("listleafvalue22").build()).build()).build();
192 OrderedMapNode myOrderedListNode = Builders.orderedMapBuilder().withNodeIdentifier(
193 new NodeIdentifier(myOrderedList)).withChild(Builders.mapEntryBuilder().withNodeIdentifier(
194 new NodeIdentifierWithPredicates(myOrderedList, myKeyLeafInOrderedList, "olistkeyvalue1"))
195 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList1))
196 .withValue("olistleafvalue1").build())
197 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList2))
198 .withValue("olistleafvalue2").build()).build())
199 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
200 new NodeIdentifierWithPredicates(myOrderedList, myKeyLeafInOrderedList, "olistkeyvalue2"))
201 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList1))
202 .withValue("olistleafvalue12").build())
203 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInOrderedList2))
204 .withValue("olistleafvalue22").build()).build()).build();
206 final UnkeyedListEntryNode unkeyedListEntry = Builders.unkeyedListEntryBuilder()
207 .withNodeIdentifier(new NodeIdentifier(myUnkeyedList))
208 .withChild(ImmutableNodes.leafNode(myLeafInUnkeyedList, "foo")).build();
210 final List<UnkeyedListEntryNode> unkeyedListEntries = new ArrayList<>();
211 unkeyedListEntries.add(unkeyedListEntry);
213 UnkeyedListNode myUnkeyedListNode = Builders.unkeyedListBuilder().withNodeIdentifier(
214 new NodeIdentifier(myUnkeyedList))
215 .withValue(unkeyedListEntries).build();
217 LeafNode<?> myLeaf1Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf1))
218 .withValue("value1").build();
220 LeafSetNode<?> myLeafListNode = Builders.leafSetBuilder().withNodeIdentifier(new NodeIdentifier(myLeafList))
221 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
222 new NodeWithValue<>(myLeafList, "lflvalue1")).withValue("lflvalue1").build())
223 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
224 new NodeWithValue<>(myLeafList, "lflvalue2")).withValue("lflvalue2").build()).build();
226 LeafSetNode<?> myOrderedLeafListNode = Builders.orderedLeafSetBuilder().withNodeIdentifier(
227 new NodeIdentifier(myOrderedLeafList))
228 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
229 new NodeWithValue<>(myOrderedLeafList, "olflvalue1")).withValue("olflvalue1").build())
230 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
231 new NodeWithValue<>(myOrderedLeafList, "olflvalue2")).withValue("olflvalue2").build()).build();
233 ContainerNode myContainer1Node = Builders.containerBuilder().withNodeIdentifier(
234 new NodeIdentifier(myContainer1))
235 .withChild(myKeyedListNode)
236 .withChild(myOrderedListNode)
237 .withChild(myUnkeyedListNode)
238 .withChild(myLeaf1Node)
239 .withChild(myLeafListNode)
240 .withChild(myOrderedLeafListNode)
244 ContainerNode innerContainerNode = Builders.containerBuilder().withNodeIdentifier(
245 new NodeIdentifier(innerContainer))
246 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf2))
247 .withValue("value2").build()).build();
249 LeafNode<?> myLeaf3Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeaf3))
250 .withValue("value3").build();
252 ChoiceNode myChoiceNode = Builders.choiceBuilder().withNodeIdentifier(new NodeIdentifier(myChoice))
253 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(myLeafInCase2))
254 .withValue("case2value").build()).build();
256 AnyXmlNode myAnyxmlNode = Builders.anyXmlBuilder().withNodeIdentifier(new NodeIdentifier(myAnyxml))
257 .withValue(anyxmlDomSource).build();
259 ContainerNode myContainer2Node = Builders.containerBuilder().withNodeIdentifier(
260 new NodeIdentifier(myContainer2))
261 .withChild(innerContainerNode)
262 .withChild(myLeaf3Node)
263 .withChild(myChoiceNode).build();
264 //.withChild(myAnyxmlNode).build();
267 Map<QName, Object> keys = new HashMap<>();
268 keys.put(myFirstKeyLeaf, "listkeyvalue1");
269 keys.put(mySecondKeyLeaf, "listkeyvalue2");
271 MapNode myDoublyKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(myDoublyKeyedList))
272 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
273 new NodeIdentifierWithPredicates(myDoublyKeyedList, keys))
274 .withChild(Builders.leafBuilder().withNodeIdentifier(
275 new NodeIdentifier(myLeafInList3)).withValue("listleafvalue1").build()).build())
278 AugmentationNode myDoublyKeyedListAugNode = Builders.augmentationBuilder().withNodeIdentifier(
279 new AugmentationIdentifier(Sets.newHashSet(myDoublyKeyedList)))
280 .withChild(myDoublyKeyedListNode).build();
282 ContainerNode myContainer3Node = Builders.containerBuilder().withNodeIdentifier(
283 new NodeIdentifier(myContainer3))
284 .withChild(myDoublyKeyedListAugNode).build();
286 AugmentationNode myContainer3AugNode = Builders.augmentationBuilder().withNodeIdentifier(
287 new AugmentationIdentifier(Sets.newHashSet(myContainer3)))
288 .withChild(myContainer3Node).build();
290 ContainerNode outerContainerNode = Builders.containerBuilder().withNodeIdentifier(
291 new NodeIdentifier(outerContainer))
292 .withChild(myContainer1Node)
293 .withChild(myContainer2Node)
294 .withChild(myContainer3AugNode).build();
296 return outerContainerNode;
299 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
300 final InputStream resourceAsStream = SchemalessXMLStreamNormalizedNodeStreamWriterTest.class
301 .getResourceAsStream(xmlPath);
302 final Document currentConfigElement = readXmlToDocument(resourceAsStream);
303 Preconditions.checkNotNull(currentConfigElement);
304 return currentConfigElement;
307 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
308 final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
309 doc.getDocumentElement().normalize();
313 private static String toString(final Node xml) {
315 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
316 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
317 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
319 final StreamResult result = new StreamResult(new StringWriter());
320 final DOMSource source = new DOMSource(xml);
321 transformer.transform(source, result);
323 return result.getWriter().toString();
324 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
325 throw new RuntimeException("Unable to serialize xml element " + xml, e);