yang/yang-data-impl/src/test/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/dom/serializer/YangModeledAnyXMLSerializationTest.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 java.io.IOException;
  13 import java.io.InputStream;
  14 import java.io.StringWriter;
  15 import java.net.URI;
  16 import java.util.Collections;
  17 import javax.xml.stream.XMLOutputFactory;
  18 import javax.xml.stream.XMLStreamException;
  19 import javax.xml.stream.XMLStreamWriter;
  20 import javax.xml.transform.OutputKeys;
  21 import javax.xml.transform.Transformer;
  22 import javax.xml.transform.TransformerException;
  23 import javax.xml.transform.TransformerFactory;
  24 import javax.xml.transform.TransformerFactoryConfigurationError;
  25 import javax.xml.transform.dom.DOMResult;
  26 import javax.xml.transform.dom.DOMSource;
  27 import javax.xml.transform.stream.StreamResult;
  28 import org.custommonkey.xmlunit.XMLTestCase;
  29 import org.custommonkey.xmlunit.XMLUnit;
  30 import org.junit.Test;
  31 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  32 import org.opendaylight.yangtools.yang.common.QName;
  33 import org.opendaylight.yangtools.yang.common.QNameModule;
  34 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  42 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  43 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  44 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
  47 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  50 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  52 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  53 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  54 import org.w3c.dom.Document;
  55 import org.w3c.dom.Node;
  56 import org.xml.sax.SAXException;
  57
  58 public class YangModeledAnyXMLSerializationTest extends XMLTestCase {
  59     private static final XMLOutputFactory XML_FACTORY;
  60
  61     static {
  62         XML_FACTORY = XMLOutputFactory.newFactory();
  63         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
  64     }
  65
  66     private final QNameModule bazModuleQName;
  67     private final QName myAnyXMLDataBaz;
  68     private final QName bazQName;
  69     private final QName myContainer2QName;
  70     private final SchemaContext schemaContext;
  71
  72     public YangModeledAnyXMLSerializationTest() throws Exception {
  73         bazModuleQName = QNameModule.create(new URI("baz"), SimpleDateFormatUtil.getRevisionFormat()
  74                 .parse("1970-01-01"));
  75         bazQName = QName.create(bazModuleQName, "baz");
  76         myContainer2QName = QName.create(bazModuleQName, "my-container-2");
  77         myAnyXMLDataBaz = QName.create(bazModuleQName, "my-anyxml-data");
  78
  79         schemaContext = YangParserTestUtils.parseYangSources("/anyxml-support/serialization");
  80     }
  81
  82     @Test
  83     public void testSerializationOfBaz() throws Exception {
  84         final Document doc = loadDocument("/anyxml-support/serialization/baz.xml");
  85
  86         final ContainerNode output = DomToNormalizedNodeParserFactory
  87                 .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext).getContainerNodeParser()
  88                 .parse(Collections.singletonList(doc.getDocumentElement()), schemaContext);
  89
  90         assertNotNull(output);
  91         Optional<DataContainerChild<? extends PathArgument, ?>> child = output.getChild(new NodeIdentifier(bazQName));
  92         assertTrue(child.orNull() instanceof ContainerNode);
  93         ContainerNode baz = (ContainerNode) child.get();
  94
  95         Optional<DataContainerChild<? extends PathArgument, ?>> bazChild = baz.getChild(new NodeIdentifier(
  96                 myAnyXMLDataBaz));
  97         assertTrue(bazChild.orNull() instanceof YangModeledAnyXmlNode);
  98         YangModeledAnyXmlNode yangModeledAnyXmlNode = (YangModeledAnyXmlNode) bazChild.get();
  99
 100         DataSchemaNode schemaOfAnyXmlData = yangModeledAnyXmlNode.getSchemaOfAnyXmlData();
 101         SchemaNode myContainer2SchemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext,
 102                 SchemaPath.create(true, bazQName, myContainer2QName));
 103         assertTrue(myContainer2SchemaNode instanceof ContainerSchemaNode);
 104         assertEquals(myContainer2SchemaNode, schemaOfAnyXmlData);
 105
 106         DOMResult serializationResult = writeNormalizedNode(output, schemaContext);
 107         assertNotNull(serializationResult);
 108
 109         XMLUnit.setIgnoreWhitespace(true);
 110         XMLUnit.setIgnoreComments(true);
 111         XMLUnit.setIgnoreAttributeOrder(true);
 112         XMLUnit.setNormalize(true);
 113
 114         String expectedXMLString = toString(doc.getDocumentElement().getElementsByTagName("baz").item(0));
 115         String serializationResultXMLString = toString(serializationResult.getNode());
 116
 117         assertXMLEqual(expectedXMLString, serializationResultXMLString);
 118     }
 119
 120     private static DOMResult writeNormalizedNode(final ContainerNode normalized, final SchemaContext context)
 121             throws IOException, XMLStreamException {
 122         final Document doc = XmlDocumentUtils.getDocument();
 123         final DOMResult result = new DOMResult(doc);
 124         NormalizedNodeWriter normalizedNodeWriter = null;
 125         NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
 126         XMLStreamWriter writer = null;
 127         try {
 128             writer = XML_FACTORY.createXMLStreamWriter(result);
 129             normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context);
 130             normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
 131
 132             for (NormalizedNode<?, ?> child : normalized.getValue()) {
 133                 normalizedNodeWriter.write(child);
 134             }
 135
 136             normalizedNodeWriter.flush();
 137         } finally {
 138             if (normalizedNodeWriter != null) {
 139                 normalizedNodeWriter.close();
 140             }
 141             if (normalizedNodeStreamWriter != null) {
 142                 normalizedNodeStreamWriter.close();
 143             }
 144             if (writer != null) {
 145                 writer.close();
 146             }
 147         }
 148
 149         return result;
 150     }
 151
 152     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 153         final InputStream resourceAsStream = YangModeledAnyXMLSerializationTest.class.getResourceAsStream(xmlPath);
 154         final Document currentConfigElement = readXmlToDocument(resourceAsStream);
 155         Preconditions.checkNotNull(currentConfigElement);
 156         return currentConfigElement;
 157     }
 158
 159     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 160         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 161         doc.getDocumentElement().normalize();
 162         return doc;
 163     }
 164
 165     private static String toString(final Node xml) {
 166         try {
 167             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 168             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 169             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 170
 171             final StreamResult result = new StreamResult(new StringWriter());
 172             final DOMSource source = new DOMSource(xml);
 173             transformer.transform(source, result);
 174
 175             return result.getWriter().toString();
 176         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 177             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 178         }
 179     }
 180 }