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