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 java.io.IOException;
11 import java.io.InputStream;
12 import java.io.StringWriter;
14 import java.text.ParseException;
15 import java.text.SimpleDateFormat;
16 import java.util.Arrays;
17 import java.util.Collection;
18 import java.util.Collections;
19 import java.util.Date;
20 import java.util.List;
24 import javax.xml.parsers.DocumentBuilder;
25 import javax.xml.parsers.DocumentBuilderFactory;
26 import javax.xml.parsers.ParserConfigurationException;
27 import javax.xml.transform.OutputKeys;
28 import javax.xml.transform.Transformer;
29 import javax.xml.transform.TransformerException;
30 import javax.xml.transform.TransformerFactory;
31 import javax.xml.transform.TransformerFactoryConfigurationError;
32 import javax.xml.transform.dom.DOMSource;
33 import javax.xml.transform.stream.StreamResult;
35 import org.custommonkey.xmlunit.XMLAssert;
36 import org.custommonkey.xmlunit.XMLUnit;
37 import org.junit.Test;
38 import org.junit.runner.RunWith;
39 import org.junit.runners.Parameterized;
40 import org.opendaylight.yangtools.yang.common.QName;
41 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
43 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
44 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
45 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
47 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
48 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
49 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
51 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
52 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
53 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
54 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.serializer.NodeSerializerDispatcher;
55 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
56 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.ContainerNodeDomParser;
57 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
58 import org.opendaylight.yangtools.yang.model.api.Module;
59 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
60 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
63 import org.w3c.dom.Document;
64 import org.w3c.dom.Element;
65 import org.xml.sax.SAXException;
67 import com.google.common.base.Function;
68 import com.google.common.base.Preconditions;
69 import com.google.common.collect.Collections2;
70 import com.google.common.collect.Lists;
71 import com.google.common.collect.Maps;
72 import com.google.common.collect.Sets;
74 @RunWith(Parameterized.class)
75 public class NormalizedNodeXmlTranslationTest {
76 private static final Logger logger = LoggerFactory.getLogger(NormalizedNodeXmlTranslationTest.class);
78 @Parameterized.Parameters()
79 public static Collection<Object[]> data() {
80 return Arrays.asList(new Object[][]{
81 {"augment_choice_hell.yang", "augment_choice_hell_ok.xml", augmentChoiceHell()},
82 {"augment_choice_hell.yang", "augment_choice_hell_ok2.xml", null},
83 {"test.yang", "simple.xml", null},
84 {"test.yang", "simple2.xml", null},
85 // TODO check attributes
86 {"test.yang", "simple_xml_with_attributes.xml", withAttributes()}
91 public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
92 private static Date revision;
95 revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-03-13");
96 } catch (ParseException e) {
97 throw new RuntimeException(e);
101 private static ContainerNode withAttributes() {
102 DataContainerNodeBuilder<InstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
103 b.withNodeIdentifier(getNodeIdentifier("container"));
105 CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
106 getNodeIdentifier("list"));
108 Map<QName, Object> predicates = Maps.newHashMap();
109 predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
111 DataContainerNodeBuilder<InstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
112 .mapEntryBuilder().withNodeIdentifier(
113 new InstanceIdentifier.NodeIdentifierWithPredicates(getNodeIdentifier("list").getNodeType(),
115 NormalizedNodeBuilder<InstanceIdentifier.NodeIdentifier,Object,LeafNode<Object>> uint32InListBuilder
116 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
118 list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
120 listBuilder.withChild(list1Builder.build());
121 b.withChild(listBuilder.build());
123 NormalizedNodeBuilder<InstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>> booleanBuilder
124 = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
125 booleanBuilder.withValue(false);
126 b.withChild(booleanBuilder.build());
128 ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder
129 = Builders.leafSetBuilder().withNodeIdentifier(getNodeIdentifier("leafList"));
131 NormalizedNodeBuilder<InstanceIdentifier.NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder
132 = Builders.leafSetEntryBuilder().withNodeIdentifier(new InstanceIdentifier.NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
134 leafList1Builder.withValue("a");
136 leafListBuilder.withChild(leafList1Builder.build());
137 b.withChild(leafListBuilder.build());
142 private static ContainerNode augmentChoiceHell() {
144 DataContainerNodeBuilder<InstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
145 b.withNodeIdentifier(getNodeIdentifier("container"));
148 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch2"))
149 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
151 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
152 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2")).withValue("2").build())
159 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch3")).withChild(
160 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
164 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("augLeaf")).withChild(
165 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment").build())
169 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("ch")).withChild(
170 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch"))
172 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf")).withValue("1").build())
174 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
176 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf_AnotherAugment")).withValue("1").build())
178 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("deepChoice"))
180 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("deepLeafc1")).withValue("1").build()
189 private static InstanceIdentifier.NodeIdentifier getNodeIdentifier(String localName) {
190 return new InstanceIdentifier.NodeIdentifier(new QName(URI.create(NAMESPACE), revision, localName));
193 public static InstanceIdentifier.AugmentationIdentifier getAugmentIdentifier(String... childNames) {
194 Set<QName> qn = Sets.newHashSet();
196 for (String childName : childNames) {
197 qn.add(getNodeIdentifier(childName).getNodeType());
200 return new InstanceIdentifier.AugmentationIdentifier(null, qn);
203 public NormalizedNodeXmlTranslationTest(String yangPath, String xmlPath, ContainerNode expectedNode) {
204 SchemaContext schema = parseTestSchema(yangPath);
205 this.xmlPath = xmlPath;
206 this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
207 this.expectedNode = expectedNode;
210 private final ContainerNode expectedNode;
211 private final ContainerSchemaNode containerNode;
212 private final String xmlPath;
215 SchemaContext parseTestSchema(String... yangPath) {
216 YangParserImpl yangParserImpl = new YangParserImpl();
217 Set<Module> modules = yangParserImpl.parseYangModelsFromStreams(getTestYangs(yangPath));
218 return yangParserImpl.resolveSchemaContext(modules);
221 List<InputStream> getTestYangs(String... yangPaths) {
223 return Lists.newArrayList(Collections2.transform(Lists.newArrayList(yangPaths),
224 new Function<String, InputStream>() {
226 public InputStream apply(String input) {
227 InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(input);
228 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
229 return resourceAsStream;
235 public void testTranslation() throws Exception {
236 Document doc = loadDocument(xmlPath);
238 ContainerNode built = new ContainerNodeDomParser(DomUtils.defaultValueCodecProvider()).parse(
239 Collections.singletonList(doc.getDocumentElement()), containerNode);
241 if (expectedNode != null)
242 junit.framework.Assert.assertEquals(expectedNode, built);
244 logger.info("{}", built);
246 final Document newDoc = XmlDocumentUtils.getDocument();
247 final NodeSerializerDispatcher<Element> dispatcher = new DomNodeSerializerDispatcher(newDoc, DomUtils.defaultValueCodecProvider());
249 Iterable<Element> els = new ContainerNodeDomSerializer(newDoc,
250 dispatcher).serialize(containerNode, built);
252 Element el = els.iterator().next();
254 XMLUnit.setIgnoreWhitespace(true);
255 XMLUnit.setIgnoreComments(true);
257 XMLAssert.assertXMLEqual(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())),
258 XMLUnit.buildTestDocument(toString(el)));
261 private Document loadDocument(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(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(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);