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