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