2 * Copyright (c) 2013 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.codec.xml.XMLStreamNormalizedNodeStreamWriter;
63 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
64 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
65 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
66 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
67 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
68 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
69 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
70 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
71 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
72 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
73 import org.opendaylight.yangtools.yang.model.api.Module;
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.impl.YangParserImpl;
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},
95 {"test.yang", "simple2.xml", null},
96 // TODO check attributes
97 {"test.yang", "simple_xml_with_attributes.xml", withAttributes()}
101 public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
102 private static Date revision;
105 revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-03-13");
106 } catch (final ParseException e) {
107 throw new RuntimeException(e);
111 private static ContainerNode augmentChoiceHell2() {
112 final YangInstanceIdentifier.NodeIdentifier container = getNodeIdentifier("container");
113 QName augmentChoice1QName = QName.create(container.getNodeType(), "augment-choice1");
114 QName augmentChoice2QName = QName.create(augmentChoice1QName, "augment-choice2");
115 final QName containerQName = QName.create(augmentChoice1QName, "case11-choice-case-container");
116 final QName leafQName = QName.create(augmentChoice1QName, "case11-choice-case-leaf");
118 final YangInstanceIdentifier.AugmentationIdentifier aug1Id =
119 new YangInstanceIdentifier.AugmentationIdentifier(Sets.newHashSet(augmentChoice1QName));
120 final YangInstanceIdentifier.AugmentationIdentifier aug2Id =
121 new YangInstanceIdentifier.AugmentationIdentifier(Sets.newHashSet(augmentChoice2QName));
122 final YangInstanceIdentifier.NodeIdentifier augmentChoice1Id =
123 new YangInstanceIdentifier.NodeIdentifier(augmentChoice1QName);
124 final YangInstanceIdentifier.NodeIdentifier augmentChoice2Id =
125 new YangInstanceIdentifier.NodeIdentifier(augmentChoice2QName);
126 final YangInstanceIdentifier.NodeIdentifier containerId =
127 new YangInstanceIdentifier.NodeIdentifier(containerQName);
130 return containerBuilder().withNodeIdentifier(container)
131 .withChild(augmentationBuilder().withNodeIdentifier(aug1Id)
132 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice1Id)
133 .withChild(augmentationBuilder().withNodeIdentifier(aug2Id)
134 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice2Id)
135 .withChild(containerBuilder().withNodeIdentifier(containerId)
136 .withChild(leafNode(leafQName, "leaf-value"))
144 private static ContainerNode withAttributes() {
145 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = containerBuilder();
146 b.withNodeIdentifier(getNodeIdentifier("container"));
148 final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
149 getNodeIdentifier("list"));
151 final Map<QName, Object> predicates = Maps.newHashMap();
152 predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
154 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
155 .mapEntryBuilder().withNodeIdentifier(
156 new YangInstanceIdentifier.NodeIdentifierWithPredicates(getNodeIdentifier("list").getNodeType(),
158 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier,Object,LeafNode<Object>> uint32InListBuilder
159 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
161 list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
163 listBuilder.withChild(list1Builder.build());
164 b.withChild(listBuilder.build());
166 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>> booleanBuilder
167 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
168 booleanBuilder.withValue(false);
169 b.withChild(booleanBuilder.build());
171 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder
172 = Builders.leafSetBuilder().withNodeIdentifier(getNodeIdentifier("leafList"));
174 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder
175 = Builders.leafSetEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
177 leafList1Builder.withValue("a");
179 leafListBuilder.withChild(leafList1Builder.build());
180 b.withChild(leafListBuilder.build());
185 private static ContainerNode augmentChoiceHell() {
187 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = containerBuilder();
188 b.withNodeIdentifier(getNodeIdentifier("container"));
191 choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch2"))
192 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
194 choiceBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
195 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2")).withValue("2").build())
202 choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch3")).withChild(
203 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
207 augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("augLeaf")).withChild(
208 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment").build())
212 augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("ch")).withChild(
213 choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch"))
215 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf")).withValue("1").build())
217 augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
219 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf_AnotherAugment")).withValue("1").build())
221 choiceBuilder().withNodeIdentifier(getNodeIdentifier("deepChoice"))
223 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("deepLeafc1")).withValue("1").build()
232 private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String localName) {
233 return new YangInstanceIdentifier.NodeIdentifier(QName.create(URI.create(NAMESPACE), revision, localName));
236 public static YangInstanceIdentifier.AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
237 final Set<QName> qn = Sets.newHashSet();
239 for (final String childName : childNames) {
240 qn.add(getNodeIdentifier(childName).getNodeType());
243 return new YangInstanceIdentifier.AugmentationIdentifier(qn);
246 public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath, final ContainerNode expectedNode) {
247 schema = parseTestSchema(yangPath);
248 this.xmlPath = xmlPath;
249 this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
250 this.expectedNode = expectedNode;
253 private final ContainerNode expectedNode;
254 private final ContainerSchemaNode containerNode;
255 private final String xmlPath;
258 SchemaContext parseTestSchema(final String... yangPath) {
259 final YangParserImpl yangParserImpl = new YangParserImpl();
260 final Set<Module> modules = yangParserImpl.parseYangModelsFromStreams(getTestYangs(yangPath));
261 return yangParserImpl.resolveSchemaContext(modules);
264 List<InputStream> getTestYangs(final String... yangPaths) {
266 return Lists.newArrayList(Collections2.transform(Lists.newArrayList(yangPaths),
267 new Function<String, InputStream>() {
269 public InputStream apply(final String input) {
270 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(input);
271 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
272 return resourceAsStream;
278 public void testTranslation() throws Exception {
279 final Document doc = loadDocument(xmlPath);
281 final ContainerNode built =
282 DomToNormalizedNodeParserFactory.getInstance(DomUtils.defaultValueCodecProvider(), schema).getContainerNodeParser().parse(
283 Collections.singletonList(doc.getDocumentElement()), containerNode);
285 if (expectedNode != null) {
286 org.junit.Assert.assertEquals(expectedNode, built);
289 System.err.println(built);
290 logger.info("{}", built);
292 final Element elementNS = XmlDocumentUtils.getDocument().createElementNS(containerNode.getQName().getNamespace().toString(), containerNode.getQName().getLocalName());
293 writeNormalizedNode(built, new DOMResult(elementNS), SchemaPath.create(true), schema);
295 XMLUnit.setIgnoreWhitespace(true);
296 XMLUnit.setIgnoreComments(true);
297 XMLUnit.setIgnoreAttributeOrder(true);
298 XMLUnit.setNormalize(true);
301 System.err.println(toString(doc.getDocumentElement()));
302 System.err.println(toString(elementNS));
304 final Diff diff = new Diff(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())), XMLUnit.buildTestDocument(toString(elementNS)));
306 // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in this case
307 // We need to implement custom qualifier so that the element ordering does not mess the DIFF
308 // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
309 // assertTrue(dd.toString(), dd.similar());
313 static final XMLOutputFactory XML_FACTORY;
315 XML_FACTORY = XMLOutputFactory.newFactory();
316 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
319 private static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result, final SchemaPath schemaPath, final SchemaContext context)
320 throws IOException, XMLStreamException {
321 NormalizedNodeWriter normalizedNodeWriter = null;
322 NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
323 XMLStreamWriter writer = null;
325 writer = XML_FACTORY.createXMLStreamWriter(result);
326 normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
327 normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
329 normalizedNodeWriter.write(normalized);
331 normalizedNodeWriter.flush();
333 if(normalizedNodeWriter != null) {
334 normalizedNodeWriter.close();
336 if(normalizedNodeStreamWriter != null) {
337 normalizedNodeStreamWriter.close();
345 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
346 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(xmlPath);
348 final Document currentConfigElement = readXmlToDocument(resourceAsStream);
349 Preconditions.checkNotNull(currentConfigElement);
350 return currentConfigElement;
353 private static final DocumentBuilderFactory BUILDERFACTORY;
356 final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
357 factory.setNamespaceAware(true);
358 factory.setCoalescing(true);
359 factory.setIgnoringElementContentWhitespace(true);
360 factory.setIgnoringComments(true);
361 BUILDERFACTORY = factory;
364 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
365 final DocumentBuilder dBuilder;
367 dBuilder = BUILDERFACTORY.newDocumentBuilder();
368 } catch (final ParserConfigurationException e) {
369 throw new RuntimeException("Failed to parse XML document", e);
371 final Document doc = dBuilder.parse(xmlContent);
373 doc.getDocumentElement().normalize();
377 public static String toString(final Element xml) {
379 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
380 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
382 final StreamResult result = new StreamResult(new StringWriter());
383 final DOMSource source = new DOMSource(xml);
384 transformer.transform(source, result);
386 return result.getWriter().toString();
387 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
388 throw new RuntimeException("Unable to serialize xml element " + xml, e);