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