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.compat.HydrogenMountProvisionServiceAdapter;
  27 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMDataBrokerAdapter;
  28 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMMountPointServiceAdapter;
  29 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMNotificationPublishServiceAdapter;
  30 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMNotificationServiceAdapter;
  31 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMRpcProviderServiceAdapter;
  32 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMRpcServiceAdapter;
  33 import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
  34 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  35 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  36 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  37 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService;
  38 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationService;
  39 import org.opendaylight.controller.md.sal.dom.api.DOMRpcProviderService;
  40 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  41 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMNotificationRouter;
  42 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMRpcRouter;
  43 import org.opendaylight.controller.md.sal.dom.broker.impl.SerializedDOMDataBroker;
  44 import org.opendaylight.controller.md.sal.dom.broker.impl.mount.DOMMountPointServiceImpl;
  45 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore;
  46 import org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry;
  47 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  48 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  49 import org.opendaylight.controller.sal.binding.api.mount.MountProviderService;
  50 import org.opendaylight.controller.sal.binding.impl.RootBindingAwareBroker;
  51 import org.opendaylight.controller.sal.core.api.BrokerService;
  52 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  53 import org.opendaylight.controller.sal.dom.broker.BrokerImpl;
  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.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
  58 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
  59 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  60 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  61 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  62 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  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 this.newDOMDataBroker;
 112     }
 113
 114     public BindingToNormalizedNodeCodec getCodec() {
 115         return this.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(this.executor != null, "Executor needs to be set");
 129         checkState(this.newDOMDataBroker != null, "DOM Data Broker must be set");
 130         this.dataBroker = new BindingDOMDataBrokerAdapter(this.newDOMDataBroker, this.codec);
 131     }
 132
 133     public void startNewDomDataBroker() {
 134         checkState(this.executor != null, "Executor needs to be set");
 135         final InMemoryDOMDataStore operStore = new InMemoryDOMDataStore("OPER",
 136             MoreExecutors.newDirectExecutorService());
 137         final InMemoryDOMDataStore configStore = new InMemoryDOMDataStore("CFG",
 138             MoreExecutors.newDirectExecutorService());
 139         this.newDatastores = ImmutableMap.<LogicalDatastoreType, DOMStore>builder()
 140                 .put(LogicalDatastoreType.OPERATIONAL, operStore)
 141                 .put(LogicalDatastoreType.CONFIGURATION, configStore)
 142                 .build();
 143
 144         this.newDOMDataBroker = new SerializedDOMDataBroker(this.newDatastores, this.executor);
 145
 146         this.mockSchemaService.registerSchemaContextListener(configStore);
 147         this.mockSchemaService.registerSchemaContextListener(operStore);
 148     }
 149
 150     public void startBindingDataBroker() {
 151
 152     }
 153
 154     public void startBindingBroker() {
 155         checkState(this.executor != null, "Executor needs to be set");
 156         checkState(this.baNotifyImpl != null, "Notification Service must be started");
 157
 158         this.baConsumerRpc = new BindingDOMRpcServiceAdapter(getDomRpcInvoker(), this.codec);
 159         this.baProviderRpc = new BindingDOMRpcProviderServiceAdapter(getDomRpcRegistry(), this.codec);
 160
 161         this.baBrokerImpl = new RootBindingAwareBroker("test");
 162
 163         final MountPointService mountService = new BindingDOMMountPointServiceAdapter(this.biMountImpl, this.codec);
 164         this.baBrokerImpl.setMountService(mountService);
 165         this.baBrokerImpl.setLegacyMountManager(new HydrogenMountProvisionServiceAdapter(mountService));
 166         this.baBrokerImpl.setRpcBroker(new HeliumRpcProviderRegistry(this.baConsumerRpc, this.baProviderRpc));
 167         this.baBrokerImpl.setNotificationBroker(this.baNotifyImpl);
 168         this.baBrokerImpl.start();
 169     }
 170
 171     public void startForwarding() {
 172
 173     }
 174
 175     public void startBindingToDomMappingService() {
 176         checkState(this.classPool != null, "ClassPool needs to be present");
 177
 178         final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(JavassistUtils.forClassPool(this.classPool));
 179         final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(generator);
 180         final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
 181         this.codec = new BindingToNormalizedNodeCodec(loading,  codecRegistry);
 182         this.mockSchemaService.registerSchemaContextListener(this.codec);
 183     }
 184
 185     private void updateYangSchema(final ImmutableSet<YangModuleInfo> moduleInfos) {
 186         this.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         startBindingNotificationBroker();
 203         startBindingBroker();
 204
 205         startForwarding();
 206         if (this.startWithSchema) {
 207             loadYangSchemaFromClasspath();
 208         }
 209     }
 210
 211     private void startDomMountPoint() {
 212         this.biMountImpl = new DOMMountPointServiceImpl();
 213     }
 214
 215     private void startDomBroker() {
 216         checkState(this.executor != null);
 217
 218         this.domRouter = new DOMRpcRouter();
 219         this.mockSchemaService.registerSchemaContextListener(this.domRouter);
 220
 221         final ClassToInstanceMap<BrokerService> services = MutableClassToInstanceMap.create();
 222         services.put(DOMRpcService.class, this.domRouter);
 223
 224         this.biBrokerImpl = new BrokerImpl(this.domRouter,services);
 225
 226     }
 227
 228     public void startBindingNotificationBroker() {
 229         checkState(this.executor != null);
 230         final DOMNotificationRouter router = DOMNotificationRouter.create(16);
 231         this.domPublishService = router;
 232         this.domListenService = router;
 233         this.publishService = new BindingDOMNotificationPublishServiceAdapter(this.codec, this.domPublishService);
 234         this.listenService = new BindingDOMNotificationServiceAdapter(this.codec, this.domListenService);
 235         this.baNotifyImpl = new HeliumNotificationProviderServiceAdapter(this.publishService,this.listenService);
 236
 237     }
 238
 239     public void loadYangSchemaFromClasspath() {
 240         final ImmutableSet<YangModuleInfo> moduleInfos = BindingReflections.loadModuleInfos();
 241         updateYangSchema(moduleInfos);
 242     }
 243
 244     public RpcProviderRegistry getBindingRpcRegistry() {
 245         return this.baBrokerImpl.getRoot();
 246     }
 247
 248     public DOMRpcProviderService getDomRpcRegistry() {
 249         return this.domRouter;
 250     }
 251
 252     public DOMRpcService getDomRpcInvoker() {
 253         return this.domRouter;
 254     }
 255
 256     @Override
 257     public void close() throws Exception {
 258
 259     }
 260
 261     public MountProviderService getBindingMountProviderService() {
 262         return this.baBrokerImpl.getLegacyMount();
 263     }
 264
 265     public DOMMountPointService getDomMountProviderService() {
 266         return this.biMountImpl;
 267     }
 268
 269     public DataBroker getDataBroker() {
 270         return this.dataBroker;
 271     }
 272
 273
 274 }