yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/AnydataSerializeTest.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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 org.hamcrest.CoreMatchers.instanceOf;
  11 import static org.hamcrest.MatcherAssert.assertThat;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.junit.Assert.assertFalse;
  14
  15 import java.io.IOException;
  16 import java.io.StringWriter;
  17 import java.net.URISyntaxException;
  18 import java.util.Collection;
  19 import javax.xml.stream.XMLOutputFactory;
  20 import javax.xml.stream.XMLStreamException;
  21 import javax.xml.stream.XMLStreamReader;
  22 import javax.xml.stream.XMLStreamWriter;
  23 import javax.xml.transform.TransformerException;
  24 import javax.xml.transform.dom.DOMResult;
  25 import javax.xml.transform.dom.DOMSource;
  26 import org.custommonkey.xmlunit.Diff;
  27 import org.custommonkey.xmlunit.DifferenceListener;
  28 import org.custommonkey.xmlunit.IgnoreTextAndAttributeValuesDifferenceListener;
  29 import org.custommonkey.xmlunit.XMLAssert;
  30 import org.custommonkey.xmlunit.XMLUnit;
  31 import org.junit.Test;
  32 import org.junit.runner.RunWith;
  33 import org.junit.runners.Parameterized;
  34 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  35 import org.opendaylight.yangtools.yang.data.api.schema.AnydataNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedAnydata;
  37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnydataNodeBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  44 import org.opendaylight.yangtools.yang.data.util.ImmutableNormalizedAnydata;
  45 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  47 import org.w3c.dom.Document;
  48 import org.xml.sax.SAXException;
  49
  50 @RunWith(Parameterized.class)
  51 public class AnydataSerializeTest extends AbstractAnydataTest {
  52
  53     @Parameterized.Parameters(name = "{0}")
  54     public static Collection<Object[]> data() {
  55         return TestFactories.junitParameters();
  56     }
  57
  58     private final XMLOutputFactory factory;
  59
  60     public AnydataSerializeTest(final String factoryMode, final XMLOutputFactory factory) {
  61         this.factory = factory;
  62     }
  63
  64     @Test
  65     public void testDOMAnydata() throws XMLStreamException, IOException {
  66         final StringWriter writer = new StringWriter();
  67         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
  68
  69         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
  70             xmlStreamWriter, SCHEMA_CONTEXT);
  71         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
  72             xmlNormalizedNodeStreamWriter);
  73         normalizedNodeWriter.write(ImmutableAnydataNodeBuilder.create(DOMSourceAnydata.class)
  74             .withNodeIdentifier(FOO_NODEID).withValue(toDOMSource("<bar xmlns=\"test-anydata\"/>")).build());
  75         normalizedNodeWriter.flush();
  76
  77         final String serializedXml = writer.toString();
  78         assertEquals("<foo xmlns=\"test-anydata\"><bar xmlns=\"test-anydata\"></bar></foo>", serializedXml);
  79     }
  80
  81     @Test
  82     public void testXmlParseAnydata()
  83             throws IOException, SAXException, XMLStreamException, URISyntaxException, TransformerException {
  84
  85         //Create Data Scheme from yang file
  86         final SchemaNode dataSchemaNode = SCHEMA_CONTEXT.findDataTreeChild(FOO_QNAME).orElse(null);
  87         assertThat(dataSchemaNode, instanceOf(AnydataSchemaNode.class));
  88         final AnydataSchemaNode anyDataSchemaNode = (AnydataSchemaNode) dataSchemaNode;
  89
  90         // deserialization
  91         final XMLStreamReader reader
  92                 = UntrustedXML.createXMLStreamReader(loadResourcesAsInputStream("/test-anydata.xml"));
  93
  94         final NormalizedNodeResult result = new NormalizedNodeResult();
  95         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  96         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, SCHEMA_CONTEXT, anyDataSchemaNode);
  97         xmlParser.parse(reader);
  98
  99         final NormalizedNode transformedInput = result.getResult();
 100         assertThat(transformedInput, instanceOf(AnydataNode.class));
 101         AnydataNode<?> anydataNode = (AnydataNode<?>) transformedInput;
 102
 103         // serialization
 104         final StringWriter writer = new StringWriter();
 105         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
 106         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
 107                 xmlStreamWriter, SCHEMA_CONTEXT);
 108         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 109                 xmlNormalizedNodeStreamWriter);
 110         normalizedNodeWriter.write(transformedInput);
 111         normalizedNodeWriter.flush();
 112
 113         final String serializedXml = writer.toString();
 114         final String deserializeXml = getXmlFromDOMSource(((DOMSourceAnydata) anydataNode.body()).getSource());
 115         assertFalse(serializedXml.isEmpty());
 116
 117         // Check if is Serialize Node same as Deserialize Node
 118         XMLUnit.setIgnoreWhitespace(true);
 119         XMLUnit.setNormalize(true);
 120         final Diff diff = new Diff(deserializeXml, serializedXml);
 121         final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
 122         diff.overrideDifferenceListener(differenceListener);
 123
 124         XMLAssert.assertXMLEqual(diff, true);
 125     }
 126
 127     @Test
 128     public void testAnydataLoadFromXML() throws IOException, SAXException, XMLStreamException, URISyntaxException {
 129         // Load XML file
 130         Document doc = loadXmlDocument("/test-anydata.xml");
 131         final DOMSource domSource = new DOMSource(doc.getDocumentElement());
 132
 133         //Load XML from file and write it with xmlParseStream
 134         final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
 135         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
 136         final AnydataSchemaNode anyDataSchemaNode = (AnydataSchemaNode) SCHEMA_CONTEXT.findDataTreeChild(FOO_QNAME)
 137             .orElseThrow();
 138         final NormalizedNodeStreamWriter streamWriter = XMLStreamNormalizedNodeStreamWriter.create(
 139                 xmlStreamWriter, SCHEMA_CONTEXT);
 140         final XMLStreamReader reader = new DOMSourceXMLStreamReader(domSource);
 141         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, SCHEMA_CONTEXT, anyDataSchemaNode);
 142
 143         xmlParser.parse(reader);
 144         xmlParser.flush();
 145
 146         //Set XML comparing
 147         XMLUnit.setIgnoreWhitespace(true);
 148         XMLUnit.setNormalize(true);
 149
 150         // Check diff
 151         final String expectedXml = toString(doc.getDocumentElement());
 152         final String serializedXml = toString(domResult.getNode());
 153         final Diff diff = new Diff(expectedXml, serializedXml);
 154         final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
 155         diff.overrideDifferenceListener(differenceListener);
 156
 157         XMLAssert.assertXMLEqual(diff, true);
 158     }
 159
 160     @Test
 161     public void testAnydataSerialization()
 162             throws IOException, SAXException, XMLStreamException, URISyntaxException, TransformerException {
 163         //Get XML Data.
 164         Document doc = loadXmlDocument("/test-anydata.xml");
 165         final DOMSource domSource = new DOMSource(doc.getDocumentElement());
 166
 167         //Get specific attribute from Yang file.
 168         final AnydataSchemaNode contWithAttr = (AnydataSchemaNode) SCHEMA_CONTEXT.findDataTreeChild(FOO_QNAME)
 169             .orElseThrow();
 170
 171         //Create NormalizedNodeResult
 172         NormalizedNodeResult normalizedResult = new NormalizedNodeResult();
 173         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(normalizedResult);
 174
 175         //Initialize Reader with XML file
 176         final XMLStreamReader reader = new DOMSourceXMLStreamReader(domSource);
 177         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, SCHEMA_CONTEXT, contWithAttr);
 178         xmlParser.parse(reader);
 179         xmlParser.flush();
 180
 181         //Get Result
 182         final NormalizedNode node = normalizedResult.getResult();
 183         assertThat(node, instanceOf(AnydataNode.class));
 184         final AnydataNode<?> anydataResult = (AnydataNode<?>) node;
 185
 186         //Get Result in formatted String
 187         assertThat(anydataResult.body(), instanceOf(DOMSourceAnydata.class));
 188         final String serializedXml = getXmlFromDOMSource(((DOMSourceAnydata)anydataResult.body()).getSource());
 189         final String expectedXml = toString(doc.getDocumentElement());
 190
 191         //Looking for difference in Serialized xml and in Loaded XML
 192         final Diff diff = new Diff(expectedXml, serializedXml);
 193         final DifferenceListener differenceListener = new IgnoreTextAndAttributeValuesDifferenceListener();
 194         diff.overrideDifferenceListener(differenceListener);
 195
 196         XMLAssert.assertXMLEqual(diff, true);
 197     }
 198
 199     @Test
 200     public void testSiblingSerialize() throws IOException, XMLStreamException {
 201         final StringWriter writer = new StringWriter();
 202         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
 203
 204         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
 205             xmlStreamWriter, SCHEMA_CONTEXT);
 206         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 207             xmlNormalizedNodeStreamWriter);
 208         normalizedNodeWriter.write(ImmutableContainerNodeBuilder.create().withNodeIdentifier(CONT_NODEID)
 209             .withChild(ImmutableAnydataNodeBuilder.create(DOMSourceAnydata.class).withNodeIdentifier(CONT_ANY_NODEID)
 210                 .withValue(toDOMSource("<bar xmlns=\"test-anydata\"/>")).build())
 211             .withChild(CONT_LEAF)
 212             .build());
 213         normalizedNodeWriter.flush();
 214
 215         final String serializedXml = writer.toString();
 216         assertEquals("<cont xmlns=\"test-anydata\"><cont-any><bar xmlns=\"test-anydata\"></bar></cont-any>"
 217                 + "<cont-leaf>abc</cont-leaf></cont>", serializedXml);
 218     }
 219
 220     @Test
 221     public void testNormalizedSerialize() throws IOException, XMLStreamException {
 222         final StringWriter writer = new StringWriter();
 223         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(writer);
 224
 225         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
 226             xmlStreamWriter, SCHEMA_CONTEXT);
 227         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 228             xmlNormalizedNodeStreamWriter);
 229         normalizedNodeWriter.write(ImmutableContainerNodeBuilder.create().withNodeIdentifier(CONT_NODEID)
 230             .withChild(ImmutableAnydataNodeBuilder.create(NormalizedAnydata.class).withNodeIdentifier(CONT_ANY_NODEID)
 231                 .withValue(new ImmutableNormalizedAnydata(SCHEMA_CONTEXT,
 232                     SCHEMA_CONTEXT.findDataChildByName(CONT_QNAME).get(), ImmutableContainerNodeBuilder.create()
 233                     .withNodeIdentifier(CONT_NODEID).build())).build())
 234             .build());
 235         normalizedNodeWriter.flush();
 236
 237         final String serializedXml = writer.toString();
 238         assertEquals("<cont xmlns=\"test-anydata\"><cont-any><cont/></cont-any></cont>", serializedXml);
 239     }
 240 }