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