codec/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/Bug5446Test.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 package org.opendaylight.yangtools.yang.data.codec.xml;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  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.stream.NormalizedNodeStreamWriter;
  39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  42 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  43 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  44 import org.w3c.dom.Document;
  45 import org.w3c.dom.Node;
  46 import org.xml.sax.SAXException;
  47
  48 public class Bug5446Test extends XMLTestCase {
  49     private static final QNameModule FOO_MODULE = QNameModule.create(XMLNamespace.of("foo"), Revision.of("2015-11-05"));
  50     private static final QName ROOT_QNAME = QName.create(FOO_MODULE, "root");
  51     private static final QName IP_ADDRESS_QNAME = QName.create(FOO_MODULE, "ip-address");
  52
  53     @Test
  54     public void test() throws Exception {
  55         final EffectiveModelContext schemaContext = YangParserTestUtils.parseYangResource("/bug5446/yang/foo.yang");
  56         final Document doc = loadDocument("/bug5446/xml/foo.xml");
  57
  58         final ContainerNode docNode = createDocNode();
  59
  60         DataContainerChild root = docNode.childByArg(new NodeIdentifier(ROOT_QNAME));
  61         DataContainerChild child = ((ContainerNode) root).childByArg(new NodeIdentifier(IP_ADDRESS_QNAME));
  62         LeafNode<?> ipAdress = (LeafNode<?>) child;
  63
  64         Object value = ipAdress.body();
  65         assertTrue(value instanceof byte[]);
  66         assertEquals("fwAAAQ==", Base64.getEncoder().encodeToString((byte[]) value));
  67
  68         DOMResult serializationResult = writeNormalizedNode(docNode, schemaContext);
  69         assertNotNull(serializationResult);
  70
  71         XMLUnit.setIgnoreWhitespace(true);
  72         XMLUnit.setIgnoreComments(true);
  73         XMLUnit.setIgnoreAttributeOrder(true);
  74         XMLUnit.setNormalize(true);
  75
  76         String expectedXMLString = toString(doc.getDocumentElement());
  77         String serializationResultXMLString = toString(serializationResult.getNode());
  78
  79         assertXMLEqual(expectedXMLString, serializationResultXMLString);
  80     }
  81
  82     private static ContainerNode createDocNode() {
  83         return Builders.containerBuilder()
  84             .withNodeIdentifier(new NodeIdentifier(ROOT_QNAME))
  85             .withChild(Builders.containerBuilder()
  86                 .withNodeIdentifier(new NodeIdentifier(ROOT_QNAME))
  87                 .withChild(ImmutableNodes.leafNode(IP_ADDRESS_QNAME, Base64.getDecoder().decode("fwAAAQ==")))
  88                 .build())
  89             .build();
  90     }
  91
  92     private static DOMResult writeNormalizedNode(final ContainerNode normalized, final EffectiveModelContext context)
  93             throws IOException, XMLStreamException {
  94         final Document doc = UntrustedXML.newDocumentBuilder().newDocument();
  95         final DOMResult result = new DOMResult(doc);
  96         NormalizedNodeWriter normalizedNodeWriter = null;
  97         NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
  98         XMLStreamWriter writer = null;
  99         try {
 100             writer = TestFactories.DEFAULT_OUTPUT_FACTORY.createXMLStreamWriter(result);
 101             normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context);
 102             normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
 103
 104             for (var child : normalized.body()) {
 105                 normalizedNodeWriter.write(child);
 106             }
 107
 108             normalizedNodeWriter.flush();
 109         } finally {
 110             if (normalizedNodeWriter != null) {
 111                 normalizedNodeWriter.close();
 112             }
 113             if (normalizedNodeStreamWriter != null) {
 114                 normalizedNodeStreamWriter.close();
 115             }
 116             if (writer != null) {
 117                 writer.close();
 118             }
 119         }
 120
 121         return result;
 122     }
 123
 124     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 125         final InputStream resourceAsStream = Bug5446Test.class.getResourceAsStream(xmlPath);
 126         return requireNonNull(readXmlToDocument(resourceAsStream));
 127     }
 128
 129     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 130         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 131         doc.getDocumentElement().normalize();
 132         return doc;
 133     }
 134
 135     private static String toString(final Node xml) {
 136         try {
 137             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 138             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 139             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 140
 141             final StreamResult result = new StreamResult(new StringWriter());
 142             final DOMSource source = new DOMSource(xml);
 143             transformer.transform(source, result);
 144
 145             return result.getWriter().toString();
 146         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 147             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 148         }
 149     }
 150 }