be7006f3e05101441071e812f3d03155c4faf54c
[yangtools.git] / yang / yang-data-codec-xml / src / test / java / org / opendaylight / yangtools / yang / data / codec / xml / YangModeledAnyXMLSerializationTest.java
1 /*
2  * Copyright (c) 2016 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
9 package org.opendaylight.yangtools.yang.data.codec.xml;
10
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import java.io.IOException;
14 import java.io.InputStream;
15 import java.io.StringWriter;
16 import java.net.URI;
17 import javax.xml.stream.XMLInputFactory;
18 import javax.xml.stream.XMLOutputFactory;
19 import javax.xml.stream.XMLStreamReader;
20 import javax.xml.stream.XMLStreamWriter;
21 import javax.xml.transform.OutputKeys;
22 import javax.xml.transform.Transformer;
23 import javax.xml.transform.TransformerException;
24 import javax.xml.transform.TransformerFactory;
25 import javax.xml.transform.TransformerFactoryConfigurationError;
26 import javax.xml.transform.dom.DOMResult;
27 import javax.xml.transform.dom.DOMSource;
28 import javax.xml.transform.stream.StreamResult;
29 import org.custommonkey.xmlunit.XMLTestCase;
30 import org.custommonkey.xmlunit.XMLUnit;
31 import org.junit.Test;
32 import org.opendaylight.yangtools.util.xml.UntrustedXML;
33 import org.opendaylight.yangtools.yang.common.QName;
34 import org.opendaylight.yangtools.yang.common.QNameModule;
35 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
38 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
42 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
43 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
45 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
46 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
49 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
50 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
51 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
52 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
53 import org.w3c.dom.Document;
54 import org.w3c.dom.Node;
55 import org.xml.sax.SAXException;
56
57 public class YangModeledAnyXMLSerializationTest extends XMLTestCase {
58
59     private final QNameModule bazModuleQName;
60     private final QName myAnyXMLDataBaz;
61     private final QName bazQName;
62     private final QName myContainer2QName;
63     private final SchemaContext schemaContext;
64
65     public YangModeledAnyXMLSerializationTest() throws Exception {
66         bazModuleQName = QNameModule.create(new URI("baz"), SimpleDateFormatUtil.getRevisionFormat()
67                 .parse("1970-01-01"));
68         bazQName = QName.create(bazModuleQName, "baz");
69         myContainer2QName = QName.create(bazModuleQName, "my-container-2");
70         myAnyXMLDataBaz = QName.create(bazModuleQName, "my-anyxml-data");
71
72         schemaContext = YangParserTestUtils.parseYangSources("/anyxml-support/serialization");
73     }
74
75     @Test
76     public void testSerializationOfBaz() throws Exception {
77         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream(
78                 "/anyxml-support/serialization/baz.xml");
79
80         final XMLInputFactory inputFactory = XMLInputFactory.newInstance();
81         final XMLStreamReader reader = inputFactory.createXMLStreamReader(resourceAsStream);
82
83         final NormalizedNodeResult result = new NormalizedNodeResult();
84
85         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
86
87         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, schemaContext);
88         xmlParser.parse(reader);
89
90         final NormalizedNode<?, ?> transformedInput = result.getResult();
91         assertNotNull(transformedInput);
92
93         assertTrue(transformedInput instanceof ContainerNode);
94         ContainerNode bazContainer = (ContainerNode) transformedInput;
95         assertEquals(bazContainer.getNodeType(), bazQName);
96
97         Optional<DataContainerChild<? extends PathArgument, ?>> bazContainerChild = bazContainer.getChild(
98                 new NodeIdentifier(myAnyXMLDataBaz));
99         assertTrue(bazContainerChild.orNull() instanceof YangModeledAnyXmlNode);
100         YangModeledAnyXmlNode yangModeledAnyXmlNode = (YangModeledAnyXmlNode) bazContainerChild.get();
101
102         DataSchemaNode schemaOfAnyXmlData = yangModeledAnyXmlNode.getSchemaOfAnyXmlData();
103         SchemaNode myContainer2SchemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext,
104                 SchemaPath.create(true, bazQName, myContainer2QName));
105         assertTrue(myContainer2SchemaNode instanceof ContainerSchemaNode);
106         assertEquals(myContainer2SchemaNode, schemaOfAnyXmlData);
107
108         final Document document = UntrustedXML.newDocumentBuilder().newDocument();
109         final DOMResult domResult = new DOMResult(document);
110
111         final XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
112         outputFactory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
113
114         final XMLStreamWriter xmlStreamWriter = outputFactory.createXMLStreamWriter(domResult);
115
116         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter
117                 .create(xmlStreamWriter, schemaContext);
118
119         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
120                 xmlNormalizedNodeStreamWriter);
121
122         normalizedNodeWriter.write(transformedInput);
123
124         final Document doc = loadDocument("/anyxml-support/serialization/baz.xml");
125
126         XMLUnit.setIgnoreWhitespace(true);
127         XMLUnit.setIgnoreComments(true);
128         XMLUnit.setIgnoreAttributeOrder(true);
129         XMLUnit.setNormalize(true);
130
131         String expectedXml = toString(doc.getDocumentElement().getElementsByTagName("baz").item(0));
132         String serializedXml = toString(domResult.getNode());
133
134         assertXMLEqual(expectedXml, serializedXml);
135     }
136
137     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
138         final InputStream resourceAsStream = YangModeledAnyXMLSerializationTest.class.getResourceAsStream(xmlPath);
139         final Document currentConfigElement = readXmlToDocument(resourceAsStream);
140         Preconditions.checkNotNull(currentConfigElement);
141         return currentConfigElement;
142     }
143
144     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
145         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
146         doc.getDocumentElement().normalize();
147         return doc;
148     }
149
150     private static String toString(final Node xml) {
151         try {
152             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
153             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
154             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
155
156             final StreamResult result = new StreamResult(new StringWriter());
157             final DOMSource source = new DOMSource(xml);
158             transformer.transform(source, result);
159
160             return result.getWriter().toString();
161         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
162             throw new RuntimeException("Unable to serialize xml element " + xml, e);
163         }
164     }
165 }