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