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;
54 public class BindingTestContext implements AutoCloseable {
55 private BindingToNormalizedNodeCodec codec;
57 private RootBindingAwareBroker baBrokerImpl;
59 private HeliumNotificationProviderServiceAdapter baNotifyImpl;
62 private final ListeningExecutorService executor;
64 private final boolean startWithSchema;
66 private DOMMountPointService biMountImpl;
68 private ImmutableMap<LogicalDatastoreType, DOMStore> newDatastores;
70 private DOMDataBroker newDOMDataBroker;
72 private final MockSchemaService mockSchemaService = new MockSchemaService();
74 private DataBroker dataBroker;
76 private RpcConsumerRegistry baConsumerRpc;
78 private BindingDOMRpcProviderServiceAdapter baProviderRpc;
79 private DOMRpcRouter domRouter;
80 private org.opendaylight.mdsal.dom.broker.DOMRpcRouter delegateDomRouter;
82 private NotificationPublishService publishService;
84 private NotificationService listenService;
86 private DOMNotificationPublishService domPublishService;
88 private DOMNotificationService domListenService;
90 private Set<YangModuleInfo> schemaModuleInfos;
92 public DOMDataBroker getDomAsyncDataBroker() {
93 return this.newDOMDataBroker;
96 public BindingToNormalizedNodeCodec getCodec() {
101 protected BindingTestContext(final ListeningExecutorService executor, final boolean startWithSchema) {
102 this.executor = executor;
103 this.startWithSchema = startWithSchema;
106 public void startDomDataBroker() {
109 public void startNewDataBroker() {
110 checkState(this.executor != null, "Executor needs to be set");
111 checkState(this.newDOMDataBroker != null, "DOM Data Broker must be set");
112 this.dataBroker = new BindingDOMDataBrokerAdapter(this.newDOMDataBroker, this.codec);
115 public void startNewDomDataBroker() {
116 checkState(this.executor != null, "Executor needs to be set");
117 final InMemoryDOMDataStore operStore = new InMemoryDOMDataStore("OPER",
118 MoreExecutors.newDirectExecutorService());
119 final InMemoryDOMDataStore configStore = new InMemoryDOMDataStore("CFG",
120 MoreExecutors.newDirectExecutorService());
121 this.newDatastores = ImmutableMap.<LogicalDatastoreType, DOMStore>builder()
122 .put(LogicalDatastoreType.OPERATIONAL, operStore)
123 .put(LogicalDatastoreType.CONFIGURATION, configStore)
126 this.newDOMDataBroker = new SerializedDOMDataBroker(this.newDatastores, this.executor);
128 this.mockSchemaService.registerSchemaContextListener(configStore);
129 this.mockSchemaService.registerSchemaContextListener(operStore);
132 public void startBindingDataBroker() {
136 public void startBindingBroker() {
137 checkState(this.executor != null, "Executor needs to be set");
138 checkState(this.baNotifyImpl != null, "Notification Service must be started");
140 this.baConsumerRpc = new BindingDOMRpcServiceAdapter(getDomRpcInvoker(), this.codec);
141 this.baProviderRpc = new BindingDOMRpcProviderServiceAdapter(getDomRpcRegistry(), this.codec);
143 this.baBrokerImpl = new RootBindingAwareBroker("test");
145 final MountPointService mountService = new BindingDOMMountPointServiceAdapter(this.biMountImpl, this.codec);
146 this.baBrokerImpl.setMountService(mountService);
147 this.baBrokerImpl.setRpcBroker(new HeliumRpcProviderRegistry(this.baConsumerRpc, this.baProviderRpc));
148 this.baBrokerImpl.setNotificationBroker(this.baNotifyImpl);
149 this.baBrokerImpl.start();
152 public void startForwarding() {
156 public void startBindingToDomMappingService() {
157 final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
158 final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
159 this.codec = new BindingToNormalizedNodeCodec(loading, codecRegistry);
160 this.mockSchemaService.registerSchemaContextListener(this.codec);
163 private void updateYangSchema(final Set<YangModuleInfo> moduleInfos) {
164 this.mockSchemaService.changeSchema(getContext(moduleInfos));
167 private static SchemaContext getContext(final Set<YangModuleInfo> moduleInfos) {
168 final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
169 ctx.addModuleInfos(moduleInfos);
170 return ctx.tryToCreateSchemaContext().get();
173 public void start() {
174 startNewDomDataBroker();
177 startDomMountPoint();
178 startBindingToDomMappingService();
179 startNewDataBroker();
180 startBindingNotificationBroker();
181 startBindingBroker();
185 if (schemaModuleInfos != null) {
186 updateYangSchema(schemaModuleInfos);
187 } else if (this.startWithSchema) {
188 loadYangSchemaFromClasspath();
192 private void startDomMountPoint() {
193 this.biMountImpl = new DOMMountPointServiceImpl();
196 private void startDomBroker() {
197 checkState(this.executor != null);
199 delegateDomRouter = org.opendaylight.mdsal.dom.broker.DOMRpcRouter.newInstance(mockSchemaService);
200 this.domRouter = new DOMRpcRouter(delegateDomRouter.getRpcService(), delegateDomRouter.getRpcProviderService());
203 public void startBindingNotificationBroker() {
204 checkState(this.executor != null);
205 final DOMNotificationRouter router = DOMNotificationRouter.create(16);
206 this.domPublishService = router;
207 this.domListenService = router;
208 this.publishService = new BindingDOMNotificationPublishServiceAdapter(this.codec, this.domPublishService);
209 this.listenService = new BindingDOMNotificationServiceAdapter(this.codec, this.domListenService);
210 this.baNotifyImpl = new HeliumNotificationProviderServiceAdapter(this.publishService,this.listenService);
214 public void loadYangSchemaFromClasspath() {
215 updateYangSchema(BindingReflections.loadModuleInfos());
218 public RpcProviderRegistry getBindingRpcRegistry() {
219 return this.baBrokerImpl.getRoot();
222 public DOMRpcProviderService getDomRpcRegistry() {
223 return this.domRouter;
226 public DOMRpcService getDomRpcInvoker() {
227 return this.domRouter;
230 public org.opendaylight.mdsal.dom.broker.DOMRpcRouter getDelegateDomRouter() {
231 return delegateDomRouter;
235 public void close() {
239 public MountPointService getBindingMountPointService() {
240 return this.baBrokerImpl.getMountService();
243 public DOMMountPointService getDomMountProviderService() {
244 return this.biMountImpl;
247 public DataBroker getDataBroker() {
248 return this.dataBroker;
251 public void setSchemaModuleInfos(Set<YangModuleInfo> moduleInfos) {
252 this.schemaModuleInfos = moduleInfos;