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