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.impl.schema.transform.dom.serializer;
10 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.augmentationBuilder;
11 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.choiceBuilder;
12 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.containerBuilder;
13 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.leafNode;
14 import com.google.common.base.Function;
15 import com.google.common.base.Preconditions;
16 import com.google.common.collect.Collections2;
17 import com.google.common.collect.Lists;
18 import com.google.common.collect.Maps;
19 import com.google.common.collect.Sets;
20 import java.io.IOException;
21 import java.io.InputStream;
22 import java.io.StringWriter;
24 import java.text.ParseException;
25 import java.text.SimpleDateFormat;
26 import java.util.Arrays;
27 import java.util.Collection;
28 import java.util.Collections;
29 import java.util.Date;
30 import java.util.List;
33 import javax.xml.parsers.DocumentBuilder;
34 import javax.xml.parsers.DocumentBuilderFactory;
35 import javax.xml.parsers.ParserConfigurationException;
36 import javax.xml.stream.XMLOutputFactory;
37 import javax.xml.stream.XMLStreamException;
38 import javax.xml.stream.XMLStreamWriter;
39 import javax.xml.transform.OutputKeys;
40 import javax.xml.transform.Transformer;
41 import javax.xml.transform.TransformerException;
42 import javax.xml.transform.TransformerFactory;
43 import javax.xml.transform.TransformerFactoryConfigurationError;
44 import javax.xml.transform.dom.DOMResult;
45 import javax.xml.transform.dom.DOMSource;
46 import javax.xml.transform.stream.StreamResult;
47 import org.custommonkey.xmlunit.Diff;
48 import org.custommonkey.xmlunit.XMLUnit;
49 import org.junit.Test;
50 import org.junit.runner.RunWith;
51 import org.junit.runners.Parameterized;
52 import org.opendaylight.yangtools.yang.common.QName;
53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
54 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
56 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
57 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
59 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
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.TestUtils;
63 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
64 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
65 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
66 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
67 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
68 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
69 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
70 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
71 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
72 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
73 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
75 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
76 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
77 import org.slf4j.Logger;
78 import org.slf4j.LoggerFactory;
79 import org.w3c.dom.Document;
80 import org.w3c.dom.Element;
81 import org.xml.sax.SAXException;
83 @RunWith(Parameterized.class)
84 public class NormalizedNodeXmlTranslationTest {
85 private static final Logger logger = LoggerFactory.getLogger(NormalizedNodeXmlTranslationTest.class);
86 private final SchemaContext schema;
88 @Parameterized.Parameters()
89 public static Collection<Object[]> data() {
90 return Arrays.asList(new Object[][] {
91 { "augment_choice_hell.yang", "augment_choice_hell_ok.xml", augmentChoiceHell() },
92 { "augment_choice_hell.yang", "augment_choice_hell_ok2.xml", null },
93 { "augment_choice_hell.yang", "augment_choice_hell_ok3.xml", augmentChoiceHell2() },
94 { "test.yang", "simple.xml", null }, { "test.yang", "simple2.xml", null },
95 // TODO check attributes
96 { "test.yang", "simple_xml_with_attributes.xml", withAttributes() }
100 public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
101 private static Date revision;
104 revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-03-13");
105 } catch (final ParseException e) {
106 throw new RuntimeException(e);
110 private static ContainerNode augmentChoiceHell2() {
111 final YangInstanceIdentifier.NodeIdentifier container = getNodeIdentifier("container");
112 QName augmentChoice1QName = QName.create(container.getNodeType(), "augment-choice1");
113 QName augmentChoice2QName = QName.create(augmentChoice1QName, "augment-choice2");
114 final QName containerQName = QName.create(augmentChoice1QName, "case11-choice-case-container");
115 final QName leafQName = QName.create(augmentChoice1QName, "case11-choice-case-leaf");
117 final YangInstanceIdentifier.AugmentationIdentifier aug1Id = new YangInstanceIdentifier.AugmentationIdentifier(
118 Sets.newHashSet(augmentChoice1QName));
119 final YangInstanceIdentifier.AugmentationIdentifier aug2Id = new YangInstanceIdentifier.AugmentationIdentifier(
120 Sets.newHashSet(augmentChoice2QName));
121 final YangInstanceIdentifier.NodeIdentifier augmentChoice1Id = new YangInstanceIdentifier.NodeIdentifier(
122 augmentChoice1QName);
123 final YangInstanceIdentifier.NodeIdentifier augmentChoice2Id = new YangInstanceIdentifier.NodeIdentifier(
124 augmentChoice2QName);
125 final YangInstanceIdentifier.NodeIdentifier containerId = new YangInstanceIdentifier.NodeIdentifier(
128 return containerBuilder().withNodeIdentifier(container)
129 .withChild(augmentationBuilder().withNodeIdentifier(aug1Id)
130 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice1Id)
131 .withChild(augmentationBuilder().withNodeIdentifier(aug2Id)
132 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice2Id)
133 .withChild(containerBuilder().withNodeIdentifier(containerId)
134 .withChild(leafNode(leafQName, "leaf-value"))
142 private static ContainerNode withAttributes() {
143 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = containerBuilder();
144 b.withNodeIdentifier(getNodeIdentifier("container"));
146 final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
147 getNodeIdentifier("list"));
149 final Map<QName, Object> predicates = Maps.newHashMap();
150 predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
152 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
153 .mapEntryBuilder().withNodeIdentifier(
154 new YangInstanceIdentifier.NodeIdentifierWithPredicates(
155 getNodeIdentifier("list").getNodeType(), predicates));
156 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>> uint32InListBuilder = Builders
157 .leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
159 list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
161 listBuilder.withChild(list1Builder.build());
162 b.withChild(listBuilder.build());
164 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>> booleanBuilder = Builders
165 .leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
166 booleanBuilder.withValue(false);
167 b.withChild(booleanBuilder.build());
169 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder = Builders.leafSetBuilder()
170 .withNodeIdentifier(getNodeIdentifier("leafList"));
172 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder = Builders
173 .leafSetEntryBuilder().withNodeIdentifier(
174 new YangInstanceIdentifier.NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
176 leafList1Builder.withValue("a");
178 leafListBuilder.withChild(leafList1Builder.build());
179 b.withChild(leafListBuilder.build());
184 private static ContainerNode augmentChoiceHell() {
186 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = containerBuilder();
187 b.withNodeIdentifier(getNodeIdentifier("container"));
189 b.withChild(choiceBuilder()
190 .withNodeIdentifier(getNodeIdentifier("ch2"))
192 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
195 .withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
197 Builders.leafBuilder()
198 .withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2"))
199 .withValue("2").build()).build()).build());
201 b.withChild(choiceBuilder()
202 .withNodeIdentifier(getNodeIdentifier("ch3"))
204 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
207 b.withChild(augmentationBuilder()
208 .withNodeIdentifier(getAugmentIdentifier("augLeaf"))
210 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment")
213 b.withChild(augmentationBuilder()
214 .withNodeIdentifier(getAugmentIdentifier("ch"))
217 .withNodeIdentifier(getNodeIdentifier("ch"))
219 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf"))
220 .withValue("1").build())
222 augmentationBuilder()
224 getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
226 Builders.leafBuilder()
228 getNodeIdentifier("c1Leaf_AnotherAugment"))
229 .withValue("1").build())
232 .withNodeIdentifier(getNodeIdentifier("deepChoice"))
234 Builders.leafBuilder()
236 getNodeIdentifier("deepLeafc1"))
237 .withValue("1").build()).build())
238 .build()).build()).build());
243 private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String localName) {
244 return new YangInstanceIdentifier.NodeIdentifier(QName.create(URI.create(NAMESPACE), revision, localName));
247 public static YangInstanceIdentifier.AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
248 final Set<QName> qn = Sets.newHashSet();
250 for (final String childName : childNames) {
251 qn.add(getNodeIdentifier(childName).getNodeType());
254 return new YangInstanceIdentifier.AugmentationIdentifier(qn);
257 public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath,
258 final ContainerNode expectedNode) throws ReactorException {
259 schema = parseTestSchema(yangPath);
260 this.xmlPath = xmlPath;
261 this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
262 this.expectedNode = expectedNode;
265 private final ContainerNode expectedNode;
266 private final ContainerSchemaNode containerNode;
267 private final String xmlPath;
269 SchemaContext parseTestSchema(final String... yangPath) throws ReactorException {
270 return TestUtils.parseYangStreams(getTestYangs(yangPath));
273 List<InputStream> getTestYangs(final String... yangPaths) {
275 return Lists.newArrayList(Collections2.transform(Lists.newArrayList(yangPaths),
276 new Function<String, InputStream>() {
278 public InputStream apply(final String input) {
279 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(input);
280 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
281 return resourceAsStream;
287 public void testTranslation() throws Exception {
288 final Document doc = loadDocument(xmlPath);
290 final ContainerNode built = DomToNormalizedNodeParserFactory
291 .getInstance(DomUtils.defaultValueCodecProvider(), schema).getContainerNodeParser()
292 .parse(Collections.singletonList(doc.getDocumentElement()), containerNode);
294 if (expectedNode != null) {
295 org.junit.Assert.assertEquals(expectedNode, built);
298 System.err.println(built);
299 logger.info("{}", built);
301 final Element elementNS = XmlDocumentUtils.getDocument().createElementNS(
302 containerNode.getQName().getNamespace().toString(), containerNode.getQName().getLocalName());
303 writeNormalizedNode(built, new DOMResult(elementNS), SchemaPath.create(true), schema);
305 XMLUnit.setIgnoreWhitespace(true);
306 XMLUnit.setIgnoreComments(true);
307 XMLUnit.setIgnoreAttributeOrder(true);
308 XMLUnit.setNormalize(true);
310 System.err.println(toString(doc.getDocumentElement()));
311 System.err.println(toString(elementNS));
313 final Diff diff = new Diff(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())),
314 XMLUnit.buildTestDocument(toString(elementNS)));
316 // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in
318 // We need to implement custom qualifier so that the element ordering does not mess the DIFF
319 // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
320 // assertTrue(dd.toString(), dd.similar());
323 static final XMLOutputFactory XML_FACTORY;
325 XML_FACTORY = XMLOutputFactory.newFactory();
326 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
329 private static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result,
330 final SchemaPath schemaPath, final SchemaContext context) throws IOException, XMLStreamException {
331 NormalizedNodeWriter normalizedNodeWriter = null;
332 NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
333 XMLStreamWriter writer = null;
335 writer = XML_FACTORY.createXMLStreamWriter(result);
336 normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
337 normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
339 normalizedNodeWriter.write(normalized);
341 normalizedNodeWriter.flush();
343 if (normalizedNodeWriter != null) {
344 normalizedNodeWriter.close();
346 if (normalizedNodeStreamWriter != null) {
347 normalizedNodeStreamWriter.close();
349 if (writer != null) {
355 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
356 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(xmlPath);
358 final Document currentConfigElement = readXmlToDocument(resourceAsStream);
359 Preconditions.checkNotNull(currentConfigElement);
360 return currentConfigElement;
363 private static final DocumentBuilderFactory BUILDERFACTORY;
366 final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
367 factory.setNamespaceAware(true);
368 factory.setCoalescing(true);
369 factory.setIgnoringElementContentWhitespace(true);
370 factory.setIgnoringComments(true);
371 BUILDERFACTORY = factory;
374 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
375 final DocumentBuilder dBuilder;
377 dBuilder = BUILDERFACTORY.newDocumentBuilder();
378 } catch (final ParserConfigurationException e) {
379 throw new RuntimeException("Failed to parse XML document", e);
381 final Document doc = dBuilder.parse(xmlContent);
383 doc.getDocumentElement().normalize();
387 public static String toString(final Element xml) {
389 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
390 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
392 final StreamResult result = new StreamResult(new StringWriter());
393 final DOMSource source = new DOMSource(xml);
394 transformer.transform(source, result);
396 return result.getWriter().toString();
397 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
398 throw new RuntimeException("Unable to serialize xml element " + xml, e);