opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/md/sal/binding/impl/BindingNormalizedCodecTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 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.controller.md.sal.binding.impl;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.junit.Assert.fail;
  14
  15 import com.google.common.collect.ImmutableBiMap;
  16 import com.google.common.collect.ImmutableMap;
  17 import com.google.common.collect.ImmutableSet;
  18 import com.google.common.collect.ImmutableSetMultimap;
  19 import com.google.common.collect.SetMultimap;
  20 import com.google.common.util.concurrent.Uninterruptibles;
  21 import java.lang.reflect.Method;
  22 import java.net.URI;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import java.util.concurrent.CountDownLatch;
  26 import java.util.concurrent.TimeUnit;
  27 import java.util.concurrent.atomic.AtomicReference;
  28 import javassist.ClassPool;
  29 import org.junit.Test;
  30 import org.opendaylight.controller.md.sal.binding.test.AbstractSchemaAwareTest;
  31 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerGenerator;
  32 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
  33 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  34 import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
  35 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeComplexUsesAugment;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeLeafOnlyAugment;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.bi.ba.rpcservice.rev140701.OpendaylightTestRpcServiceService;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListKey;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.common.QName;
  44 import org.opendaylight.yangtools.yang.common.QNameModule;
  45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  48 import org.opendaylight.yangtools.yang.model.api.Module;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  50 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  51 import org.opendaylight.yangtools.yang.model.util.AbstractSchemaContext;
  52
  53 public class BindingNormalizedCodecTest extends AbstractSchemaAwareTest {
  54
  55     private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
  56     private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier
  57             .builder(Top.class).child(TopLevelList.class, TOP_FOO_KEY).build();
  58     private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST.augmentation(TreeLeafOnlyAugment.class);
  59     private static final InstanceIdentifier<TreeComplexUsesAugment> BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST.augmentation(TreeComplexUsesAugment.class);
  60     private static final QName SIMPLE_VALUE_QNAME = QName.create(TreeComplexUsesAugment.QNAME, "simple-value");
  61     private static final QName NAME_QNAME = QName.create(Top.QNAME, "name");
  62     private static final YangInstanceIdentifier BI_TOP_LEVEL_LIST = YangInstanceIdentifier.builder().
  63             node(Top.QNAME).node(TopLevelList.QNAME).nodeWithKey(
  64                     TopLevelList.QNAME, NAME_QNAME, TOP_FOO_KEY.getName()).build();
  65
  66
  67     private BindingToNormalizedNodeCodec codec;
  68     private SchemaContext context;
  69
  70     @Override
  71     protected void setupWithSchema(final SchemaContext context) {
  72         this.context = context;
  73         final DataObjectSerializerGenerator streamWriter = StreamWriterGenerator.create(JavassistUtils.forClassPool(ClassPool.getDefault()));
  74         final BindingNormalizedNodeCodecRegistry registry = new BindingNormalizedNodeCodecRegistry(streamWriter);
  75         this.codec = new BindingToNormalizedNodeCodec(GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy(), registry, true);
  76     }
  77
  78     @Test
  79     public void testComplexAugmentationSerialization() {
  80         this.codec.onGlobalContextUpdated(this.context);
  81         final PathArgument lastArg = this.codec.toYangInstanceIdentifier(BA_TREE_COMPLEX_USES).getLastPathArgument();
  82         assertTrue(lastArg instanceof AugmentationIdentifier);
  83     }
  84
  85
  86     @Test
  87     public void testLeafOnlyAugmentationSerialization() {
  88         this.codec.onGlobalContextUpdated(this.context);
  89         final PathArgument leafOnlyLastArg = this.codec.toYangInstanceIdentifier(BA_TREE_LEAF_ONLY).getLastPathArgument();
  90         assertTrue(leafOnlyLastArg instanceof AugmentationIdentifier);
  91         assertTrue(((AugmentationIdentifier) leafOnlyLastArg).getPossibleChildNames().contains(SIMPLE_VALUE_QNAME));
  92     }
  93
  94     @Test
  95     public void testToYangInstanceIdentifierBlocking() {
  96         this.codec.onGlobalContextUpdated(new EmptySchemaContext());
  97
  98         final CountDownLatch done = new CountDownLatch(1);
  99         final AtomicReference<YangInstanceIdentifier> yangId = new AtomicReference<>();
 100         final AtomicReference<RuntimeException> error = new AtomicReference<>();
 101         new Thread(() -> {
 102             try {
 103                 yangId.set(BindingNormalizedCodecTest.this.codec.toYangInstanceIdentifierBlocking(BA_TOP_LEVEL_LIST));
 104             } catch(final RuntimeException e) {
 105                 error.set(e);
 106             } finally {
 107                 done.countDown();
 108             }
 109         }).start();
 110
 111         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 112         this.codec.onGlobalContextUpdated(this.context);
 113
 114         assertEquals("toYangInstanceIdentifierBlocking completed", true,
 115                 Uninterruptibles.awaitUninterruptibly(done, 3, TimeUnit.SECONDS));
 116         if(error.get() != null) {
 117             throw error.get();
 118         }
 119
 120         assertEquals("toYangInstanceIdentifierBlocking", BI_TOP_LEVEL_LIST, yangId.get());
 121     }
 122
 123     @Test
 124     public void testGetRpcMethodToSchemaPathWithNoInitialSchemaContext() {
 125         testGetRpcMethodToSchemaPath();
 126     }
 127
 128     @Test
 129     public void testGetRpcMethodToSchemaPathBlocking() {
 130         this.codec.onGlobalContextUpdated(new EmptySchemaContext());
 131         testGetRpcMethodToSchemaPath();
 132     }
 133
 134     private void testGetRpcMethodToSchemaPath() {
 135         final CountDownLatch done = new CountDownLatch(1);
 136         final AtomicReference<ImmutableBiMap<Method, SchemaPath>> retMap = new AtomicReference<>();
 137         final AtomicReference<RuntimeException> error = new AtomicReference<>();
 138         new Thread(() -> {
 139             try {
 140                 retMap.set(BindingNormalizedCodecTest.this.codec.getRpcMethodToSchemaPath(OpendaylightTestRpcServiceService.class));
 141             } catch(final RuntimeException e) {
 142                 error.set(e);
 143             } finally {
 144                 done.countDown();
 145             }
 146         }).start();
 147
 148         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 149         this.codec.onGlobalContextUpdated(this.context);
 150
 151         assertEquals("getRpcMethodToSchemaPath completed", true,
 152                 Uninterruptibles.awaitUninterruptibly(done, 3, TimeUnit.SECONDS));
 153         if(error.get() != null) {
 154             throw error.get();
 155         }
 156
 157         for(final Method method: retMap.get().keySet()) {
 158             if(method.getName().equals("rockTheHouse")) {
 159                 return;
 160             }
 161         }
 162
 163         fail("rockTheHouse RPC method not found");
 164     }
 165
 166     static class EmptySchemaContext extends AbstractSchemaContext {
 167         @Override
 168         public Set<Module> getModules() {
 169             return ImmutableSet.of();
 170         }
 171
 172         @Override
 173         protected Map<QNameModule, Module> getModuleMap() {
 174             return ImmutableMap.of();
 175         }
 176
 177         @Override
 178         protected SetMultimap<URI, Module> getNamespaceToModules() {
 179             return ImmutableSetMultimap.of();
 180         }
 181
 182         @Override
 183         protected SetMultimap<String, Module> getNameToModules() {
 184             return ImmutableSetMultimap.of();
 185         }
 186     }
 187 }