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