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