opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/sal/binding/test/util/BindingTestContext.java

   1 /*
   2  * Copyright (c) 2014 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.controller.sal.binding.test.util;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import com.google.common.annotations.Beta;
  12 import com.google.common.collect.ClassToInstanceMap;
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.ImmutableSet;
  15 import com.google.common.collect.MutableClassToInstanceMap;
  16 import com.google.common.util.concurrent.ListeningExecutorService;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  19 import org.opendaylight.controller.md.sal.binding.api.MountPointService;
  20 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  21 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  22 import org.opendaylight.controller.md.sal.binding.compat.HeliumNotificationProviderServiceAdapter;
  23 import org.opendaylight.controller.md.sal.binding.compat.HeliumRpcProviderRegistry;
  24 import org.opendaylight.controller.md.sal.binding.compat.HydrogenDataBrokerAdapter;
  25 import org.opendaylight.controller.md.sal.binding.compat.HydrogenMountProvisionServiceAdapter;
  26 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMDataBrokerAdapter;
  27 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMMountPointServiceAdapter;
  28 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMNotificationPublishServiceAdapter;
  29 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMNotificationServiceAdapter;
  30 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMRpcProviderServiceAdapter;
  31 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMRpcServiceAdapter;
  32 import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
  33 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  34 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  35 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  36 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService;
  37 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationService;
  38 import org.opendaylight.controller.md.sal.dom.api.DOMRpcProviderService;
  39 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  40 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMNotificationRouter;
  41 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMRpcRouter;
  42 import org.opendaylight.controller.md.sal.dom.broker.impl.SerializedDOMDataBroker;
  43 import org.opendaylight.controller.md.sal.dom.broker.impl.mount.DOMMountPointServiceImpl;
  44 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore;
  45 import org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry;
  46 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  47 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  48 import org.opendaylight.controller.sal.binding.api.mount.MountProviderService;
  49 import org.opendaylight.controller.sal.binding.impl.RootBindingAwareBroker;
  50 import org.opendaylight.controller.sal.core.api.BrokerService;
  51 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  52 import org.opendaylight.controller.sal.dom.broker.BrokerImpl;
  53 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
  54 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
  55 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  56 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  57 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
  58 import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
  59 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  60 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  61 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  62 import javassist.ClassPool;
  63
  64 @Beta
  65 public class BindingTestContext implements AutoCloseable {
  66
  67
  68     private BindingToNormalizedNodeCodec codec;
  69
  70     private RootBindingAwareBroker baBrokerImpl;
  71
  72     private HeliumNotificationProviderServiceAdapter baNotifyImpl;
  73
  74
  75     private BrokerImpl biBrokerImpl;
  76
  77     private final ListeningExecutorService executor;
  78     private final ClassPool classPool;
  79
  80     private final boolean startWithSchema;
  81
  82     private DOMMountPointService biMountImpl;
  83
  84     private ImmutableMap<LogicalDatastoreType, DOMStore> newDatastores;
  85
  86     @Deprecated
  87     private DataProviderService baData;
  88
  89     private DOMDataBroker newDOMDataBroker;
  90
  91     private final MockSchemaService mockSchemaService = new MockSchemaService();
  92
  93     private DataBroker dataBroker;
  94
  95     private RpcConsumerRegistry baConsumerRpc;
  96
  97     private BindingDOMRpcProviderServiceAdapter baProviderRpc;
  98     private DOMRpcRouter domRouter;
  99
 100     private NotificationPublishService publishService;
 101
 102     private NotificationService listenService;
 103
 104     private DOMNotificationPublishService domPublishService;
 105
 106     private DOMNotificationService domListenService;
 107
 108
 109
 110     public DOMDataBroker getDomAsyncDataBroker() {
 111         return newDOMDataBroker;
 112     }
 113
 114     public BindingToNormalizedNodeCodec getCodec() {
 115         return codec;
 116     }
 117
 118     protected BindingTestContext(final ListeningExecutorService executor, final ClassPool classPool, final boolean startWithSchema) {
 119         this.executor = executor;
 120         this.classPool = classPool;
 121         this.startWithSchema = startWithSchema;
 122     }
 123
 124     public void startDomDataBroker() {
 125     }
 126
 127     public void startNewDataBroker() {
 128         checkState(executor != null, "Executor needs to be set");
 129         checkState(newDOMDataBroker != null, "DOM Data Broker must be set");
 130         dataBroker = new BindingDOMDataBrokerAdapter(newDOMDataBroker, codec);
 131     }
 132
 133     public void startNewDomDataBroker() {
 134         checkState(executor != null, "Executor needs to be set");
 135         final InMemoryDOMDataStore operStore = new InMemoryDOMDataStore("OPER", MoreExecutors.sameThreadExecutor());
 136         final InMemoryDOMDataStore configStore = new InMemoryDOMDataStore("CFG", MoreExecutors.sameThreadExecutor());
 137         newDatastores = ImmutableMap.<LogicalDatastoreType, DOMStore>builder()
 138                 .put(LogicalDatastoreType.OPERATIONAL, operStore)
 139                 .put(LogicalDatastoreType.CONFIGURATION, configStore)
 140                 .build();
 141
 142         newDOMDataBroker = new SerializedDOMDataBroker(newDatastores, executor);
 143
 144         mockSchemaService.registerSchemaContextListener(configStore);
 145         mockSchemaService.registerSchemaContextListener(operStore);
 146     }
 147
 148     public void startBindingDataBroker() {
 149
 150     }
 151
 152     public void startBindingBroker() {
 153         checkState(executor != null, "Executor needs to be set");
 154         checkState(baData != null, "Binding Data Broker must be started");
 155         checkState(baNotifyImpl != null, "Notification Service must be started");
 156
 157         baConsumerRpc = new BindingDOMRpcServiceAdapter(getDomRpcInvoker(), codec);
 158         baProviderRpc = new BindingDOMRpcProviderServiceAdapter(getDomRpcRegistry(), codec);
 159
 160         baBrokerImpl = new RootBindingAwareBroker("test");
 161
 162         final MountPointService mountService = new BindingDOMMountPointServiceAdapter(biMountImpl, codec);
 163         baBrokerImpl.setMountService(mountService);
 164         baBrokerImpl.setLegacyMountManager(new HydrogenMountProvisionServiceAdapter(mountService));
 165         baBrokerImpl.setRpcBroker(new HeliumRpcProviderRegistry(baConsumerRpc, baProviderRpc));
 166         baBrokerImpl.setLegacyDataBroker(baData);
 167         baBrokerImpl.setNotificationBroker(baNotifyImpl);
 168         baBrokerImpl.start();
 169     }
 170
 171     public void startForwarding() {
 172
 173     }
 174
 175     public void startBindingToDomMappingService() {
 176         checkState(classPool != null, "ClassPool needs to be present");
 177
 178         final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(JavassistUtils.forClassPool(classPool));
 179         final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(generator);
 180         final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
 181         codec = new BindingToNormalizedNodeCodec(loading,  codecRegistry);
 182         mockSchemaService.registerSchemaContextListener(codec);
 183     }
 184
 185     private void updateYangSchema(final ImmutableSet<YangModuleInfo> moduleInfos) {
 186         mockSchemaService.changeSchema(getContext(moduleInfos));
 187     }
 188
 189     private SchemaContext getContext(final ImmutableSet<YangModuleInfo> moduleInfos) {
 190         final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
 191         ctx.addModuleInfos(moduleInfos);
 192         return ctx.tryToCreateSchemaContext().get();
 193     }
 194
 195     public void start() {
 196         startNewDomDataBroker();
 197
 198         startDomBroker();
 199         startDomMountPoint();
 200         startBindingToDomMappingService();
 201         startNewDataBroker();
 202         startNewBindingDataBroker();
 203         startBindingNotificationBroker();
 204         startBindingBroker();
 205
 206         startForwarding();
 207         if (startWithSchema) {
 208             loadYangSchemaFromClasspath();
 209         }
 210     }
 211
 212     public void startNewBindingDataBroker() {
 213         final HydrogenDataBrokerAdapter forwarded = new HydrogenDataBrokerAdapter(dataBroker);
 214         baData = forwarded;
 215     }
 216
 217     private void startDomMountPoint() {
 218         biMountImpl = new DOMMountPointServiceImpl();
 219     }
 220
 221     private void startDomBroker() {
 222         checkState(executor != null);
 223
 224         domRouter = new DOMRpcRouter();
 225         mockSchemaService.registerSchemaContextListener(domRouter);
 226
 227         final ClassToInstanceMap<BrokerService> services = MutableClassToInstanceMap.create();
 228         services.put(DOMRpcService.class, domRouter);
 229
 230         biBrokerImpl = new BrokerImpl(domRouter,services);
 231
 232     }
 233
 234     public void startBindingNotificationBroker() {
 235         checkState(executor != null);
 236         final DOMNotificationRouter router = DOMNotificationRouter.create(16);
 237         domPublishService = router;
 238         domListenService = router;
 239         publishService = new BindingDOMNotificationPublishServiceAdapter(codec, domPublishService);
 240         listenService = new BindingDOMNotificationServiceAdapter(codec, domListenService);
 241         baNotifyImpl = new HeliumNotificationProviderServiceAdapter(publishService,listenService);
 242
 243     }
 244
 245     public void loadYangSchemaFromClasspath() {
 246         final ImmutableSet<YangModuleInfo> moduleInfos = BindingReflections.loadModuleInfos();
 247         updateYangSchema(moduleInfos);
 248     }
 249
 250     @Deprecated
 251     public DataProviderService getBindingDataBroker() {
 252         return baData;
 253     }
 254
 255     public RpcProviderRegistry getBindingRpcRegistry() {
 256         return baBrokerImpl.getRoot();
 257     }
 258
 259     public DOMRpcProviderService getDomRpcRegistry() {
 260         return domRouter;
 261     }
 262
 263     public DOMRpcService getDomRpcInvoker() {
 264         return domRouter;
 265     }
 266
 267     @Override
 268     public void close() throws Exception {
 269
 270     }
 271
 272     public MountProviderService getBindingMountProviderService() {
 273         return baBrokerImpl.getLegacyMount();
 274     }
 275
 276     public DOMMountPointService getDomMountProviderService() {
 277         return biMountImpl;
 278     }
 279
 280     public DataBroker getDataBroker() {
 281         return dataBroker;
 282     }
 283
 284
 285 }