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