codec/yang-data-codec-gson/src/test/java/org/opendaylight/yangtools/yang/data/codec/gson/Bug8083Test.java

   1 /*
   2  * Copyright (c) 2017 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
   9 package org.opendaylight.yangtools.yang.data.codec.gson;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.ArgumentMatchers.any;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.verify;
  18 import static org.opendaylight.yangtools.yang.data.codec.gson.TestUtils.loadTextFile;
  19
  20 import com.google.common.collect.ImmutableMap;
  21 import com.google.gson.stream.JsonReader;
  22 import com.google.gson.stream.JsonWriter;
  23 import java.io.IOException;
  24 import java.io.StringReader;
  25 import java.net.URISyntaxException;
  26 import org.junit.AfterClass;
  27 import org.junit.BeforeClass;
  28 import org.junit.Test;
  29 import org.mockito.ArgumentCaptor;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.common.QNameModule;
  32 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  36 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
  40 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  41 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  43 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  46 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  47
  48 public class Bug8083Test {
  49     private static final QNameModule FOOMOD = QNameModule.create(XMLNamespace.of("http://example.com/foomod"));
  50     private static final QNameModule BARMOD = QNameModule.create(XMLNamespace.of("http://example.com/barmod"));
  51
  52     private static final QName FOO_QNAME = QName.create(FOOMOD, "foo");
  53     private static final QName FOOLIST_QNAME = QName.create(FOOMOD, "foo-list");
  54     private static final QName NAME_QNAME = QName.create(FOOMOD, "name");
  55     private static final QName TOP_QNAME = QName.create(FOOMOD, "top");
  56     private static final QName BARCONTAINER_QNAME = QName.create(BARMOD, "bar-container");
  57
  58     private static final YangInstanceIdentifier TEST_IID = YangInstanceIdentifier.builder()
  59             .node(TOP_QNAME)
  60             .node(FOOLIST_QNAME)
  61             .node(NodeIdentifierWithPredicates.of(FOOLIST_QNAME, ImmutableMap.of(NAME_QNAME, "key-value")))
  62             .node(BARCONTAINER_QNAME)
  63             .node(QName.create(BARMOD, "bar-leaf"))
  64             .build();
  65
  66     private static EffectiveModelContext FULL_SCHEMA_CONTEXT;
  67
  68     @BeforeClass
  69     public static void init() {
  70         FULL_SCHEMA_CONTEXT = YangParserTestUtils.parseYangResourceDirectory("/bug8083/yang/");
  71     }
  72
  73     @AfterClass
  74     public static void cleanup() {
  75         FULL_SCHEMA_CONTEXT = null;
  76     }
  77
  78     @Test
  79     public void testInstanceIdentifierSerializeNew() throws IOException {
  80         assertEquals("/example-foomod:top/foo-list[name='key-value']/example-barmod:bar-container/bar-leaf",
  81             writeInstanceIdentifier(JSONCodecFactorySupplier.RFC7951));
  82     }
  83
  84     @Test
  85     public void testInstanceIdentifierSerializeOld() throws IOException {
  86         assertEquals("/example-foomod:top/example-foomod:foo-list[example-foomod:name='key-value']"
  87                 + "/example-barmod:bar-container/example-barmod:bar-leaf",
  88             writeInstanceIdentifier(JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02));
  89     }
  90
  91     @Test
  92     public void testRFC7951InstanceIdentifierPath() throws IOException, URISyntaxException {
  93         final String inputJson = loadTextFile("/bug8083/json/foo.json");
  94
  95         // deserialization
  96         final var result = new NormalizationResultHolder();
  97         final var streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  98         final var jsonParser = JsonParserStream.create(streamWriter,
  99             JSONCodecFactorySupplier.RFC7951.getShared(FULL_SCHEMA_CONTEXT));
 100         jsonParser.parse(new JsonReader(new StringReader(inputJson)));
 101         final var transformedInput = result.getResult().data();
 102
 103         assertTrue(transformedInput instanceof ContainerNode);
 104         final var container = (ContainerNode) transformedInput;
 105         final var child = container.childByArg(new NodeIdentifier(FOO_QNAME));
 106         assertTrue(child instanceof LeafNode);
 107         assertEquals(TEST_IID, child.body());
 108     }
 109
 110     @Test
 111     public void testInstanceIdentifierPathWithEmptyListKey() throws IOException, URISyntaxException {
 112         final var schemaContext = YangParserTestUtils.parseYangResource("/bug8083/yang/baz.yang");
 113         final String inputJson = loadTextFile("/bug8083/json/baz.json");
 114
 115         // deserialization
 116         final var result = new NormalizationResultHolder();
 117         final var streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 118         final var jsonParser = JsonParserStream.create(streamWriter,
 119             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(schemaContext));
 120         jsonParser.parse(new JsonReader(new StringReader(inputJson)));
 121         final var transformedInput = result.getResult().data();
 122         assertNotNull(transformedInput);
 123     }
 124
 125     @Test
 126     public void testInstanceIdentifierPathWithIdentityrefListKey() throws IOException, URISyntaxException {
 127         final var schemaContext = YangParserTestUtils.parseYangResource("/bug8083/yang/zab.yang");
 128         final String inputJson = loadTextFile("/bug8083/json/zab.json");
 129
 130         // deserialization
 131         final var result = new NormalizationResultHolder();
 132         final var streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 133         final var jsonParser = JsonParserStream.create(streamWriter,
 134             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(schemaContext));
 135         jsonParser.parse(new JsonReader(new StringReader(inputJson)));
 136         final var transformedInput = result.getResult().data();
 137         assertNotNull(transformedInput);
 138     }
 139
 140     @Test
 141     public void testInstanceIdentifierPathWithInstanceIdentifierListKey() throws IOException, URISyntaxException {
 142         final EffectiveModelContext schemaContext = YangParserTestUtils.parseYangResource("/bug8083/yang/foobar.yang");
 143         final String inputJson = loadTextFile("/bug8083/json/foobar.json");
 144
 145         // deserialization
 146         final var result = new NormalizationResultHolder();
 147         final var streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 148         final var jsonParser = JsonParserStream.create(streamWriter,
 149             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(schemaContext));
 150         jsonParser.parse(new JsonReader(new StringReader(inputJson)));
 151         final var transformedInput = result.getResult().data();
 152         assertNotNull(transformedInput);
 153     }
 154
 155     private static JSONCodec<YangInstanceIdentifier> getCodec(final JSONCodecFactorySupplier supplier) {
 156         final DataSchemaNode top = FULL_SCHEMA_CONTEXT.getDataChildByName(TOP_QNAME);
 157         assertTrue(top instanceof ContainerSchemaNode);
 158         final DataSchemaNode foo = ((ContainerSchemaNode) top).getDataChildByName(FOO_QNAME);
 159         assertTrue(foo instanceof LeafSchemaNode);
 160         final TypeDefinition<? extends TypeDefinition<?>> type = ((LeafSchemaNode) foo).getType();
 161         assertTrue(type instanceof InstanceIdentifierTypeDefinition);
 162         return supplier.createSimple(FULL_SCHEMA_CONTEXT)
 163                 .instanceIdentifierCodec((InstanceIdentifierTypeDefinition) type);
 164     }
 165
 166     private static String writeInstanceIdentifier(final JSONCodecFactorySupplier supplier) throws IOException {
 167         final JsonWriter writer = mock(JsonWriter.class);
 168         ArgumentCaptor<String> captor = ArgumentCaptor.forClass(String.class);
 169         doReturn(writer).when(writer).value(captor.capture());
 170
 171         getCodec(supplier).writeValue(writer, TEST_IID);
 172         verify(writer).value(any(String.class));
 173         return captor.getValue();
 174     }
 175 }