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