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