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