yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/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
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import java.io.IOException;
  14 import java.io.InputStream;
  15 import java.io.StringWriter;
  16 import java.net.URI;
  17 import javax.xml.stream.XMLInputFactory;
  18 import javax.xml.stream.XMLOutputFactory;
  19 import javax.xml.stream.XMLStreamReader;
  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.NormalizedNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  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.ImmutableNormalizedNodeStreamWriter;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  46 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.Module;
  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
  60     private final QNameModule bazModuleQName;
  61     private final QName myAnyXMLDataBaz;
  62     private final QName bazQName;
  63     private final QName myContainer2QName;
  64     private final SchemaContext schemaContext;
  65
  66     public YangModeledAnyXMLSerializationTest() throws Exception {
  67         bazModuleQName = QNameModule.create(new URI("baz"), SimpleDateFormatUtil.getRevisionFormat()
  68                 .parse("1970-01-01"));
  69         bazQName = QName.create(bazModuleQName, "baz");
  70         myContainer2QName = QName.create(bazModuleQName, "my-container-2");
  71         myAnyXMLDataBaz = QName.create(bazModuleQName, "my-anyxml-data");
  72
  73         schemaContext = YangParserTestUtils.parseYangResourceDirectory("/anyxml-support/serialization");
  74     }
  75
  76     @Test
  77     public void testSerializationOfBaz() throws Exception {
  78         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream(
  79                 "/anyxml-support/serialization/baz.xml");
  80         final Module bazModule = schemaContext.findModuleByName("baz", null);
  81         final ContainerSchemaNode bazCont = (ContainerSchemaNode) bazModule.getDataChildByName(
  82                 QName.create(bazModule.getQNameModule(), "baz"));
  83         assertNotNull(bazCont);
  84
  85         final XMLInputFactory inputFactory = XMLInputFactory.newInstance();
  86         final XMLStreamReader reader = inputFactory.createXMLStreamReader(resourceAsStream);
  87
  88         final NormalizedNodeResult result = new NormalizedNodeResult();
  89
  90         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  91
  92         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, bazCont);
  93         xmlParser.parse(reader);
  94
  95         final NormalizedNode<?, ?> transformedInput = result.getResult();
  96         assertNotNull(transformedInput);
  97
  98         assertTrue(transformedInput instanceof ContainerNode);
  99         ContainerNode bazContainer = (ContainerNode) transformedInput;
 100         assertEquals(bazContainer.getNodeType(), bazQName);
 101
 102         Optional<DataContainerChild<? extends PathArgument, ?>> bazContainerChild = bazContainer.getChild(
 103                 new NodeIdentifier(myAnyXMLDataBaz));
 104         assertTrue(bazContainerChild.orNull() instanceof YangModeledAnyXmlNode);
 105         YangModeledAnyXmlNode yangModeledAnyXmlNode = (YangModeledAnyXmlNode) bazContainerChild.get();
 106
 107         DataSchemaNode schemaOfAnyXmlData = yangModeledAnyXmlNode.getSchemaOfAnyXmlData();
 108         SchemaNode myContainer2SchemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext,
 109                 SchemaPath.create(true, bazQName, myContainer2QName));
 110         assertTrue(myContainer2SchemaNode instanceof ContainerSchemaNode);
 111         assertEquals(myContainer2SchemaNode, schemaOfAnyXmlData);
 112
 113         final Document document = UntrustedXML.newDocumentBuilder().newDocument();
 114         final DOMResult domResult = new DOMResult(document);
 115
 116         final XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
 117         outputFactory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
 118
 119         final XMLStreamWriter xmlStreamWriter = outputFactory.createXMLStreamWriter(domResult);
 120
 121         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter
 122                 .create(xmlStreamWriter, schemaContext);
 123
 124         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 125                 xmlNormalizedNodeStreamWriter);
 126
 127         normalizedNodeWriter.write(transformedInput);
 128
 129         final Document doc = loadDocument("/anyxml-support/serialization/baz.xml");
 130
 131         XMLUnit.setIgnoreWhitespace(true);
 132         XMLUnit.setIgnoreComments(true);
 133         XMLUnit.setIgnoreAttributeOrder(true);
 134         XMLUnit.setNormalize(true);
 135
 136         String expectedXml = toString(doc.getDocumentElement());
 137         String serializedXml = toString(domResult.getNode());
 138
 139         assertXMLEqual(expectedXml, serializedXml);
 140     }
 141
 142     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 143         final InputStream resourceAsStream = YangModeledAnyXMLSerializationTest.class.getResourceAsStream(xmlPath);
 144         final Document currentConfigElement = readXmlToDocument(resourceAsStream);
 145         Preconditions.checkNotNull(currentConfigElement);
 146         return currentConfigElement;
 147     }
 148
 149     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 150         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 151         doc.getDocumentElement().normalize();
 152         return doc;
 153     }
 154
 155     private static String toString(final Node xml) {
 156         try {
 157             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 158             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 159             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 160
 161             final StreamResult result = new StreamResult(new StringWriter());
 162             final DOMSource source = new DOMSource(xml);
 163             transformer.transform(source, result);
 164
 165             return result.getWriter().toString();
 166         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 167             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 168         }
 169     }
 170 }