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 com.google.common.base.Function;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.Collections2;
13 import com.google.common.collect.Lists;
14 import com.google.common.collect.Maps;
15 import com.google.common.collect.Sets;
16 import java.io.IOException;
17 import java.io.InputStream;
18 import java.io.StringWriter;
20 import java.text.ParseException;
21 import java.text.SimpleDateFormat;
22 import java.util.Arrays;
23 import java.util.Collection;
24 import java.util.Collections;
25 import java.util.Date;
26 import java.util.List;
29 import javax.xml.parsers.DocumentBuilder;
30 import javax.xml.parsers.DocumentBuilderFactory;
31 import javax.xml.parsers.ParserConfigurationException;
32 import javax.xml.stream.XMLOutputFactory;
33 import javax.xml.stream.XMLStreamException;
34 import javax.xml.stream.XMLStreamWriter;
35 import javax.xml.transform.OutputKeys;
36 import javax.xml.transform.Transformer;
37 import javax.xml.transform.TransformerException;
38 import javax.xml.transform.TransformerFactory;
39 import javax.xml.transform.TransformerFactoryConfigurationError;
40 import javax.xml.transform.dom.DOMResult;
41 import javax.xml.transform.dom.DOMSource;
42 import javax.xml.transform.stream.StreamResult;
43 import org.custommonkey.xmlunit.Diff;
44 import org.custommonkey.xmlunit.XMLUnit;
45 import org.junit.Test;
46 import org.junit.runner.RunWith;
47 import org.junit.runners.Parameterized;
48 import org.opendaylight.yangtools.yang.common.QName;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
51 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
52 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
53 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
56 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
57 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
58 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
59 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
60 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
61 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
62 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
63 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
64 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
65 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
66 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
67 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
68 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
69 import org.opendaylight.yangtools.yang.model.api.Module;
70 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
71 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
72 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
73 import org.slf4j.Logger;
74 import org.slf4j.LoggerFactory;
75 import org.w3c.dom.Document;
76 import org.w3c.dom.Element;
77 import org.xml.sax.SAXException;
79 @RunWith(Parameterized.class)
80 public class NormalizedNodeXmlTranslationTest {
81 private static final Logger logger = LoggerFactory.getLogger(NormalizedNodeXmlTranslationTest.class);
82 private final SchemaContext schema;
84 @Parameterized.Parameters()
85 public static Collection<Object[]> data() {
86 return Arrays.asList(new Object[][]{
87 {"augment_choice_hell.yang", "augment_choice_hell_ok.xml", augmentChoiceHell()},
88 {"augment_choice_hell.yang", "augment_choice_hell_ok2.xml", null},
89 {"test.yang", "simple.xml", null},
90 {"test.yang", "simple2.xml", null},
91 // TODO check attributes
92 {"test.yang", "simple_xml_with_attributes.xml", withAttributes()}
96 public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
97 private static Date revision;
100 revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-03-13");
101 } catch (final ParseException e) {
102 throw new RuntimeException(e);
106 private static ContainerNode withAttributes() {
107 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
108 b.withNodeIdentifier(getNodeIdentifier("container"));
110 final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
111 getNodeIdentifier("list"));
113 final Map<QName, Object> predicates = Maps.newHashMap();
114 predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
116 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
117 .mapEntryBuilder().withNodeIdentifier(
118 new YangInstanceIdentifier.NodeIdentifierWithPredicates(getNodeIdentifier("list").getNodeType(),
120 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier,Object,LeafNode<Object>> uint32InListBuilder
121 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
123 list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
125 listBuilder.withChild(list1Builder.build());
126 b.withChild(listBuilder.build());
128 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>> booleanBuilder
129 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
130 booleanBuilder.withValue(false);
131 b.withChild(booleanBuilder.build());
133 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder
134 = Builders.leafSetBuilder().withNodeIdentifier(getNodeIdentifier("leafList"));
136 final NormalizedNodeBuilder<YangInstanceIdentifier.NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder
137 = Builders.leafSetEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
139 leafList1Builder.withValue("a");
141 leafListBuilder.withChild(leafList1Builder.build());
142 b.withChild(leafListBuilder.build());
147 private static ContainerNode augmentChoiceHell() {
149 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
150 b.withNodeIdentifier(getNodeIdentifier("container"));
153 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch2"))
154 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
156 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
157 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2")).withValue("2").build())
164 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch3")).withChild(
165 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
169 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("augLeaf")).withChild(
170 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment").build())
174 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("ch")).withChild(
175 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch"))
177 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf")).withValue("1").build())
179 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
181 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf_AnotherAugment")).withValue("1").build())
183 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("deepChoice"))
185 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("deepLeafc1")).withValue("1").build()
194 private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String localName) {
195 return new YangInstanceIdentifier.NodeIdentifier(QName.create(URI.create(NAMESPACE), revision, localName));
198 public static YangInstanceIdentifier.AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
199 final Set<QName> qn = Sets.newHashSet();
201 for (final String childName : childNames) {
202 qn.add(getNodeIdentifier(childName).getNodeType());
205 return new YangInstanceIdentifier.AugmentationIdentifier(qn);
208 public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath, final ContainerNode expectedNode) {
209 schema = parseTestSchema(yangPath);
210 this.xmlPath = xmlPath;
211 this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
212 this.expectedNode = expectedNode;
215 private final ContainerNode expectedNode;
216 private final ContainerSchemaNode containerNode;
217 private final String xmlPath;
220 SchemaContext parseTestSchema(final String... yangPath) {
221 final YangParserImpl yangParserImpl = new YangParserImpl();
222 final Set<Module> modules = yangParserImpl.parseYangModelsFromStreams(getTestYangs(yangPath));
223 return yangParserImpl.resolveSchemaContext(modules);
226 List<InputStream> getTestYangs(final String... yangPaths) {
228 return Lists.newArrayList(Collections2.transform(Lists.newArrayList(yangPaths),
229 new Function<String, InputStream>() {
231 public InputStream apply(final String input) {
232 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(input);
233 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
234 return resourceAsStream;
240 public void testTranslation() throws Exception {
241 final Document doc = loadDocument(xmlPath);
243 final ContainerNode built =
244 DomToNormalizedNodeParserFactory.getInstance(DomUtils.defaultValueCodecProvider(), schema).getContainerNodeParser().parse(
245 Collections.singletonList(doc.getDocumentElement()), containerNode);
247 if (expectedNode != null) {
248 org.junit.Assert.assertEquals(expectedNode, built);
251 System.err.println(built);
252 logger.info("{}", built);
254 final Element elementNS = XmlDocumentUtils.getDocument().createElementNS(containerNode.getQName().getNamespace().toString(), containerNode.getQName().getLocalName());
255 writeNormalizedNode(built, new DOMResult(elementNS), SchemaPath.create(true), schema);
257 XMLUnit.setIgnoreWhitespace(true);
258 XMLUnit.setIgnoreComments(true);
259 XMLUnit.setIgnoreAttributeOrder(true);
260 XMLUnit.setNormalize(true);
263 System.err.println(toString(doc.getDocumentElement()));
264 System.err.println(toString(elementNS));
266 final Diff diff = new Diff(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())), XMLUnit.buildTestDocument(toString(elementNS)));
268 // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in this case
269 // We need to implement custom qualifier so that the element ordering does not mess the DIFF
270 // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
271 // assertTrue(dd.toString(), dd.similar());
275 static final XMLOutputFactory XML_FACTORY;
277 XML_FACTORY = XMLOutputFactory.newFactory();
278 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
281 private void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result, final SchemaPath schemaPath, final SchemaContext context)
282 throws IOException, XMLStreamException {
283 NormalizedNodeWriter normalizedNodeWriter = null;
284 NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
285 XMLStreamWriter writer = null;
287 writer = XML_FACTORY.createXMLStreamWriter(result);
288 normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
289 normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
291 normalizedNodeWriter.write(normalized);
293 normalizedNodeWriter.flush();
295 if(normalizedNodeWriter != null) {
296 normalizedNodeWriter.close();
298 if(normalizedNodeStreamWriter != null) {
299 normalizedNodeStreamWriter.close();
307 private Document loadDocument(final String xmlPath) throws Exception {
308 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(xmlPath);
310 final Document currentConfigElement = readXmlToDocument(resourceAsStream);
311 Preconditions.checkNotNull(currentConfigElement);
312 return currentConfigElement;
315 private static final DocumentBuilderFactory BUILDERFACTORY;
318 final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
319 factory.setNamespaceAware(true);
320 factory.setCoalescing(true);
321 factory.setIgnoringElementContentWhitespace(true);
322 factory.setIgnoringComments(true);
323 BUILDERFACTORY = factory;
326 private Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
327 final DocumentBuilder dBuilder;
329 dBuilder = BUILDERFACTORY.newDocumentBuilder();
330 } catch (final ParserConfigurationException e) {
331 throw new RuntimeException("Failed to parse XML document", e);
333 final Document doc = dBuilder.parse(xmlContent);
335 doc.getDocumentElement().normalize();
339 public static String toString(final Element xml) {
341 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
342 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
344 final StreamResult result = new StreamResult(new StringWriter());
345 final DOMSource source = new DOMSource(xml);
346 transformer.transform(source, result);
348 return result.getWriter().toString();
349 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
350 throw new RuntimeException("Unable to serialize xml element " + xml, e);