2 * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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.codec.xml;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertTrue;
15 import java.io.IOException;
16 import java.io.StringWriter;
17 import java.net.URISyntaxException;
18 import java.util.Collection;
19 import javax.xml.stream.XMLOutputFactory;
20 import javax.xml.stream.XMLStreamException;
21 import javax.xml.stream.XMLStreamReader;
22 import javax.xml.stream.XMLStreamWriter;
23 import javax.xml.transform.TransformerException;
24 import javax.xml.transform.dom.DOMResult;
25 import javax.xml.transform.dom.DOMSource;
26 import org.custommonkey.xmlunit.Diff;
27 import org.custommonkey.xmlunit.DifferenceListener;
28 import org.custommonkey.xmlunit.IgnoreTextAndAttributeValuesDifferenceListener;
29 import org.custommonkey.xmlunit.XMLAssert;
30 import org.custommonkey.xmlunit.XMLUnit;
31 import org.junit.Test;
32 import org.junit.runner.RunWith;
33 import org.junit.runners.Parameterized;
34 import org.opendaylight.yangtools.util.xml.UntrustedXML;
35 import org.opendaylight.yangtools.yang.data.api.schema.AnydataNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedAnydata;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
41 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnydataNodeBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.util.ImmutableNormalizedAnydata;
45 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
46 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
48 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
49 import org.w3c.dom.Document;
50 import org.xml.sax.SAXException;
52 @RunWith(Parameterized.class)
53 public class AnydataSerializeTest extends AbstractAnydataTest {
55 @Parameterized.Parameters(name = "{0}")
56 public static Collection<Object[]> data() {
57 return TestFactories.junitParameters();
60 private final XMLOutputFactory factory;
62 public AnydataSerializeTest(final String factoryMode, final XMLOutputFactory factory) {
63 this.factory = factory;
67 public void testDOMAnydata() throws XMLStreamException, IOException {
68 final StringWriter writer = new StringWriter();
69 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
71 final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
72 xmlStreamWriter, SCHEMA_CONTEXT);
73 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
74 xmlNormalizedNodeStreamWriter);
75 normalizedNodeWriter.write(ImmutableAnydataNodeBuilder.create(DOMSourceAnydata.class)
76 .withNodeIdentifier(FOO_NODEID).withValue(toDOMSource("<bar xmlns=\"test-anydata\"/>")).build());
77 normalizedNodeWriter.flush();
79 final String serializedXml = writer.toString();
80 assertEquals("<foo xmlns=\"test-anydata\"><bar xmlns=\"test-anydata\"></bar></foo>", serializedXml);
84 public void testXmlParseAnydata()
85 throws IOException, SAXException, XMLStreamException, URISyntaxException, TransformerException {
87 //Create Data Scheme from yang file
88 SchemaPath anydataPath = SchemaPath.create(true, FOO_QNAME);
89 final SchemaNode dataSchemaNode = SchemaContextUtil.findDataSchemaNode(SCHEMA_CONTEXT, anydataPath);
90 assertTrue(dataSchemaNode instanceof AnydataSchemaNode);
91 final AnydataSchemaNode anyDataSchemaNode = (AnydataSchemaNode) dataSchemaNode;
94 final XMLStreamReader reader
95 = UntrustedXML.createXMLStreamReader(loadResourcesAsInputStream("/test-anydata.xml"));
97 final NormalizedNodeResult result = new NormalizedNodeResult();
98 final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
99 final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, SCHEMA_CONTEXT, anyDataSchemaNode);
100 xmlParser.parse(reader);
102 final NormalizedNode<?, ?> transformedInput = result.getResult();
103 assertNotNull(transformedInput);
104 assertTrue(transformedInput instanceof AnydataNode);
105 AnydataNode<?> anydataNode = (AnydataNode<?>) transformedInput;
108 final StringWriter writer = new StringWriter();
109 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
110 final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
111 xmlStreamWriter, SCHEMA_CONTEXT);
112 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
113 xmlNormalizedNodeStreamWriter);
114 normalizedNodeWriter.write(transformedInput);
115 normalizedNodeWriter.flush();
117 final String serializedXml = writer.toString();
118 final String deserializeXml = getXmlFromDOMSource(((DOMSourceAnydata) anydataNode.getValue()).getSource());
119 assertFalse(serializedXml.isEmpty());
121 // Check if is Serialize Node same as Deserialize Node
122 XMLUnit.setIgnoreWhitespace(true);
123 XMLUnit.setNormalize(true);
124 final Diff diff = new Diff(deserializeXml, serializedXml);
125 final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
126 diff.overrideDifferenceListener(differenceListener);
128 XMLAssert.assertXMLEqual(diff, true);
132 public void testAnydataLoadFromXML() throws IOException, SAXException, XMLStreamException, URISyntaxException {
134 Document doc = loadXmlDocument("/test-anydata.xml");
135 final DOMSource domSource = new DOMSource(doc.getDocumentElement());
137 //Load XML from file and write it with xmlParseStream
138 final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
139 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
140 final AnydataSchemaNode anyDataSchemaNode = (AnydataSchemaNode) SchemaContextUtil.findDataSchemaNode(
141 SCHEMA_CONTEXT, SchemaPath.create(true, FOO_QNAME));
142 final NormalizedNodeStreamWriter streamWriter = XMLStreamNormalizedNodeStreamWriter.create(
143 xmlStreamWriter, SCHEMA_CONTEXT);
144 final XMLStreamReader reader = new DOMSourceXMLStreamReader(domSource);
145 final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, SCHEMA_CONTEXT, anyDataSchemaNode);
147 xmlParser.parse(reader);
151 XMLUnit.setIgnoreWhitespace(true);
152 XMLUnit.setNormalize(true);
155 final String expectedXml = toString(doc.getDocumentElement());
156 final String serializedXml = toString(domResult.getNode());
157 final Diff diff = new Diff(expectedXml, serializedXml);
158 final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
159 diff.overrideDifferenceListener(differenceListener);
161 XMLAssert.assertXMLEqual(diff, true);
165 public void testAnydataSerialization()
166 throws IOException, SAXException, XMLStreamException, URISyntaxException, TransformerException {
168 Document doc = loadXmlDocument("/test-anydata.xml");
169 final DOMSource domSource = new DOMSource(doc.getDocumentElement());
171 //Get specific attribute from Yang file.
172 final AnydataSchemaNode contWithAttr = (AnydataSchemaNode) SchemaContextUtil.findDataSchemaNode(
173 SCHEMA_CONTEXT, SchemaPath.create(true, FOO_QNAME));
175 //Create NormalizedNodeResult
176 NormalizedNodeResult normalizedResult = new NormalizedNodeResult();
177 final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(normalizedResult);
179 //Initialize Reader with XML file
180 final XMLStreamReader reader = new DOMSourceXMLStreamReader(domSource);
181 final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, SCHEMA_CONTEXT, contWithAttr);
182 xmlParser.parse(reader);
186 final NormalizedNode<?, ?> node = normalizedResult.getResult();
187 assertTrue(node instanceof AnydataNode);
188 final AnydataNode<?> anydataResult = (AnydataNode<?>) node;
190 //Get Result in formatted String
191 assertTrue(anydataResult.getValue() instanceof DOMSourceAnydata);
192 final String serializedXml = getXmlFromDOMSource(((DOMSourceAnydata)anydataResult.getValue()).getSource());
193 final String expectedXml = toString(doc.getDocumentElement());
195 //Looking for difference in Serialized xml and in Loaded XML
196 final Diff diff = new Diff(expectedXml, serializedXml);
197 final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
198 diff.overrideDifferenceListener(differenceListener);
200 XMLAssert.assertXMLEqual(diff, true);
204 public void testSiblingSerialize() throws IOException, XMLStreamException {
205 final StringWriter writer = new StringWriter();
206 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
208 final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
209 xmlStreamWriter, SCHEMA_CONTEXT);
210 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
211 xmlNormalizedNodeStreamWriter);
212 normalizedNodeWriter.write(ImmutableContainerNodeBuilder.create().withNodeIdentifier(CONT_NODEID)
213 .withChild(ImmutableAnydataNodeBuilder.create(DOMSourceAnydata.class).withNodeIdentifier(CONT_ANY_NODEID)
214 .withValue(toDOMSource("<bar xmlns=\"test-anydata\"/>")).build())
215 .withChild(CONT_LEAF)
217 normalizedNodeWriter.flush();
219 final String serializedXml = writer.toString();
220 assertEquals("<cont xmlns=\"test-anydata\"><cont-any><bar xmlns=\"test-anydata\"></bar></cont-any>"
221 + "<cont-leaf>abc</cont-leaf></cont>", serializedXml);
225 public void testNormalizedSerialize() throws IOException, XMLStreamException {
226 final StringWriter writer = new StringWriter();
227 final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
229 final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
230 xmlStreamWriter, SCHEMA_CONTEXT);
231 final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
232 xmlNormalizedNodeStreamWriter);
233 normalizedNodeWriter.write(ImmutableContainerNodeBuilder.create().withNodeIdentifier(CONT_NODEID)
234 .withChild(ImmutableAnydataNodeBuilder.create(NormalizedAnydata.class).withNodeIdentifier(CONT_ANY_NODEID)
235 .withValue(new ImmutableNormalizedAnydata(SCHEMA_CONTEXT,
236 SCHEMA_CONTEXT.findDataChildByName(CONT_QNAME).get(), ImmutableContainerNodeBuilder.create()
237 .withNodeIdentifier(CONT_NODEID).build())).build())
239 normalizedNodeWriter.flush();
241 final String serializedXml = writer.toString();
242 assertEquals("<cont xmlns=\"test-anydata\"><cont-any><cont/></cont-any></cont>", serializedXml);