Bug 3874: Support of yang modeled AnyXML - XML deserialization
[yangtools.git] / yang / yang-data-impl / src / test / java / org / opendaylight / yangtools / yang / data / impl / schema / transform / dom / serializer / retest / YangModeledAnyXMLDeserializationTest.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.serializer.retest;
9
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertTrue;
13
14 import com.google.common.base.Optional;
15 import com.google.common.base.Preconditions;
16 import java.io.File;
17 import java.io.IOException;
18 import java.io.InputStream;
19 import java.net.URI;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.List;
23 import javax.xml.parsers.DocumentBuilder;
24 import javax.xml.parsers.DocumentBuilderFactory;
25 import javax.xml.parsers.ParserConfigurationException;
26 import javax.xml.stream.XMLOutputFactory;
27 import org.junit.Before;
28 import org.junit.Test;
29 import org.opendaylight.yangtools.yang.common.QName;
30 import org.opendaylight.yangtools.yang.common.QNameModule;
31 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
36 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
38 import org.opendaylight.yangtools.yang.data.impl.RetestUtils;
39 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
40 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
41 import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
42 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
45 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
46 import org.opendaylight.yangtools.yang.model.api.Status;
47 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
49 import org.w3c.dom.Document;
50 import org.xml.sax.SAXException;
51
52 public class YangModeledAnyXMLDeserializationTest {
53     private static final XMLOutputFactory XML_FACTORY;
54     private static final DocumentBuilderFactory BUILDERFACTORY;
55
56     static {
57         XML_FACTORY = XMLOutputFactory.newFactory();
58         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
59
60         BUILDERFACTORY = DocumentBuilderFactory.newInstance();
61         BUILDERFACTORY.setNamespaceAware(true);
62         BUILDERFACTORY.setCoalescing(true);
63         BUILDERFACTORY.setIgnoringElementContentWhitespace(true);
64         BUILDERFACTORY.setIgnoringComments(true);
65     }
66
67     private QNameModule fooModuleQName;
68     private QNameModule barModuleQName;
69     private QName myContainer1;
70     private QName myContainer2;
71     private QName innerContainer;
72     private QName myLeaf3;
73     private QName myLeaf2;
74     private QName myLeaf1;
75     private QName myAnyXMLDataBar;
76     private QName myAnyXMLDataFoo;
77     private SchemaContext schemaContext;
78
79     @Before
80     public void Init() throws Exception {
81         barModuleQName = QNameModule.create(new URI("bar"), SimpleDateFormatUtil.getRevisionFormat()
82                 .parse("1970-01-01"));
83         myContainer1 = QName.create(barModuleQName, "my-container-1");
84         myLeaf1 = QName.create(barModuleQName, "my-leaf-1");
85         myAnyXMLDataBar = QName.create(barModuleQName, "my-anyxml-data");
86
87         fooModuleQName = QNameModule.create(new URI("foo"), SimpleDateFormatUtil.getRevisionFormat()
88                 .parse("1970-01-01"));
89         myContainer2 = QName.create(fooModuleQName, "my-container-2");
90         innerContainer = QName.create(fooModuleQName, "inner-container");
91         myLeaf3 = QName.create(fooModuleQName, "my-leaf-3");
92         myLeaf2 = QName.create(fooModuleQName, "my-leaf-2");
93         myAnyXMLDataFoo = QName.create(fooModuleQName, "my-anyxml-data");
94         schemaContext = RetestUtils.parseYangSources(new File(getClass().getResource("/anyxml-support/yang/foo.yang")
95                 .toURI()), new File(getClass().getResource("/anyxml-support/yang/bar.yang").toURI()), new File(getClass().getResource("/anyxml-support/yang/yang-ext.yang").toURI()));
96     }
97
98     @Test
99     public void testRawAnyXMLFromBar() throws Exception {
100         final Document doc = loadDocument("/anyxml-support/xml/bar.xml");
101
102         DataSchemaNode barContainer = schemaContext.getDataChildByName("bar");
103         assertTrue(barContainer instanceof ContainerSchemaNode);
104         final YangModeledAnyXmlSchemaNode yangModeledAnyXML = new YangModeledAnyXMLSchemaNodeImplTest(myAnyXMLDataBar,
105                 (ContainerSchemaNode) barContainer);
106
107         final YangModeledAnyXmlNode output = DomToNormalizedNodeParserFactory
108                 .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext).getYangModeledAnyXmlNodeParser()
109                 .parse(Collections.singletonList(doc.getDocumentElement()), yangModeledAnyXML);
110
111         assertNotNull(output);
112
113         DataSchemaNode schemaOfAnyXmlData = output.getSchemaOfAnyXmlData();
114         assertEquals(barContainer, schemaOfAnyXmlData);
115
116         Collection<DataContainerChild<? extends PathArgument, ?>> value = output.getValue();
117         assertEquals(2, value.size());
118
119         Optional<DataContainerChild<? extends PathArgument, ?>> child = output
120                 .getChild(new NodeIdentifier(myContainer1));
121         assertTrue(child.orNull() instanceof ContainerNode);
122         ContainerNode myContainerNode1 = (ContainerNode) child.get();
123
124         Optional<DataContainerChild<? extends PathArgument, ?>> child2 = myContainerNode1.getChild(new NodeIdentifier(
125                 myLeaf1));
126         assertTrue(child2.orNull() instanceof LeafNode);
127         LeafNode<?> LeafNode1 = (LeafNode<?>) child2.get();
128
129         Object leafNode1Value = LeafNode1.getValue();
130         assertEquals("value1", leafNode1Value);
131     }
132
133     @Test
134     public void testRealSchemaContextFromFoo() throws Exception {
135         final Document doc = loadDocument("/anyxml-support/xml/foo.xml");
136
137         final ContainerNode output = DomToNormalizedNodeParserFactory
138                 .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext).getContainerNodeParser()
139                 .parse(Collections.singletonList(doc.getDocumentElement()), schemaContext);
140
141         assertNotNull(output);
142
143         Optional<DataContainerChild<? extends PathArgument, ?>> child = output.getChild(new NodeIdentifier(
144                 myAnyXMLDataFoo));
145         assertTrue(child.orNull() instanceof YangModeledAnyXmlNode);
146         YangModeledAnyXmlNode yangModeledAnyXmlNode = (YangModeledAnyXmlNode) child.get();
147
148         DataSchemaNode schemaOfAnyXmlData = yangModeledAnyXmlNode.getSchemaOfAnyXmlData();
149         DataSchemaNode expectedSchemaOfAnyXmlData = schemaContext.getDataChildByName(myContainer2);
150         assertEquals(expectedSchemaOfAnyXmlData, schemaOfAnyXmlData);
151
152         Collection<DataContainerChild<? extends PathArgument, ?>> value = yangModeledAnyXmlNode.getValue();
153         assertEquals(2, value.size());
154
155         Optional<DataContainerChild<? extends PathArgument, ?>> child2 = yangModeledAnyXmlNode
156                 .getChild(new NodeIdentifier(innerContainer));
157         assertTrue(child2.orNull() instanceof ContainerNode);
158         ContainerNode innerContainerNode = (ContainerNode) child2.get();
159
160         Optional<DataContainerChild<? extends PathArgument, ?>> child3 = innerContainerNode
161                 .getChild(new NodeIdentifier(myLeaf2));
162         assertTrue(child3.orNull() instanceof LeafNode);
163         LeafNode<?> LeafNode2 = (LeafNode<?>) child3.get();
164
165         Object leafNode2Value = LeafNode2.getValue();
166         assertEquals("any-xml-leaf-2-value", leafNode2Value);
167
168         Optional<DataContainerChild<? extends PathArgument, ?>> child4 = yangModeledAnyXmlNode
169                 .getChild(new NodeIdentifier(myLeaf3));
170         assertTrue(child4.orNull() instanceof LeafNode);
171         LeafNode<?> LeafNode3 = (LeafNode<?>) child4.get();
172
173         Object leafNode3Value = LeafNode3.getValue();
174         assertEquals("any-xml-leaf-3-value", leafNode3Value);
175     }
176
177     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
178         final InputStream resourceAsStream = YangModeledAnyXMLDeserializationTest.class.getResourceAsStream(xmlPath);
179
180         final Document currentConfigElement = readXmlToDocument(resourceAsStream);
181         Preconditions.checkNotNull(currentConfigElement);
182         return currentConfigElement;
183     }
184
185     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
186         final DocumentBuilder dBuilder;
187         try {
188             dBuilder = BUILDERFACTORY.newDocumentBuilder();
189         } catch (final ParserConfigurationException e) {
190             throw new RuntimeException("Failed to parse XML document", e);
191         }
192         final Document doc = dBuilder.parse(xmlContent);
193
194         doc.getDocumentElement().normalize();
195         return doc;
196     }
197
198     static class YangModeledAnyXMLSchemaNodeImplTest implements YangModeledAnyXmlSchemaNode {
199         private final QName qName;
200         private final ContainerSchemaNode contentSchema;
201
202         public YangModeledAnyXMLSchemaNodeImplTest(QName qName, ContainerSchemaNode contentSchema) {
203             this.qName = qName;
204             this.contentSchema = contentSchema;
205         }
206
207         @Override
208         public boolean isAugmenting() {
209             return false;
210         }
211
212         @Override
213         public boolean isAddedByUses() {
214             return false;
215         }
216
217         @Override
218         public boolean isConfiguration() {
219             return false;
220         }
221
222         @Override
223         public ConstraintDefinition getConstraints() {
224             return null;
225         }
226
227         @Override
228         public QName getQName() {
229             return qName;
230         }
231
232         @Override
233         public SchemaPath getPath() {
234             return null;
235         }
236
237         @Override
238         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
239             return null;
240         }
241
242         @Override
243         public String getDescription() {
244             return null;
245         }
246
247         @Override
248         public String getReference() {
249             return null;
250         }
251
252         @Override
253         public Status getStatus() {
254             return null;
255         }
256
257         @Override
258         public ContainerSchemaNode getSchemaOfAnyXmlData() {
259             return contentSchema;
260         }
261     }
262 }