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