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