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