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