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;
15 import com.google.common.base.Preconditions;
16 import com.google.common.collect.Collections2;
17 import com.google.common.collect.ImmutableList;
18 import com.google.common.collect.ImmutableSet;
19 import java.io.IOException;
20 import java.io.InputStream;
21 import java.io.StringWriter;
23 import java.text.ParseException;
24 import java.util.Arrays;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.Date;
28 import java.util.HashMap;
29 import java.util.HashSet;
30 import java.util.List;
33 import javax.xml.stream.XMLOutputFactory;
34 import javax.xml.stream.XMLStreamException;
35 import javax.xml.stream.XMLStreamWriter;
36 import javax.xml.transform.OutputKeys;
37 import javax.xml.transform.Transformer;
38 import javax.xml.transform.TransformerException;
39 import javax.xml.transform.TransformerFactory;
40 import javax.xml.transform.TransformerFactoryConfigurationError;
41 import javax.xml.transform.dom.DOMResult;
42 import javax.xml.transform.dom.DOMSource;
43 import javax.xml.transform.stream.StreamResult;
44 import org.custommonkey.xmlunit.Diff;
45 import org.custommonkey.xmlunit.XMLUnit;
46 import org.junit.Test;
47 import org.junit.runner.RunWith;
48 import org.junit.runners.Parameterized;
49 import org.opendaylight.yangtools.util.xml.UntrustedXML;
50 import org.opendaylight.yangtools.yang.common.QName;
51 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
55 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
56 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
57 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
59 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
60 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
61 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
62 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
63 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
64 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
65 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
66 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
67 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
68 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
69 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
70 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
71 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
72 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
73 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
74 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
75 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
76 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
77 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
78 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
79 import org.slf4j.Logger;
80 import org.slf4j.LoggerFactory;
81 import org.w3c.dom.Document;
82 import org.w3c.dom.Element;
83 import org.xml.sax.SAXException;
85 @RunWith(Parameterized.class)
86 public class NormalizedNodeXmlTranslationTest {
87 private static final Logger logger = LoggerFactory.getLogger(NormalizedNodeXmlTranslationTest.class);
88 private final SchemaContext schema;
90 @Parameterized.Parameters()
91 public static Collection<Object[]> data() {
92 return Arrays.asList(new Object[][] {
93 { "augment_choice_hell.yang", "augment_choice_hell_ok.xml", augmentChoiceHell() },
94 { "augment_choice_hell.yang", "augment_choice_hell_ok2.xml", null },
95 { "augment_choice_hell.yang", "augment_choice_hell_ok3.xml", augmentChoiceHell2() },
96 { "test.yang", "simple.xml", null }, { "test.yang", "simple2.xml", null },
97 // TODO check attributes
98 { "test.yang", "simple_xml_with_attributes.xml", withAttributes() }
102 public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
103 private static final Date REVISION;
106 REVISION = SimpleDateFormatUtil.getRevisionFormat().parse("2014-03-13");
107 } catch (final ParseException e) {
108 throw new RuntimeException(e);
112 private static ContainerNode augmentChoiceHell2() {
113 final NodeIdentifier container = getNodeIdentifier("container");
114 QName augmentChoice1QName = QName.create(container.getNodeType(), "augment-choice1");
115 QName augmentChoice2QName = QName.create(augmentChoice1QName, "augment-choice2");
116 final QName containerQName = QName.create(augmentChoice1QName, "case11-choice-case-container");
117 final QName leafQName = QName.create(augmentChoice1QName, "case11-choice-case-leaf");
119 final AugmentationIdentifier aug1Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice1QName));
120 final AugmentationIdentifier aug2Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice2QName));
121 final NodeIdentifier augmentChoice1Id = new NodeIdentifier(augmentChoice1QName);
122 final NodeIdentifier augmentChoice2Id = new NodeIdentifier(augmentChoice2QName);
123 final NodeIdentifier containerId = new NodeIdentifier(containerQName);
125 return containerBuilder().withNodeIdentifier(container)
126 .withChild(augmentationBuilder().withNodeIdentifier(aug1Id)
127 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice1Id)
128 .withChild(augmentationBuilder().withNodeIdentifier(aug2Id)
129 .withChild(choiceBuilder().withNodeIdentifier(augmentChoice2Id)
130 .withChild(containerBuilder().withNodeIdentifier(containerId)
131 .withChild(leafNode(leafQName, "leaf-value"))
139 private static ContainerNode withAttributes() {
140 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
141 b.withNodeIdentifier(getNodeIdentifier("container"));
143 final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
144 getNodeIdentifier("list"));
146 final Map<QName, Object> predicates = new HashMap<>();
147 predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
149 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
150 .mapEntryBuilder().withNodeIdentifier(new NodeIdentifierWithPredicates(
151 getNodeIdentifier("list").getNodeType(), predicates));
152 final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> uint32InListBuilder = Builders
153 .leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
155 list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
157 listBuilder.withChild(list1Builder.build());
158 b.withChild(listBuilder.build());
160 final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> booleanBuilder = Builders
161 .leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
162 booleanBuilder.withValue(Boolean.FALSE);
163 b.withChild(booleanBuilder.build());
165 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder = Builders.leafSetBuilder()
166 .withNodeIdentifier(getNodeIdentifier("leafList"));
168 final NormalizedNodeBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder = Builders
169 .leafSetEntryBuilder().withNodeIdentifier(
170 new NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
172 leafList1Builder.withValue("a");
174 leafListBuilder.withChild(leafList1Builder.build());
175 b.withChild(leafListBuilder.build());
180 private static ContainerNode augmentChoiceHell() {
182 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
183 b.withNodeIdentifier(getNodeIdentifier("container"));
185 b.withChild(choiceBuilder()
186 .withNodeIdentifier(getNodeIdentifier("ch2"))
188 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
191 .withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
193 Builders.leafBuilder()
194 .withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2"))
195 .withValue("2").build()).build()).build());
197 b.withChild(choiceBuilder()
198 .withNodeIdentifier(getNodeIdentifier("ch3"))
200 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
203 b.withChild(augmentationBuilder()
204 .withNodeIdentifier(getAugmentIdentifier("augLeaf"))
206 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment")
209 b.withChild(augmentationBuilder()
210 .withNodeIdentifier(getAugmentIdentifier("ch"))
213 .withNodeIdentifier(getNodeIdentifier("ch"))
215 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf"))
216 .withValue("1").build())
218 augmentationBuilder()
220 getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
222 Builders.leafBuilder()
224 getNodeIdentifier("c1Leaf_AnotherAugment"))
225 .withValue("1").build())
228 .withNodeIdentifier(getNodeIdentifier("deepChoice"))
230 Builders.leafBuilder()
232 getNodeIdentifier("deepLeafc1"))
233 .withValue("1").build()).build())
234 .build()).build()).build());
239 private static NodeIdentifier getNodeIdentifier(final String localName) {
240 return new NodeIdentifier(QName.create(URI.create(NAMESPACE), REVISION, localName));
243 public static AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
244 final Set<QName> qn = new HashSet<>();
246 for (final String childName : childNames) {
247 qn.add(getNodeIdentifier(childName).getNodeType());
250 return new AugmentationIdentifier(qn);
253 public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath,
254 final ContainerNode expectedNode) throws ReactorException {
255 schema = parseTestSchema(yangPath);
256 this.xmlPath = xmlPath;
257 this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
258 this.expectedNode = expectedNode;
261 private final ContainerNode expectedNode;
262 private final ContainerSchemaNode containerNode;
263 private final String xmlPath;
265 SchemaContext parseTestSchema(final String... yangPath) throws ReactorException {
266 return YangParserTestUtils.parseYangStreams(getTestYangs(yangPath));
269 List<InputStream> getTestYangs(final String... yangPaths) {
270 return ImmutableList.copyOf(Collections2.transform(Arrays.asList(yangPaths),
272 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(input);
273 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
274 return resourceAsStream;
279 public void testTranslation() throws Exception {
280 final Document doc = loadDocument(xmlPath);
282 final ContainerNode built = DomToNormalizedNodeParserFactory
283 .getInstance(DomUtils.defaultValueCodecProvider(), schema).getContainerNodeParser()
284 .parse(Collections.singletonList(doc.getDocumentElement()), containerNode);
286 if (expectedNode != null) {
287 org.junit.Assert.assertEquals(expectedNode, built);
290 System.err.println(built);
291 logger.info("{}", built);
293 final Element elementNS = XmlDocumentUtils.getDocument().createElementNS(
294 containerNode.getQName().getNamespace().toString(), containerNode.getQName().getLocalName());
295 writeNormalizedNode(built, new DOMResult(elementNS), SchemaPath.create(true), schema);
297 XMLUnit.setIgnoreWhitespace(true);
298 XMLUnit.setIgnoreComments(true);
299 XMLUnit.setIgnoreAttributeOrder(true);
300 XMLUnit.setNormalize(true);
302 System.err.println(toString(doc.getDocumentElement()));
303 System.err.println(toString(elementNS));
305 final Diff diff = new Diff(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())),
306 XMLUnit.buildTestDocument(toString(elementNS)));
308 // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in
310 // We need to implement custom qualifier so that the element ordering does not mess the DIFF
311 // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
312 // assertTrue(dd.toString(), dd.similar());
315 static final XMLOutputFactory XML_FACTORY;
317 XML_FACTORY = XMLOutputFactory.newFactory();
318 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.FALSE);
321 private static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result,
322 final SchemaPath schemaPath, final SchemaContext context) throws IOException, XMLStreamException {
323 NormalizedNodeWriter normalizedNodeWriter = null;
324 NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
325 XMLStreamWriter writer = null;
327 writer = XML_FACTORY.createXMLStreamWriter(result);
328 normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
329 normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
331 normalizedNodeWriter.write(normalized);
333 normalizedNodeWriter.flush();
335 if (normalizedNodeWriter != null) {
336 normalizedNodeWriter.close();
338 if (normalizedNodeStreamWriter != null) {
339 normalizedNodeStreamWriter.close();
341 if (writer != null) {
347 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
348 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(xmlPath);
350 final Document currentConfigElement = readXmlToDocument(resourceAsStream);
351 return Preconditions.checkNotNull(currentConfigElement);
354 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
355 final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
356 doc.getDocumentElement().normalize();
360 public static String toString(final Element xml) {
362 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
363 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
365 final StreamResult result = new StreamResult(new StringWriter());
366 final DOMSource source = new DOMSource(xml);
367 transformer.transform(source, result);
369 return result.getWriter().toString();
370 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
371 throw new RuntimeException("Unable to serialize xml element " + xml, e);