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.Collection;
18 import java.util.Optional;
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.AfterClass;
33 import org.junit.BeforeClass;
34 import org.junit.Test;
35 import org.junit.runner.RunWith;
36 import org.junit.runners.Parameterized;
37 import org.opendaylight.yangtools.util.xml.UntrustedXML;
38 import org.opendaylight.yangtools.yang.common.QName;
39 import org.opendaylight.yangtools.yang.common.QNameModule;
40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
42 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
43 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
45 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
47 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
48 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
49 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
50 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
52 import org.opendaylight.yangtools.yang.model.api.Module;
53 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
54 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
55 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
56 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
57 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
58 import org.w3c.dom.Document;
59 import org.w3c.dom.Node;
60 import org.xml.sax.SAXException;
62 @RunWith(Parameterized.class)
63 public class YangModeledAnyXMLSerializationTest extends XMLTestCase {
64 @Parameterized.Parameters(name = "{0}")
65 public static Collection<Object[]> data() {
66 return TestFactories.junitParameters();
69 private final QNameModule bazModuleQName = QNameModule.create(URI.create("baz"));
70 private final QName myAnyXMLDataBaz = QName.create(bazModuleQName, "my-anyxml-data");
71 private final QName bazQName = QName.create(bazModuleQName, "baz");
72 private final QName myContainer2QName = QName.create(bazModuleQName, "my-container-2");
74 private static SchemaContext SCHEMA_CONTEXT;
76 private final XMLOutputFactory factory;
78 public YangModeledAnyXMLSerializationTest(final String factoryMode, final XMLOutputFactory factory) {
79 this.factory = factory;
83 public static void beforeClass() {
84 SCHEMA_CONTEXT = YangParserTestUtils.parseYangResourceDirectory("/anyxml-support/serialization");
88 public static void afterClass() {
89 SCHEMA_CONTEXT = null;
93 public void testSerializationOfBaz() throws Exception {
94 final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream(
95 "/anyxml-support/serialization/baz.xml");
96 final Module bazModule = SCHEMA_CONTEXT.findModules("baz").iterator().next();
97 final ContainerSchemaNode bazCont = (ContainerSchemaNode) bazModule.getDataChildByName(
98 QName.create(bazModule.getQNameModule(), "baz"));
99 assertNotNull(bazCont);
101 final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
103 final NormalizedNodeResult result = new NormalizedNodeResult();
105 final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
107 final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, SCHEMA_CONTEXT, bazCont);
108 xmlParser.parse(reader);
110 final NormalizedNode<?, ?> transformedInput = result.getResult();
111 assertNotNull(transformedInput);
113 assertTrue(transformedInput instanceof ContainerNode);
114 ContainerNode bazContainer = (ContainerNode) transformedInput;
115 assertEquals(bazContainer.getNodeType(), bazQName);
117 Optional<DataContainerChild<? extends PathArgument, ?>> bazContainerChild = bazContainer.getChild(
118 new NodeIdentifier(myAnyXMLDataBaz));
119 assertTrue(bazContainerChild.orElse(null) instanceof YangModeledAnyXmlNode);
120 YangModeledAnyXmlNode yangModeledAnyXmlNode = (YangModeledAnyXmlNode) bazContainerChild.get();
122 DataSchemaNode schemaOfAnyXmlData = yangModeledAnyXmlNode.getSchemaOfAnyXmlData();
123 SchemaNode myContainer2SchemaNode = SchemaContextUtil.findDataSchemaNode(SCHEMA_CONTEXT,
124 SchemaPath.create(true, bazQName, myContainer2QName));
125 assertTrue(myContainer2SchemaNode instanceof ContainerSchemaNode);
126 assertEquals(myContainer2SchemaNode, schemaOfAnyXmlData);
128 final Document document = UntrustedXML.newDocumentBuilder().newDocument();
129 final DOMResult domResult = new DOMResult(document);
131 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
133 final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter
134 .create(xmlStreamWriter, SCHEMA_CONTEXT);
136 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
137 xmlNormalizedNodeStreamWriter);
139 normalizedNodeWriter.write(transformedInput);
141 final Document doc = loadDocument("/anyxml-support/serialization/baz.xml");
143 XMLUnit.setIgnoreWhitespace(true);
144 XMLUnit.setIgnoreComments(true);
145 XMLUnit.setIgnoreAttributeOrder(true);
146 XMLUnit.setNormalize(true);
148 String expectedXml = toString(doc.getDocumentElement());
149 String serializedXml = toString(domResult.getNode());
151 assertXMLEqual(expectedXml, serializedXml);
154 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
155 final InputStream resourceAsStream = YangModeledAnyXMLSerializationTest.class.getResourceAsStream(xmlPath);
156 return requireNonNull(readXmlToDocument(resourceAsStream));
159 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
160 final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
161 doc.getDocumentElement().normalize();
165 private static String toString(final Node xml) {
167 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
168 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
169 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
171 final StreamResult result = new StreamResult(new StringWriter());
172 final DOMSource source = new DOMSource(xml);
173 transformer.transform(source, result);
175 return result.getWriter().toString();
176 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
177 throw new RuntimeException("Unable to serialize xml element " + xml, e);