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
8 package org.opendaylight.yangtools.yang.data.codec.xml;
10 import static java.util.Objects.requireNonNull;
12 import java.io.IOException;
13 import java.io.InputStream;
14 import java.io.StringWriter;
15 import java.util.Base64;
16 import javax.xml.stream.XMLStreamException;
17 import javax.xml.stream.XMLStreamWriter;
18 import javax.xml.transform.OutputKeys;
19 import javax.xml.transform.Transformer;
20 import javax.xml.transform.TransformerException;
21 import javax.xml.transform.TransformerFactory;
22 import javax.xml.transform.TransformerFactoryConfigurationError;
23 import javax.xml.transform.dom.DOMResult;
24 import javax.xml.transform.dom.DOMSource;
25 import javax.xml.transform.stream.StreamResult;
26 import org.custommonkey.xmlunit.XMLTestCase;
27 import org.custommonkey.xmlunit.XMLUnit;
28 import org.junit.Test;
29 import org.opendaylight.yangtools.util.xml.UntrustedXML;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.common.QNameModule;
32 import org.opendaylight.yangtools.yang.common.Revision;
33 import org.opendaylight.yangtools.yang.common.XMLNamespace;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
37 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
40 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
43 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
44 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
45 import org.w3c.dom.Document;
46 import org.w3c.dom.Node;
47 import org.xml.sax.SAXException;
49 public class Bug5446Test extends XMLTestCase {
50 private static final QNameModule FOO_MODULE = QNameModule.create(XMLNamespace.of("foo"), Revision.of("2015-11-05"));
51 private static final QName ROOT_QNAME = QName.create(FOO_MODULE, "root");
52 private static final QName IP_ADDRESS_QNAME = QName.create(FOO_MODULE, "ip-address");
55 public void test() throws Exception {
56 final EffectiveModelContext schemaContext = YangParserTestUtils.parseYangResource("/bug5446/yang/foo.yang");
57 final Document doc = loadDocument("/bug5446/xml/foo.xml");
59 final ContainerNode docNode = createDocNode();
61 DataContainerChild root = docNode.childByArg(new NodeIdentifier(ROOT_QNAME));
62 DataContainerChild child = ((ContainerNode) root).childByArg(new NodeIdentifier(IP_ADDRESS_QNAME));
63 LeafNode<?> ipAdress = (LeafNode<?>) child;
65 Object value = ipAdress.body();
66 assertTrue(value instanceof byte[]);
67 assertEquals("fwAAAQ==", Base64.getEncoder().encodeToString((byte[]) value));
69 DOMResult serializationResult = writeNormalizedNode(docNode, schemaContext);
70 assertNotNull(serializationResult);
72 XMLUnit.setIgnoreWhitespace(true);
73 XMLUnit.setIgnoreComments(true);
74 XMLUnit.setIgnoreAttributeOrder(true);
75 XMLUnit.setNormalize(true);
77 String expectedXMLString = toString(doc.getDocumentElement());
78 String serializationResultXMLString = toString(serializationResult.getNode());
80 assertXMLEqual(expectedXMLString, serializationResultXMLString);
83 private static ContainerNode createDocNode() {
84 LeafNode<byte[]> ipAddress = ImmutableNodes.leafNode(IP_ADDRESS_QNAME, Base64.getDecoder().decode("fwAAAQ=="));
85 ContainerNode root = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(ROOT_QNAME))
86 .withChild(ipAddress).build();
87 return ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(ROOT_QNAME)).withChild(root)
91 private static DOMResult writeNormalizedNode(final ContainerNode normalized, final EffectiveModelContext context)
92 throws IOException, XMLStreamException {
93 final Document doc = UntrustedXML.newDocumentBuilder().newDocument();
94 final DOMResult result = new DOMResult(doc);
95 NormalizedNodeWriter normalizedNodeWriter = null;
96 NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
97 XMLStreamWriter writer = null;
99 writer = TestFactories.DEFAULT_OUTPUT_FACTORY.createXMLStreamWriter(result);
100 normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context);
101 normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
103 for (NormalizedNode child : normalized.body()) {
104 normalizedNodeWriter.write(child);
107 normalizedNodeWriter.flush();
109 if (normalizedNodeWriter != null) {
110 normalizedNodeWriter.close();
112 if (normalizedNodeStreamWriter != null) {
113 normalizedNodeStreamWriter.close();
115 if (writer != null) {
123 private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
124 final InputStream resourceAsStream = Bug5446Test.class.getResourceAsStream(xmlPath);
125 return requireNonNull(readXmlToDocument(resourceAsStream));
128 private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
129 final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
130 doc.getDocumentElement().normalize();
134 private static String toString(final Node xml) {
136 final Transformer transformer = TransformerFactory.newInstance().newTransformer();
137 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
138 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
140 final StreamResult result = new StreamResult(new StringWriter());
141 final DOMSource source = new DOMSource(xml);
142 transformer.transform(source, result);
144 return result.getWriter().toString();
145 } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
146 throw new RuntimeException("Unable to serialize xml element " + xml, e);