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