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