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