2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.binding.test.util;
10 import static com.google.common.base.Preconditions.checkState;
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;
17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
18 import org.opendaylight.controller.md.sal.binding.api.MountPointService;
19 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
20 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
21 import org.opendaylight.controller.md.sal.binding.compat.HeliumNotificationProviderServiceAdapter;
22 import org.opendaylight.controller.md.sal.binding.compat.HeliumRpcProviderRegistry;
23 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMDataBrokerAdapter;
24 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMMountPointServiceAdapter;
25 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMNotificationPublishServiceAdapter;
26 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMNotificationServiceAdapter;
27 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMRpcProviderServiceAdapter;
28 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMRpcServiceAdapter;
29 import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
31 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
32 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
33 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService;
34 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationService;
35 import org.opendaylight.controller.md.sal.dom.api.DOMRpcProviderService;
36 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
37 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMNotificationRouter;
38 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMRpcRouter;
39 import org.opendaylight.controller.md.sal.dom.broker.impl.SerializedDOMDataBroker;
40 import org.opendaylight.controller.md.sal.dom.broker.impl.mount.DOMMountPointServiceImpl;
41 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore;
42 import org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry;
43 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
44 import org.opendaylight.controller.sal.binding.impl.RootBindingAwareBroker;
45 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
46 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
47 import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
48 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
49 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
50 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
51 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
55 public class BindingTestContext implements AutoCloseable {
56 private BindingToNormalizedNodeCodec codec;
58 private RootBindingAwareBroker baBrokerImpl;
60 private HeliumNotificationProviderServiceAdapter baNotifyImpl;
63 private final ListeningExecutorService executor;
65 private final boolean startWithSchema;
67 private DOMMountPointService biMountImpl;
69 private ImmutableMap<LogicalDatastoreType, DOMStore> newDatastores;
71 private DOMDataBroker newDOMDataBroker;
73 private final MockSchemaService mockSchemaService = new MockSchemaService();
75 private DataBroker dataBroker;
77 private RpcConsumerRegistry baConsumerRpc;
79 private BindingDOMRpcProviderServiceAdapter baProviderRpc;
80 private DOMRpcRouter domRouter;
81 private org.opendaylight.mdsal.dom.broker.DOMRpcRouter delegateDomRouter;
83 private NotificationPublishService publishService;
85 private NotificationService listenService;
87 private DOMNotificationPublishService domPublishService;
89 private DOMNotificationService domListenService;
91 private Set<YangModuleInfo> schemaModuleInfos;
93 public DOMDataBroker getDomAsyncDataBroker() {
94 return this.newDOMDataBroker;
97 public BindingToNormalizedNodeCodec getCodec() {
102 protected BindingTestContext(final ListeningExecutorService executor, final boolean startWithSchema) {
103 this.executor = executor;
104 this.startWithSchema = startWithSchema;
107 public void startDomDataBroker() {
110 public void startNewDataBroker() {
111 checkState(this.executor != null, "Executor needs to be set");
112 checkState(this.newDOMDataBroker != null, "DOM Data Broker must be set");
113 this.dataBroker = new BindingDOMDataBrokerAdapter(this.newDOMDataBroker, this.codec);
116 public void startNewDomDataBroker() {
117 checkState(this.executor != null, "Executor needs to be set");
118 final InMemoryDOMDataStore operStore = new InMemoryDOMDataStore("OPER",
119 MoreExecutors.newDirectExecutorService());
120 final InMemoryDOMDataStore configStore = new InMemoryDOMDataStore("CFG",
121 MoreExecutors.newDirectExecutorService());
122 this.newDatastores = ImmutableMap.<LogicalDatastoreType, DOMStore>builder()
123 .put(LogicalDatastoreType.OPERATIONAL, operStore)
124 .put(LogicalDatastoreType.CONFIGURATION, configStore)
127 this.newDOMDataBroker = new SerializedDOMDataBroker(this.newDatastores, this.executor);
129 this.mockSchemaService.registerSchemaContextListener(configStore);
130 this.mockSchemaService.registerSchemaContextListener(operStore);
133 public void startBindingDataBroker() {
137 public void startBindingBroker() {
138 checkState(this.executor != null, "Executor needs to be set");
139 checkState(this.baNotifyImpl != null, "Notification Service must be started");
141 this.baConsumerRpc = new BindingDOMRpcServiceAdapter(getDomRpcInvoker(), this.codec);
142 this.baProviderRpc = new BindingDOMRpcProviderServiceAdapter(getDomRpcRegistry(), this.codec);
144 this.baBrokerImpl = new RootBindingAwareBroker("test");
146 final MountPointService mountService = new BindingDOMMountPointServiceAdapter(this.biMountImpl, this.codec);
147 this.baBrokerImpl.setMountService(mountService);
148 this.baBrokerImpl.setRpcBroker(new HeliumRpcProviderRegistry(this.baConsumerRpc, this.baProviderRpc));
149 this.baBrokerImpl.setNotificationBroker(this.baNotifyImpl);
150 this.baBrokerImpl.start();
153 public void startForwarding() {
157 public void startBindingToDomMappingService() {
158 final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
159 final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
160 this.codec = new BindingToNormalizedNodeCodec(loading, codecRegistry);
161 this.mockSchemaService.registerSchemaContextListener(this.codec);
164 private void updateYangSchema(final Set<YangModuleInfo> moduleInfos) {
165 this.mockSchemaService.changeSchema(getContext(moduleInfos));
168 private static SchemaContext getContext(final Set<YangModuleInfo> moduleInfos) {
169 final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
170 ctx.addModuleInfos(moduleInfos);
171 return ctx.tryToCreateSchemaContext().get();
174 public void start() {
175 startNewDomDataBroker();
178 startDomMountPoint();
179 startBindingToDomMappingService();
180 startNewDataBroker();
181 startBindingNotificationBroker();
182 startBindingBroker();
186 if (schemaModuleInfos != null) {
187 updateYangSchema(schemaModuleInfos);
188 } else if (this.startWithSchema) {
189 loadYangSchemaFromClasspath();
193 private void startDomMountPoint() {
194 this.biMountImpl = new DOMMountPointServiceImpl();
197 private void startDomBroker() {
198 checkState(this.executor != null);
200 delegateDomRouter = org.opendaylight.mdsal.dom.broker.DOMRpcRouter.newInstance(mockSchemaService);
201 this.domRouter = new DOMRpcRouter(delegateDomRouter.getRpcService(), delegateDomRouter.getRpcProviderService());
204 public void startBindingNotificationBroker() {
205 checkState(this.executor != null);
206 final DOMNotificationRouter router = DOMNotificationRouter.create(16);
207 this.domPublishService = router;
208 this.domListenService = router;
209 this.publishService = new BindingDOMNotificationPublishServiceAdapter(this.codec, this.domPublishService);
210 this.listenService = new BindingDOMNotificationServiceAdapter(this.codec, this.domListenService);
211 this.baNotifyImpl = new HeliumNotificationProviderServiceAdapter(this.publishService,this.listenService);
215 public void loadYangSchemaFromClasspath() {
216 updateYangSchema(BindingReflections.loadModuleInfos());
219 public RpcProviderRegistry getBindingRpcRegistry() {
220 return this.baBrokerImpl.getRoot();
223 public DOMRpcProviderService getDomRpcRegistry() {
224 return this.domRouter;
227 public DOMRpcService getDomRpcInvoker() {
228 return this.domRouter;
231 public org.opendaylight.mdsal.dom.broker.DOMRpcRouter getDelegateDomRouter() {
232 return delegateDomRouter;
236 public void close() {
240 public MountPointService getBindingMountPointService() {
241 return this.baBrokerImpl.getMountService();
244 public DOMMountPointService getDomMountProviderService() {
245 return this.biMountImpl;
248 public DataBroker getDataBroker() {
249 return this.dataBroker;
252 public void setSchemaModuleInfos(Set<YangModuleInfo> moduleInfos) {
253 this.schemaModuleInfos = moduleInfos;