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