2 * Copyright (c) 2016 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
9 package org.opendaylight.yangtools.yang.data.codec.xml;
11 import static java.util.Objects.requireNonNull;
13 import java.io.IOException;
14 import java.io.InputStream;
15 import java.io.StringWriter;
17 import java.util.Optional;
18 import javax.xml.stream.XMLInputFactory;
19 import javax.xml.stream.XMLOutputFactory;
20 import javax.xml.stream.XMLStreamReader;
21 import javax.xml.stream.XMLStreamWriter;
22 import javax.xml.transform.OutputKeys;
23 import javax.xml.transform.Transformer;
24 import javax.xml.transform.TransformerException;
25 import javax.xml.transform.TransformerFactory;
26 import javax.xml.transform.TransformerFactoryConfigurationError;
27 import javax.xml.transform.dom.DOMResult;
28 import javax.xml.transform.dom.DOMSource;
29 import javax.xml.transform.stream.StreamResult;
30 import org.custommonkey.xmlunit.XMLTestCase;
31 import org.custommonkey.xmlunit.XMLUnit;
32 import org.junit.Test;
33 import org.opendaylight.yangtools.util.xml.UntrustedXML;
34 import org.opendaylight.yangtools.yang.common.QName;
35 import org.opendaylight.yangtools.yang.common.QNameModule;
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.Module;
49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
50 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
52 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
53 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
54 import org.w3c.dom.Document;
55 import org.w3c.dom.Node;
56 import org.xml.sax.SAXException;
58 public class YangModeledAnyXMLSerializationTest extends XMLTestCase {
60 private final QNameModule bazModuleQName;
61 private final QName myAnyXMLDataBaz;
62 private final QName bazQName;
63 private final QName myContainer2QName;
64 private final SchemaContext schemaContext;
66 public YangModeledAnyXMLSerializationTest() throws Exception {
67 bazModuleQName = QNameModule.create(new URI("baz"), QName.parseRevision("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");
72 schemaContext = YangParserTestUtils.parseYangResourceDirectory("/anyxml-support/serialization");
76 public void testSerializationOfBaz() throws Exception {
77 final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream(
78 "/anyxml-support/serialization/baz.xml");
79 final Module bazModule = schemaContext.findModules("baz").iterator().next();
80 final ContainerSchemaNode bazCont = (ContainerSchemaNode) bazModule.getDataChildByName(
81 QName.create(bazModule.getQNameModule(), "baz"));
82 assertNotNull(bazCont);
84 final XMLInputFactory inputFactory = XMLInputFactory.newInstance();
85 final XMLStreamReader reader = inputFactory.createXMLStreamReader(resourceAsStream);
87 final NormalizedNodeResult result = new NormalizedNodeResult();
89 final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
91 final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, bazCont);
92 xmlParser.parse(reader);
94 final NormalizedNode<?, ?> transformedInput = result.getResult();
95 assertNotNull(transformedInput);
97 assertTrue(transformedInput instanceof ContainerNode);
98 ContainerNode bazContainer = (ContainerNode) transformedInput;
99 assertEquals(bazContainer.getNodeType(), bazQName);
101 Optional<DataContainerChild<? extends PathArgument, ?>> bazContainerChild = bazContainer.getChild(
102 new NodeIdentifier(myAnyXMLDataBaz));
103 assertTrue(bazContainerChild.orElse(null) instanceof YangModeledAnyXmlNode);
104 YangModeledAnyXmlNode yangModeledAnyXmlNode = (YangModeledAnyXmlNode) bazContainerChild.get();
106 DataSchemaNode schemaOfAnyXmlData = yangModeledAnyXmlNode.getSchemaOfAnyXmlData();
107 SchemaNode myContainer2SchemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext,
108 SchemaPath.create(true, bazQName, myContainer2QName));
109 assertTrue(myContainer2SchemaNode instanceof ContainerSchemaNode);
110 assertEquals(myContainer2SchemaNode, schemaOfAnyXmlData);
112 final Document document = UntrustedXML.newDocumentBuilder().newDocument();
113 final DOMResult domResult = new DOMResult(document);
115 final XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
116 outputFactory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
118 final XMLStreamWriter xmlStreamWriter = outputFactory.createXMLStreamWriter(domResult);
120 final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter
121 .create(xmlStreamWriter, schemaContext);
123 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
124 xmlNormalizedNodeStreamWriter);
126 normalizedNodeWriter.write(transformedInput);
128 final Document doc = loadDocument("/anyxml-support/serialization/baz.xml");
130 XMLUnit.setIgnoreWhitespace(true);
131 XMLUnit.setIgnoreComments(true);
132 XMLUnit.setIgnoreAttributeOrder(true);
133 XMLUnit.setNormalize(true);
135 String expectedXml = toString(doc.getDocumentElement());
136 String serializedXml = toString(domResult.getNode());
138 assertXMLEqual(expectedXml, serializedXml);
141 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
142 final InputStream resourceAsStream = YangModeledAnyXMLSerializationTest.class.getResourceAsStream(xmlPath);
143 return requireNonNull(readXmlToDocument(resourceAsStream));
146 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
147 final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
148 doc.getDocumentElement().normalize();
152 private static String toString(final Node xml) {
154 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
155 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
156 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
158 final StreamResult result = new StreamResult(new StringWriter());
159 final DOMSource source = new DOMSource(xml);
160 transformer.transform(source, result);
162 return result.getWriter().toString();
163 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
164 throw new RuntimeException("Unable to serialize xml element " + xml, e);