codec/yang-data-codec-gson/src/test/java/org/opendaylight/yangtools/yang/data/codec/gson/AnyXmlSupportTest.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.gson;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.opendaylight.yangtools.yang.data.codec.gson.TestUtils.loadTextFile;
  14 import static org.opendaylight.yangtools.yang.data.codec.gson.TestUtils.loadXmlToNormalizedNodes;
  15 import static org.opendaylight.yangtools.yang.data.codec.gson.TestUtils.normalizedNodesToJsonString;
  16
  17 import com.google.gson.JsonParser;
  18 import com.google.gson.stream.JsonReader;
  19 import java.io.File;
  20 import java.io.FileReader;
  21 import java.io.IOException;
  22 import java.io.StringReader;
  23 import java.net.URISyntaxException;
  24 import java.nio.charset.StandardCharsets;
  25 import javax.xml.transform.dom.DOMSource;
  26 import org.junit.Test;
  27 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  28 import org.opendaylight.yangtools.yang.common.QName;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
  36 import org.w3c.dom.Document;
  37 import org.w3c.dom.Element;
  38 import org.w3c.dom.Text;
  39
  40 public class AnyXmlSupportTest extends AbstractComplexJsonTest {
  41
  42     private static final QName LF12_ANY = QName.create(CONT_1, "lf12-any");
  43     private static final QName LF13_ANY = QName.create(CONT_1, "lf13-any");
  44     private static final QName LF14_ANY = QName.create(CONT_1, "lf14-any");
  45
  46     @Test
  47     public void anyXmlNodeWithSimpleValueInContainer() throws IOException, URISyntaxException {
  48         final String inputJson = loadTextFile("/complexjson/anyxml-node-with-simple-value-in-container.json");
  49
  50         // deserialization
  51         final var result = new NormalizationResultHolder();
  52         final var streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  53         final var jsonParser = JsonParserStream.create(streamWriter, lhotkaCodecFactory);
  54         jsonParser.parse(new JsonReader(new StringReader(inputJson)));
  55         final var transformedInput = result.getResult().data();
  56         assertNotNull(transformedInput);
  57
  58         // lf12-any check
  59         final DOMSource Lf12AnyActualValue = getParsedAnyXmlValue(transformedInput, LF12_ANY);
  60         final DOMSource Lf12AnyExpectedValue = createAnyXmlSimpleValue("ns:complex:json", "lf12-any", "100.5");
  61         verifyTransformedAnyXmlNodeValue(Lf12AnyExpectedValue, Lf12AnyActualValue);
  62
  63         // lf13-any check
  64         final DOMSource Lf13AnyActualValue = getParsedAnyXmlValue(transformedInput, LF13_ANY);
  65         final DOMSource Lf13AnyExpectedValue = createAnyXmlSimpleValue("ns:complex:json", "lf13-any", "true");
  66         verifyTransformedAnyXmlNodeValue(Lf13AnyExpectedValue, Lf13AnyActualValue);
  67
  68         // lf14-any check
  69         final DOMSource Lf14AnyActualValue = getParsedAnyXmlValue(transformedInput, LF14_ANY);
  70         final DOMSource Lf14AnyExpectedValue = createAnyXmlSimpleValue("ns:complex:json", "lf14-any", "null");
  71         verifyTransformedAnyXmlNodeValue(Lf14AnyExpectedValue, Lf14AnyActualValue);
  72
  73         final String serializationResult = normalizedNodesToJsonString(transformedInput, schemaContext);
  74
  75         assertEquals(JsonParser.parseString(inputJson), JsonParser.parseString(serializationResult));
  76     }
  77
  78     @Test
  79     public void anyXmlNodeWithCompositeValueInContainer() throws IOException, URISyntaxException {
  80         final String inputJson = loadTextFile("/complexjson/anyxml-node-with-composite-value-in-container.json");
  81
  82         final var result = new NormalizationResultHolder();
  83         final var streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  84         final var jsonParser = JsonParserStream.create(streamWriter, lhotkaCodecFactory);
  85         jsonParser.parse(new JsonReader(new StringReader(inputJson)));
  86         final var transformedInput = result.getResult().data();
  87         assertNotNull(transformedInput);
  88
  89         // lf12-any check
  90         final DOMSource Lf12AnyActualValue = getParsedAnyXmlValue(transformedInput, LF12_ANY);
  91         final DOMSource Lf12AnyExpectedValue = createLf12AnyXmlCompositeValue("ns:complex:json", "lf12-any");
  92         verifyTransformedAnyXmlNodeValue(Lf12AnyExpectedValue, Lf12AnyActualValue);
  93         // lf13-any check
  94         final DOMSource Lf13AnyActualValue = getParsedAnyXmlValue(transformedInput, LF13_ANY);
  95         final DOMSource Lf13AnyExpectedValue = createLf13AnyXmlCompositeValue("ns:complex:json", "lf13-any");
  96         verifyTransformedAnyXmlNodeValue(Lf13AnyExpectedValue, Lf13AnyActualValue);
  97
  98         // lf14-any check
  99         final DOMSource Lf14AnyActualValue = getParsedAnyXmlValue(transformedInput, LF14_ANY);
 100         final DOMSource Lf14AnyExpectedValue = createLf14AnyXmlCompositeValue("ns:complex:json", "lf14-any");
 101         verifyTransformedAnyXmlNodeValue(Lf14AnyExpectedValue, Lf14AnyActualValue);
 102
 103         // serialization
 104         final String serializationResult = normalizedNodesToJsonString(transformedInput, schemaContext);
 105
 106         assertEquals(JsonParser.parseString(loadTextFile("/bug8927/json/composite.json")),
 107             JsonParser.parseString(serializationResult));
 108     }
 109
 110     @Test
 111     public void bug8927TestComplexArrayWithOthers() throws Exception {
 112         executebug8927Test("/bug8927/xml/complex_array_with_other_elements.xml",
 113             "/bug8927/json/complex_array_with_other_elements.json");
 114     }
 115
 116     @Test
 117     public void bug8927TestComplexArray() throws Exception {
 118         executebug8927Test("/bug8927/xml/complex_array.xml", "/bug8927/json/complex_array.json");
 119     }
 120
 121     @Test
 122     public void bug8927TestScalarArrayWithOthers() throws Exception {
 123         executebug8927Test("/bug8927/xml/scalar_array_with_other_elements.xml",
 124             "/bug8927/json/scalar_array_with_other_elements.json");
 125     }
 126
 127     @Test
 128     public void bug8927TestScalarArray() throws Exception {
 129         executebug8927Test("/bug8927/xml/scalar_array.xml", "/bug8927/json/scalar_array.json");
 130     }
 131
 132     @Test
 133     public void yt1302TestFlatArray() throws Exception {
 134         executeYt1302Test("/yt1302/xml/flat-array.xml", "/yt1302/json/flat-array.json");
 135     }
 136
 137     @Test
 138     public void yt1302TestArrayOfArray() throws Exception {
 139         executeYt1302Test("/yt1302/xml/array-of-array.xml", "/yt1302/json/array-of-array.json");
 140     }
 141
 142     private void executebug8927Test(final String inputXmlFile, final String expectedJsonFile) throws Exception {
 143         verifyExpectedJson(inputXmlFile, expectedJsonFile, "bug8927.test", "2017-01-01", "foo");
 144     }
 145
 146     private void executeYt1302Test(final String inputXmlFile, final String expectedJsonFile) throws Exception {
 147         verifyExpectedJson(inputXmlFile, expectedJsonFile, "yt1302.test", "2022-10-11", "data");
 148     }
 149
 150     private void verifyExpectedJson(final String inputXmlFile, final String expectedJsonFile,
 151             final String namespace, final String revision, final String localName) throws Exception {
 152         final var resourceAsStream = AnyXmlSupportTest.class.getResourceAsStream(inputXmlFile);
 153         final var result = new NormalizationResultHolder();
 154         loadXmlToNormalizedNodes(resourceAsStream, result, schemaContext);
 155
 156         assertNotNull(result.getResult().data());
 157         assertTrue(result.getResult().data() instanceof ContainerNode);
 158
 159         final DataContainerChild data = ((ContainerNode) result.getResult().data())
 160                 .childByArg(new NodeIdentifier(QName.create(namespace, revision, localName)));
 161         assertNotNull(data);
 162         final String jsonOutput = normalizedNodesToJsonString(data, schemaContext);
 163         assertEquals(JsonParser.parseReader(new FileReader(
 164                         new File(getClass().getResource(expectedJsonFile).toURI()), StandardCharsets.UTF_8)),
 165                 JsonParser.parseString(jsonOutput));
 166     }
 167
 168     private static DOMSource getParsedAnyXmlValue(final NormalizedNode transformedInput, final QName anyxmlName) {
 169         assertTrue(transformedInput instanceof ContainerNode);
 170         final ContainerNode cont1 = (ContainerNode) transformedInput;
 171         final DataContainerChild child = cont1.childByArg(new NodeIdentifier(anyxmlName));
 172         assertTrue(child instanceof DOMSourceAnyxmlNode);
 173         final DOMSourceAnyxmlNode anyXmlNode = (DOMSourceAnyxmlNode) child;
 174         return anyXmlNode.body();
 175     }
 176
 177     private static void verifyTransformedAnyXmlNodeValue(final DOMSource expectedValue, final DOMSource actualValue) {
 178         assertTrue(expectedValue.getNode().isEqualNode(actualValue.getNode()));
 179     }
 180
 181     private static DOMSource createAnyXmlSimpleValue(final String ns, final String name, final String value) {
 182         final Document doc = UntrustedXML.newDocumentBuilder().newDocument();
 183         final Element rootElement = doc.createElementNS(ns, name);
 184         doc.appendChild(rootElement);
 185         final Text textNode = doc.createTextNode(value);
 186         rootElement.appendChild(textNode);
 187         return new DOMSource(doc.getDocumentElement());
 188     }
 189
 190     private static DOMSource createLf12AnyXmlCompositeValue(final String ns, final String name) {
 191         final Document doc = UntrustedXML.newDocumentBuilder().newDocument();
 192         final Element rootElement = doc.createElementNS(ns, name);
 193
 194         final Element arrayElement1 = doc.createElement("array-element");
 195         final Text arrayElement1Text = doc.createTextNode("true");
 196         arrayElement1.appendChild(arrayElement1Text);
 197
 198         final Element arrayElement2 = doc.createElement("array-element");
 199
 200         final Element arrayElement2Baz = doc.createElement("baz");
 201         final Element bazArrayElement1 = doc.createElement("array-element");
 202         final Text bazArrayElement1Text = doc.createTextNode("120");
 203         bazArrayElement1.appendChild(bazArrayElement1Text);
 204         final Element bazArrayElement2 = doc.createElement("array-element");
 205         final Text bazArrayElement2Text = doc.createTextNode("str-val");
 206         bazArrayElement2.appendChild(bazArrayElement2Text);
 207         final Element bazArrayElement3 = doc.createElement("array-element");
 208         final Text bazArrayElement3Text = doc.createTextNode("false");
 209         bazArrayElement3.appendChild(bazArrayElement3Text);
 210
 211         arrayElement2Baz.appendChild(bazArrayElement1);
 212         arrayElement2Baz.appendChild(bazArrayElement2);
 213         arrayElement2Baz.appendChild(bazArrayElement3);
 214
 215         arrayElement2.appendChild(arrayElement2Baz);
 216
 217         final Element arrayElement3 = doc.createElement("array-element");
 218         final Element arrayElement3Foo = doc.createElement("foo");
 219         final Text fooText = doc.createTextNode("null");
 220         arrayElement3Foo.appendChild(fooText);
 221         arrayElement3.appendChild(arrayElement3Foo);
 222
 223         rootElement.appendChild(arrayElement1);
 224         rootElement.appendChild(arrayElement2);
 225         rootElement.appendChild(arrayElement3);
 226
 227         doc.appendChild(rootElement);
 228
 229         return new DOMSource(doc.getDocumentElement());
 230     }
 231
 232     private static DOMSource createLf13AnyXmlCompositeValue(final String ns, final String name) {
 233         final Document doc = UntrustedXML.newDocumentBuilder().newDocument();
 234         final Element rootElement = doc.createElementNS(ns, name);
 235
 236         final Element anyXmlArrayA = doc.createElement("anyxml-array-a");
 237
 238         final Element arrayAElement1 = doc.createElement("array-element");
 239         final Element arrayAElement1Foo = doc.createElement("foo");
 240         final Text fooText = doc.createTextNode("true");
 241         arrayAElement1Foo.appendChild(fooText);
 242         arrayAElement1.appendChild(arrayAElement1Foo);
 243
 244         final Element arrayAElement2 = doc.createElement("array-element");
 245         final Text arrayAElement2Text = doc.createTextNode("10");
 246         arrayAElement2.appendChild(arrayAElement2Text);
 247
 248         final Element arrayAElement3 = doc.createElement("array-element");
 249         final Element arrayAElement3Bar = doc.createElement("bar");
 250         final Text barText = doc.createTextNode("false");
 251         arrayAElement3Bar.appendChild(barText);
 252         arrayAElement3.appendChild(arrayAElement3Bar);
 253
 254         anyXmlArrayA.appendChild(arrayAElement1);
 255         anyXmlArrayA.appendChild(arrayAElement2);
 256         anyXmlArrayA.appendChild(arrayAElement3);
 257
 258         final Element anyXmlArrayB = doc.createElement("anyxml-array-b");
 259
 260         final Element arrayBElement1 = doc.createElement("array-element");
 261         final Text arrayBElement1Text = doc.createTextNode("1");
 262         arrayBElement1.appendChild(arrayBElement1Text);
 263
 264         final Element arrayBElement2 = doc.createElement("array-element");
 265         final Text arrayBElement2Text = doc.createTextNode("2");
 266         arrayBElement2.appendChild(arrayBElement2Text);
 267
 268         final Element arrayBElement3 = doc.createElement("array-element");
 269
 270         final Element arrayBElement3Element1 = doc.createElement("array-element");
 271         final Text arrayBElement3Element1Text = doc.createTextNode("4");
 272         arrayBElement3Element1.appendChild(arrayBElement3Element1Text);
 273         final Element arrayBElement3Element2 = doc.createElement("array-element");
 274         final Text arrayBElement3Element2Text = doc.createTextNode("5");
 275         arrayBElement3Element2.appendChild(arrayBElement3Element2Text);
 276
 277         arrayBElement3.appendChild(arrayBElement3Element1);
 278         arrayBElement3.appendChild(arrayBElement3Element2);
 279
 280         final Element arrayBElement4 = doc.createElement("array-element");
 281         final Text arrayBElement4Text = doc.createTextNode("7");
 282         arrayBElement4.appendChild(arrayBElement4Text);
 283
 284         anyXmlArrayB.appendChild(arrayBElement1);
 285         anyXmlArrayB.appendChild(arrayBElement2);
 286         anyXmlArrayB.appendChild(arrayBElement3);
 287         anyXmlArrayB.appendChild(arrayBElement4);
 288
 289         rootElement.appendChild(anyXmlArrayA);
 290         rootElement.appendChild(anyXmlArrayB);
 291
 292         doc.appendChild(rootElement);
 293
 294         return new DOMSource(doc.getDocumentElement());
 295     }
 296
 297     private static DOMSource createLf14AnyXmlCompositeValue(final String ns, final String name) {
 298         final Document doc = UntrustedXML.newDocumentBuilder().newDocument();
 299         final Element rootElement = doc.createElementNS(ns, name);
 300
 301         final Element anyXmlObjectA = doc.createElement("anyxml-object-a");
 302         final Element dataA1 = doc.createElement("data-a1");
 303         final Text dataA1Text = doc.createTextNode("10");
 304         dataA1.appendChild(dataA1Text);
 305         final Element dataA2 = doc.createElement("data-a2");
 306         final Text dataA2Text = doc.createTextNode("11");
 307         dataA2.appendChild(dataA2Text);
 308
 309         anyXmlObjectA.appendChild(dataA1);
 310         anyXmlObjectA.appendChild(dataA2);
 311
 312         final Element anyXmlObjectB = doc.createElement("anyxml-object-b");
 313
 314         final Element childObjectB1 = doc.createElement("child-object-b1");
 315         final Element dataB1 = doc.createElement("data-b1");
 316         final Text dataB1Text = doc.createTextNode("5.5");
 317         dataB1.appendChild(dataB1Text);
 318         childObjectB1.appendChild(dataB1);
 319
 320         final Element childObjectB2 = doc.createElement("child-object-b2");
 321         final Element dataB2 = doc.createElement("data-b2");
 322         final Text dataB2Text = doc.createTextNode("b2-val");
 323         dataB2.appendChild(dataB2Text);
 324         childObjectB2.appendChild(dataB2);
 325
 326         anyXmlObjectB.appendChild(childObjectB1);
 327         anyXmlObjectB.appendChild(childObjectB2);
 328
 329         rootElement.appendChild(anyXmlObjectA);
 330         rootElement.appendChild(anyXmlObjectB);
 331
 332         doc.appendChild(rootElement);
 333
 334         return new DOMSource(doc.getDocumentElement());
 335     }
 336 }