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;
17 import java.io.IOException;
18 import java.io.InputStream;
19 import java.io.StringWriter;
21 import java.text.ParseException;
22 import java.text.SimpleDateFormat;
23 import java.util.Arrays;
24 import java.util.Collection;
25 import java.util.Collections;
26 import java.util.Date;
27 import java.util.List;
31 import javax.xml.parsers.DocumentBuilder;
32 import javax.xml.parsers.DocumentBuilderFactory;
33 import javax.xml.parsers.ParserConfigurationException;
34 import javax.xml.transform.OutputKeys;
35 import javax.xml.transform.Transformer;
36 import javax.xml.transform.TransformerException;
37 import javax.xml.transform.TransformerFactory;
38 import javax.xml.transform.TransformerFactoryConfigurationError;
39 import javax.xml.transform.dom.DOMSource;
40 import javax.xml.transform.stream.StreamResult;
42 import org.custommonkey.xmlunit.Diff;
43 import org.custommonkey.xmlunit.XMLUnit;
44 import org.junit.Test;
45 import org.junit.runner.RunWith;
46 import org.junit.runners.Parameterized;
47 import org.opendaylight.yangtools.yang.common.QName;
48 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
49 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
50 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
51 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
52 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
53 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
54 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
55 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
56 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
59 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
60 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
61 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
62 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
63 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
64 import org.opendaylight.yangtools.yang.model.api.Module;
65 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
66 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
69 import org.w3c.dom.Document;
70 import org.w3c.dom.Element;
71 import org.xml.sax.SAXException;
73 @RunWith(Parameterized.class)
74 public class NormalizedNodeXmlTranslationTest {
75 private static final Logger logger = LoggerFactory.getLogger(NormalizedNodeXmlTranslationTest.class);
77 @Parameterized.Parameters()
78 public static Collection<Object[]> data() {
79 return Arrays.asList(new Object[][]{
80 {"augment_choice_hell.yang", "augment_choice_hell_ok.xml", augmentChoiceHell()},
81 {"augment_choice_hell.yang", "augment_choice_hell_ok2.xml", null},
82 {"test.yang", "simple.xml", null},
83 {"test.yang", "simple2.xml", null},
84 // TODO check attributes
85 {"test.yang", "simple_xml_with_attributes.xml", withAttributes()}
90 public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
91 private static Date revision;
94 revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-03-13");
95 } catch (ParseException e) {
96 throw new RuntimeException(e);
100 private static ContainerNode withAttributes() {
101 DataContainerNodeBuilder<InstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
102 b.withNodeIdentifier(getNodeIdentifier("container"));
104 CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
105 getNodeIdentifier("list"));
107 Map<QName, Object> predicates = Maps.newHashMap();
108 predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
110 DataContainerNodeBuilder<InstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
111 .mapEntryBuilder().withNodeIdentifier(
112 new InstanceIdentifier.NodeIdentifierWithPredicates(getNodeIdentifier("list").getNodeType(),
114 NormalizedNodeBuilder<InstanceIdentifier.NodeIdentifier,Object,LeafNode<Object>> uint32InListBuilder
115 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
117 list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
119 listBuilder.withChild(list1Builder.build());
120 b.withChild(listBuilder.build());
122 NormalizedNodeBuilder<InstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>> booleanBuilder
123 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
124 booleanBuilder.withValue(false);
125 b.withChild(booleanBuilder.build());
127 ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder
128 = Builders.leafSetBuilder().withNodeIdentifier(getNodeIdentifier("leafList"));
130 NormalizedNodeBuilder<InstanceIdentifier.NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder
131 = Builders.leafSetEntryBuilder().withNodeIdentifier(new InstanceIdentifier.NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
133 leafList1Builder.withValue("a");
135 leafListBuilder.withChild(leafList1Builder.build());
136 b.withChild(leafListBuilder.build());
141 private static ContainerNode augmentChoiceHell() {
143 DataContainerNodeBuilder<InstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
144 b.withNodeIdentifier(getNodeIdentifier("container"));
147 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch2"))
148 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
150 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
151 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2")).withValue("2").build())
158 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch3")).withChild(
159 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
163 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("augLeaf")).withChild(
164 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment").build())
168 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("ch")).withChild(
169 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch"))
171 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf")).withValue("1").build())
173 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
175 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf_AnotherAugment")).withValue("1").build())
177 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("deepChoice"))
179 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("deepLeafc1")).withValue("1").build()
188 private static InstanceIdentifier.NodeIdentifier getNodeIdentifier(final String localName) {
189 return new InstanceIdentifier.NodeIdentifier(QName.create(URI.create(NAMESPACE), revision, localName));
192 public static InstanceIdentifier.AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
193 Set<QName> qn = Sets.newHashSet();
195 for (String childName : childNames) {
196 qn.add(getNodeIdentifier(childName).getNodeType());
199 return new InstanceIdentifier.AugmentationIdentifier(qn);
202 public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath, final ContainerNode expectedNode) {
203 SchemaContext schema = parseTestSchema(yangPath);
204 this.xmlPath = xmlPath;
205 this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
206 this.expectedNode = expectedNode;
209 private final ContainerNode expectedNode;
210 private final ContainerSchemaNode containerNode;
211 private final String xmlPath;
214 SchemaContext parseTestSchema(final String... yangPath) {
215 YangParserImpl yangParserImpl = new YangParserImpl();
216 Set<Module> modules = yangParserImpl.parseYangModelsFromStreams(getTestYangs(yangPath));
217 return yangParserImpl.resolveSchemaContext(modules);
220 List<InputStream> getTestYangs(final String... yangPaths) {
222 return Lists.newArrayList(Collections2.transform(Lists.newArrayList(yangPaths),
223 new Function<String, InputStream>() {
225 public InputStream apply(final String input) {
226 InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(input);
227 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
228 return resourceAsStream;
234 public void testTranslation() throws Exception {
235 Document doc = loadDocument(xmlPath);
237 ContainerNode built =
238 DomToNormalizedNodeParserFactory.getInstance(DomUtils.defaultValueCodecProvider()).getContainerNodeParser().parse(
239 Collections.singletonList(doc.getDocumentElement()), containerNode);
241 if (expectedNode != null) {
242 junit.framework.Assert.assertEquals(expectedNode, built);
245 logger.info("{}", built);
247 Iterable<Element> els = DomFromNormalizedNodeSerializerFactory.getInstance(XmlDocumentUtils.getDocument(), DomUtils.defaultValueCodecProvider())
248 .getContainerNodeSerializer().serialize(containerNode, built);
250 Element el = els.iterator().next();
252 XMLUnit.setIgnoreWhitespace(true);
253 XMLUnit.setIgnoreComments(true);
255 System.err.println(toString(doc.getDocumentElement()));
256 System.err.println(toString(el));
258 boolean diff = new Diff(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())), XMLUnit.buildTestDocument(toString(el))).similar();
261 private Document loadDocument(final String xmlPath) throws Exception {
262 InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(xmlPath);
264 Document currentConfigElement = readXmlToDocument(resourceAsStream);
265 Preconditions.checkNotNull(currentConfigElement);
266 return currentConfigElement;
269 private static final DocumentBuilderFactory BUILDERFACTORY;
272 DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
273 factory.setNamespaceAware(true);
274 factory.setCoalescing(true);
275 factory.setIgnoringElementContentWhitespace(true);
276 factory.setIgnoringComments(true);
277 BUILDERFACTORY = factory;
280 private Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
281 DocumentBuilder dBuilder;
283 dBuilder = BUILDERFACTORY.newDocumentBuilder();
284 } catch (ParserConfigurationException e) {
285 throw new RuntimeException("Failed to parse XML document", e);
287 Document doc = dBuilder.parse(xmlContent);
289 doc.getDocumentElement().normalize();
293 public static String toString(final Element xml) {
295 Transformer transformer = TransformerFactory.newInstance().newTransformer();
296 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
298 StreamResult result = new StreamResult(new StringWriter());
299 DOMSource source = new DOMSource(xml);
300 transformer.transform(source, result);
302 return result.getWriter().toString();
303 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
304 throw new RuntimeException("Unable to serialize xml element " + xml, e);