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