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