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
8 package org.opendaylight.yangtools.yang.data.codec.xml;
10 import static java.util.Objects.requireNonNull;
11 import static org.junit.Assert.assertNotNull;
12 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.augmentationBuilder;
13 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.choiceBuilder;
14 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.containerBuilder;
15 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.leafNode;
17 import com.google.common.collect.ImmutableSet;
18 import java.io.IOException;
19 import java.io.InputStream;
20 import java.io.StringWriter;
21 import java.util.Arrays;
22 import java.util.Collection;
23 import java.util.HashSet;
25 import javax.xml.stream.XMLOutputFactory;
26 import javax.xml.stream.XMLStreamReader;
27 import javax.xml.stream.XMLStreamWriter;
28 import javax.xml.transform.OutputKeys;
29 import javax.xml.transform.Transformer;
30 import javax.xml.transform.TransformerException;
31 import javax.xml.transform.TransformerFactory;
32 import javax.xml.transform.TransformerFactoryConfigurationError;
33 import javax.xml.transform.dom.DOMResult;
34 import javax.xml.transform.dom.DOMSource;
35 import javax.xml.transform.stream.StreamResult;
36 import org.custommonkey.xmlunit.Diff;
37 import org.custommonkey.xmlunit.ElementNameAndTextQualifier;
38 import org.custommonkey.xmlunit.IgnoreTextAndAttributeValuesDifferenceListener;
39 import org.custommonkey.xmlunit.XMLUnit;
40 import org.junit.Test;
41 import org.junit.runner.RunWith;
42 import org.junit.runners.Parameterized;
43 import org.opendaylight.yangtools.util.xml.UntrustedXML;
44 import org.opendaylight.yangtools.yang.common.QName;
45 import org.opendaylight.yangtools.yang.common.QNameModule;
46 import org.opendaylight.yangtools.yang.common.Revision;
47 import org.opendaylight.yangtools.yang.common.Uint32;
48 import org.opendaylight.yangtools.yang.common.XMLNamespace;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
56 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
57 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.SystemLeafSetNode;
59 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
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.ImmutableNormalizedNodeStreamWriter;
64 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
65 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
66 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
67 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
68 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
69 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
70 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
71 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
72 import org.w3c.dom.Document;
73 import org.w3c.dom.Node;
74 import org.xml.sax.SAXException;
76 @RunWith(Parameterized.class)
77 public class NormalizedNodeXmlTranslationTest {
78 private final EffectiveModelContext schema;
80 @Parameterized.Parameters()
81 public static Collection<Object[]> data() {
82 return Arrays.asList(new Object[][] {
83 { "/schema/augment_choice_hell.yang", "/schema/augment_choice_hell_ok.xml", augmentChoiceHell() },
84 { "/schema/augment_choice_hell.yang", "/schema/augment_choice_hell_ok2.xml", null },
85 { "/schema/augment_choice_hell.yang", "/schema/augment_choice_hell_ok3.xml", augmentChoiceHell2() },
86 { "/schema/test.yang", "/schema/simple.xml", null },
87 { "/schema/test.yang", "/schema/simple2.xml", null },
88 // TODO check attributes
89 { "/schema/test.yang", "/schema/simple_xml_with_attributes.xml", withAttributes() }
93 private static final QNameModule MODULE = QNameModule.create(
94 XMLNamespace.of("urn:opendaylight:params:xml:ns:yang:controller:test"), Revision.of("2014-03-13"));
96 private static ContainerNode augmentChoiceHell2() {
97 final NodeIdentifier container = getNodeIdentifier("container");
98 final QName augmentChoice1QName = QName.create(container.getNodeType(), "augment-choice1");
99 final QName augmentChoice2QName = QName.create(augmentChoice1QName, "augment-choice2");
100 final QName containerQName = QName.create(augmentChoice1QName, "case11-choice-case-container");
101 final QName leafQName = QName.create(augmentChoice1QName, "case11-choice-case-leaf");
103 final AugmentationIdentifier aug1Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice1QName));
104 final AugmentationIdentifier aug2Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice2QName));
105 final NodeIdentifier augmentChoice1Id = new NodeIdentifier(augmentChoice1QName);
106 final NodeIdentifier augmentChoice2Id = new NodeIdentifier(augmentChoice2QName);
107 final NodeIdentifier containerId = new NodeIdentifier(containerQName);
109 return containerBuilder().withNodeIdentifier(container)
110 .withChild(augmentationBuilder().withNodeIdentifier(aug1Id)
111 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice1Id)
112 .withChild(augmentationBuilder().withNodeIdentifier(aug2Id)
113 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice2Id)
114 .withChild(containerBuilder().withNodeIdentifier(containerId)
115 .withChild(leafNode(leafQName, "leaf-value"))
123 private static ContainerNode withAttributes() {
124 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
125 b.withNodeIdentifier(getNodeIdentifier("container"));
127 final CollectionNodeBuilder<MapEntryNode, SystemMapNode> listBuilder =
128 Builders.mapBuilder().withNodeIdentifier(getNodeIdentifier("list"));
130 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
131 .mapEntryBuilder().withNodeIdentifier(NodeIdentifierWithPredicates.of(
132 getNodeIdentifier("list").getNodeType(),
133 getNodeIdentifier("uint32InList").getNodeType(), Uint32.valueOf(3)));
134 final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> uint32InListBuilder = Builders
135 .leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
137 list1Builder.withChild(uint32InListBuilder.withValue(Uint32.valueOf(3)).build());
139 listBuilder.withChild(list1Builder.build());
140 b.withChild(listBuilder.build());
142 final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> booleanBuilder = Builders
143 .leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
144 booleanBuilder.withValue(Boolean.FALSE);
145 b.withChild(booleanBuilder.build());
147 final ListNodeBuilder<Object, SystemLeafSetNode<Object>> leafListBuilder = Builders.leafSetBuilder()
148 .withNodeIdentifier(getNodeIdentifier("leafList"));
150 final NormalizedNodeBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder = Builders
151 .leafSetEntryBuilder().withNodeIdentifier(
152 new NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
154 leafList1Builder.withValue("a");
156 leafListBuilder.withChild(leafList1Builder.build());
157 b.withChild(leafListBuilder.build());
162 private static ContainerNode augmentChoiceHell() {
164 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
165 b.withNodeIdentifier(getNodeIdentifier("container"));
167 b.withChild(choiceBuilder()
168 .withNodeIdentifier(getNodeIdentifier("ch2"))
170 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
173 .withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
175 Builders.leafBuilder()
176 .withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2"))
177 .withValue("2").build()).build()).build());
179 b.withChild(choiceBuilder()
180 .withNodeIdentifier(getNodeIdentifier("ch3"))
182 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
185 b.withChild(augmentationBuilder()
186 .withNodeIdentifier(getAugmentIdentifier("augLeaf"))
188 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment")
191 b.withChild(augmentationBuilder()
192 .withNodeIdentifier(getAugmentIdentifier("ch"))
195 .withNodeIdentifier(getNodeIdentifier("ch"))
197 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf"))
198 .withValue("1").build())
200 augmentationBuilder()
202 getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
204 Builders.leafBuilder()
206 getNodeIdentifier("c1Leaf_AnotherAugment"))
207 .withValue("1").build())
210 .withNodeIdentifier(getNodeIdentifier("deepChoice"))
212 Builders.leafBuilder()
214 getNodeIdentifier("deepLeafc1"))
215 .withValue("1").build()).build())
216 .build()).build()).build());
221 private static NodeIdentifier getNodeIdentifier(final String localName) {
222 return new NodeIdentifier(QName.create(MODULE, localName));
225 private static AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
226 final Set<QName> qn = new HashSet<>();
228 for (final String childName : childNames) {
229 qn.add(getNodeIdentifier(childName).getNodeType());
232 return new AugmentationIdentifier(qn);
235 private final ContainerNode expectedNode;
236 private final String xmlPath;
238 public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath,
239 final ContainerNode expectedNode) {
240 this.schema = YangParserTestUtils.parseYangResource(yangPath);
241 this.xmlPath = xmlPath;
242 this.expectedNode = expectedNode;
246 public void testTranslationRepairing() throws Exception {
247 testTranslation(TestFactories.REPAIRING_OUTPUT_FACTORY);
251 public void testTranslation() throws Exception {
252 testTranslation(TestFactories.DEFAULT_OUTPUT_FACTORY);
255 private void testTranslation(final XMLOutputFactory factory) throws Exception {
256 final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream(xmlPath);
258 final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
260 final NormalizedNodeResult result = new NormalizedNodeResult();
261 final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
263 final XmlParserStream xmlParser = XmlParserStream.create(streamWriter,
264 Inference.ofDataTreePath(schema, QName.create(MODULE, "container")));
265 xmlParser.parse(reader);
267 final NormalizedNode built = result.getResult();
268 assertNotNull(built);
270 if (expectedNode != null) {
271 org.junit.Assert.assertEquals(expectedNode, built);
274 final Document document = UntrustedXML.newDocumentBuilder().newDocument();
275 final DOMResult domResult = new DOMResult(document);
277 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
279 final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter
280 .create(xmlStreamWriter, schema);
282 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
283 xmlNormalizedNodeStreamWriter);
285 normalizedNodeWriter.write(built);
287 final Document doc = loadDocument(xmlPath);
289 XMLUnit.setIgnoreWhitespace(true);
290 XMLUnit.setIgnoreComments(true);
291 XMLUnit.setIgnoreAttributeOrder(true);
292 XMLUnit.setNormalize(true);
294 final String expectedXml = toString(doc.getDocumentElement());
295 final String serializedXml = toString(domResult.getNode());
297 final Diff diff = new Diff(expectedXml, serializedXml);
298 diff.overrideDifferenceListener(new IgnoreTextAndAttributeValuesDifferenceListener());
299 diff.overrideElementQualifier(new ElementNameAndTextQualifier());
301 // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in
303 // We need to implement custom qualifier so that the element ordering does not mess the DIFF
304 // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
305 // assertTrue(dd.toString(), dd.similar());
307 //new XMLTestCase() {}.assertXMLEqual(diff, true);
310 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
311 final InputStream resourceAsStream = NormalizedNodeXmlTranslationTest.class.getResourceAsStream(xmlPath);
312 return requireNonNull(readXmlToDocument(resourceAsStream));
315 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
316 final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
317 doc.getDocumentElement().normalize();
321 private static String toString(final Node xml) {
323 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
324 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
325 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
327 final StreamResult result = new StreamResult(new StringWriter());
328 final DOMSource source = new DOMSource(xml);
329 transformer.transform(source, result);
331 return result.getWriter().toString();
332 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
333 throw new RuntimeException("Unable to serialize xml element " + xml, e);