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 java.io.InputStream;
13 import java.util.ArrayList;
14 import java.util.List;
16 import java.util.concurrent.Future;
18 import javassist.ClassPool;
20 import org.opendaylight.controller.md.sal.binding.impl.ForwardedBackwardsCompatibleDataBroker;
21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
22 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
23 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMDataBrokerImpl;
24 import org.opendaylight.controller.md.sal.dom.broker.impl.compat.BackwardsCompatibleDataBroker;
25 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore;
26 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
27 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
28 import org.opendaylight.controller.sal.binding.api.mount.MountProviderService;
29 import org.opendaylight.controller.sal.binding.impl.DataBrokerImpl;
30 import org.opendaylight.controller.sal.binding.impl.NotificationBrokerImpl;
31 import org.opendaylight.controller.sal.binding.impl.RpcProviderRegistryImpl;
32 import org.opendaylight.controller.sal.binding.impl.connect.dom.BindingDomConnectorDeployer;
33 import org.opendaylight.controller.sal.binding.impl.connect.dom.BindingIndependentConnector;
34 import org.opendaylight.controller.sal.binding.impl.forward.DomForwardedBindingBrokerImpl;
35 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
36 import org.opendaylight.controller.sal.core.api.Broker.RoutedRpcRegistration;
37 import org.opendaylight.controller.sal.core.api.Broker.RpcRegistration;
38 import org.opendaylight.controller.sal.core.api.BrokerService;
39 import org.opendaylight.controller.sal.core.api.RpcImplementation;
40 import org.opendaylight.controller.sal.core.api.RpcProvisionRegistry;
41 import org.opendaylight.controller.sal.core.api.RpcRegistrationListener;
42 import org.opendaylight.controller.sal.core.api.data.DataStore;
43 import org.opendaylight.controller.sal.core.api.mount.MountProvisionService;
44 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
45 import org.opendaylight.controller.sal.dom.broker.BrokerImpl;
46 import org.opendaylight.controller.sal.dom.broker.MountPointManagerImpl;
47 import org.opendaylight.controller.sal.dom.broker.impl.DataStoreStatsWrapper;
48 import org.opendaylight.controller.sal.dom.broker.impl.HashMapDataStore;
49 import org.opendaylight.controller.sal.dom.broker.impl.SchemaAwareDataStoreAdapter;
50 import org.opendaylight.controller.sal.dom.broker.impl.SchemaAwareRpcBroker;
51 import org.opendaylight.controller.sal.dom.broker.impl.SchemaContextProvider;
52 import org.opendaylight.yangtools.concepts.ListenerRegistration;
53 import org.opendaylight.yangtools.sal.binding.generator.impl.RuntimeGeneratedMappingServiceImpl;
54 import org.opendaylight.yangtools.yang.common.QName;
55 import org.opendaylight.yangtools.yang.common.RpcResult;
56 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
57 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
58 import org.opendaylight.yangtools.yang.model.api.Module;
59 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
60 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
61 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
62 import org.reflections.Reflections;
63 import org.reflections.scanners.ResourcesScanner;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
67 import com.google.common.base.Predicate;
68 import com.google.common.collect.ClassToInstanceMap;
69 import com.google.common.collect.ImmutableClassToInstanceMap;
70 import com.google.common.collect.ImmutableMap;
71 import com.google.common.util.concurrent.ListeningExecutorService;
73 public class BindingTestContext implements AutoCloseable, SchemaContextProvider {
75 public static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier TREE_ROOT = org.opendaylight.yangtools.yang.data.api.InstanceIdentifier
76 .builder().toInstance();
78 private static final Logger LOG = LoggerFactory.getLogger(BindingTestContext.class);
80 private RuntimeGeneratedMappingServiceImpl mappingServiceImpl;
82 private DomForwardedBindingBrokerImpl baBrokerImpl;
83 private DataBrokerImpl baDataImpl;
84 private NotificationBrokerImpl baNotifyImpl;
85 private BindingIndependentConnector baConnectImpl;
87 private org.opendaylight.controller.sal.dom.broker.DataBrokerImpl biDataImpl;
88 private org.opendaylight.controller.sal.core.api.data.DataProviderService biDataLegacyBroker;
89 private BrokerImpl biBrokerImpl;
90 private HashMapDataStore rawDataStore;
91 private SchemaAwareDataStoreAdapter schemaAwareDataStore;
92 private DataStoreStatsWrapper dataStoreStats;
93 private DataStore dataStore;
95 private final boolean dataStoreStatisticsEnabled = false;
97 private final ListeningExecutorService executor;
98 private final ClassPool classPool;
100 private final boolean startWithSchema;
102 private MountPointManagerImpl biMountImpl;
104 private SchemaContext schemaContext;
106 private ImmutableMap<LogicalDatastoreType, DOMStore> newDatastores;
108 private BackwardsCompatibleDataBroker biCompatibleBroker;
110 private final List<SchemaContextListener> schemaListeners = new ArrayList<>();
112 private DataProviderService baData;
114 private DOMDataBroker newDOMDataBroker;
117 public SchemaContext getSchemaContext() {
118 return schemaContext;
121 protected BindingTestContext(final ListeningExecutorService executor, final ClassPool classPool, final boolean startWithSchema) {
122 this.executor = executor;
123 this.classPool = classPool;
124 this.startWithSchema = startWithSchema;
127 public void startDomDataStore() {
128 checkState(dataStore == null, "DataStore already started.");
129 checkState(biDataImpl != null, "Dom Data Broker not present");
130 rawDataStore = new HashMapDataStore();
131 schemaAwareDataStore = new SchemaAwareDataStoreAdapter();
132 schemaAwareDataStore.changeDelegate(rawDataStore);
133 if (dataStoreStatisticsEnabled) {
134 dataStoreStats = new DataStoreStatsWrapper(schemaAwareDataStore);
135 dataStore = dataStoreStats;
137 dataStore = schemaAwareDataStore;
140 biDataImpl.registerConfigurationReader(TREE_ROOT, dataStore);
141 biDataImpl.registerOperationalReader(TREE_ROOT, dataStore);
142 biDataImpl.registerCommitHandler(TREE_ROOT, dataStore);
145 public void startDomDataBroker() {
146 checkState(executor != null, "Executor needs to be set");
147 biDataImpl = new org.opendaylight.controller.sal.dom.broker.DataBrokerImpl();
148 biDataImpl.setExecutor(executor);
149 biDataLegacyBroker = biDataImpl;
152 public void startNewDomDataBroker() {
153 checkState(executor != null, "Executor needs to be set");
154 InMemoryDOMDataStore operStore = new InMemoryDOMDataStore("OPER", executor);
155 InMemoryDOMDataStore configStore = new InMemoryDOMDataStore("CFG", executor);
156 newDatastores = ImmutableMap.<LogicalDatastoreType, DOMStore>builder()
157 .put(LogicalDatastoreType.OPERATIONAL, operStore)
158 .put(LogicalDatastoreType.CONFIGURATION, configStore)
161 newDOMDataBroker = new DOMDataBrokerImpl(newDatastores, executor);
163 biCompatibleBroker = new BackwardsCompatibleDataBroker(newDOMDataBroker);
165 schemaListeners.add(configStore);
166 schemaListeners.add(operStore);
167 schemaListeners.add(biCompatibleBroker);
168 biDataLegacyBroker = biCompatibleBroker;
171 public void startBindingDataBroker() {
172 checkState(executor != null, "Executor needs to be set");
173 baDataImpl = new DataBrokerImpl();
174 baDataImpl.setExecutor(executor);
178 public void startBindingBroker() {
179 checkState(executor != null, "Executor needs to be set");
180 checkState(baData != null, "Binding Data Broker must be started");
181 checkState(baNotifyImpl != null, "Notification Service must be started");
182 baBrokerImpl = new DomForwardedBindingBrokerImpl("test");
184 baBrokerImpl.getMountManager().setDataCommitExecutor(executor);
185 baBrokerImpl.getMountManager().setNotificationExecutor(executor);
186 baBrokerImpl.setRpcBroker(new RpcProviderRegistryImpl("test"));
187 baBrokerImpl.setDataBroker(baData);
188 baBrokerImpl.setNotificationBroker(baNotifyImpl);
189 baBrokerImpl.start();
192 public void startForwarding() {
193 checkState(baData != null, "Binding Data Broker needs to be started");
194 checkState(biDataLegacyBroker != null, "DOM Data Broker needs to be started.");
195 checkState(mappingServiceImpl != null, "DOM Mapping Service needs to be started.");
197 baConnectImpl = BindingDomConnectorDeployer.createConnector(getBindingToDomMappingService());
198 baConnectImpl.setDomRpcRegistry(getDomRpcRegistry());
199 baBrokerImpl.setConnector(baConnectImpl);
200 baBrokerImpl.setDomProviderContext(createMockContext());
201 baBrokerImpl.startForwarding();
204 private ProviderSession createMockContext() {
206 final ClassToInstanceMap<BrokerService> domBrokerServices = ImmutableClassToInstanceMap
207 .<BrokerService> builder()
209 .put(org.opendaylight.controller.sal.core.api.data.DataProviderService.class, biDataLegacyBroker) //
210 .put(RpcProvisionRegistry.class, biBrokerImpl.getRouter()) //
211 .put(MountProvisionService.class, biMountImpl) //
214 return new ProviderSession() {
217 public Future<RpcResult<CompositeNode>> rpc(final QName rpc, final CompositeNode input) {
218 throw new UnsupportedOperationException();
222 public <T extends BrokerService> T getService(final Class<T> service) {
223 return domBrokerServices.getInstance(service);
227 public boolean isClosed() {
232 public Set<QName> getSupportedRpcs() {
237 public void close() {
241 public ListenerRegistration<RpcRegistrationListener> addRpcRegistrationListener(
242 final RpcRegistrationListener listener) {
247 public RpcRegistration addRpcImplementation(final QName rpcType, final RpcImplementation implementation)
248 throws IllegalArgumentException {
253 public RoutedRpcRegistration addRoutedRpcImplementation(final QName rpcType, final RpcImplementation implementation) {
258 public RoutedRpcRegistration addMountedRpcImplementation(final QName rpcType, final RpcImplementation implementation) {
264 public void startBindingToDomMappingService() {
265 checkState(classPool != null, "ClassPool needs to be present");
266 mappingServiceImpl = new RuntimeGeneratedMappingServiceImpl();
267 mappingServiceImpl.setPool(classPool);
268 mappingServiceImpl.init();
271 public void updateYangSchema(final String[] files) {
272 schemaContext = getContext(files);
274 if (schemaAwareDataStore != null) {
275 schemaAwareDataStore.onGlobalContextUpdated(schemaContext);
277 if (mappingServiceImpl != null) {
278 mappingServiceImpl.onGlobalContextUpdated(schemaContext);
280 for(SchemaContextListener listener : schemaListeners) {
281 listener.onGlobalContextUpdated(schemaContext);
285 public static String[] getAllYangFilesOnClasspath() {
286 Predicate<String> predicate = new Predicate<String>() {
288 public boolean apply(final String input) {
289 return input.endsWith(".yang");
292 Reflections reflection = new Reflections("META-INF.yang", new ResourcesScanner());
293 Set<String> result = reflection.getResources(predicate);
294 return result.toArray(new String[result.size()]);
297 private static SchemaContext getContext(final String[] yangFiles) {
298 ClassLoader loader = BindingTestContext.class.getClassLoader();
299 List<InputStream> streams = new ArrayList<>();
300 for (String string : yangFiles) {
301 InputStream stream = loader.getResourceAsStream(string);
304 YangParserImpl parser = new YangParserImpl();
305 Set<Module> modules = parser.parseYangModelsFromStreams(streams);
306 return parser.resolveSchemaContext(modules);
309 public void startLegacy() {
310 startBindingDataBroker();
311 startBindingNotificationBroker();
312 startBindingBroker();
313 startDomDataBroker();
316 startDomMountPoint();
317 startBindingToDomMappingService();
319 if (startWithSchema) {
320 loadYangSchemaFromClasspath();
324 public void start() {
325 startNewDomDataBroker();
327 startDomMountPoint();
328 startBindingToDomMappingService();
329 startNewBindingDataBroker();
331 startBindingNotificationBroker();
332 startBindingBroker();
335 if (startWithSchema) {
336 loadYangSchemaFromClasspath();
340 public void startNewBindingDataBroker() {
341 ForwardedBackwardsCompatibleDataBroker forwarded = new ForwardedBackwardsCompatibleDataBroker(newDOMDataBroker, mappingServiceImpl, executor);
342 schemaListeners.add(forwarded);
346 private void startDomMountPoint() {
347 biMountImpl = new MountPointManagerImpl();
348 biMountImpl.setDataBroker(getDomDataBroker());
351 private void startDomBroker() {
352 checkState(executor != null);
353 biBrokerImpl = new BrokerImpl();
354 biBrokerImpl.setExecutor(executor);
355 biBrokerImpl.setRouter(new SchemaAwareRpcBroker("/", this));
359 public void startBindingNotificationBroker() {
360 checkState(executor != null);
361 baNotifyImpl = new NotificationBrokerImpl(executor);
365 public void loadYangSchemaFromClasspath() {
366 String[] files = getAllYangFilesOnClasspath();
367 updateYangSchema(files);
370 public DataProviderService getBindingDataBroker() {
374 public org.opendaylight.controller.sal.core.api.data.DataProviderService getDomDataBroker() {
375 return biDataLegacyBroker;
378 public DataStore getDomDataStore() {
382 public BindingIndependentMappingService getBindingToDomMappingService() {
383 return mappingServiceImpl;
386 public void logDataStoreStatistics() {
387 if (dataStoreStats == null) {
391 LOG.info("BIDataStore Statistics: Configuration Read Count: {} TotalTime: {} ms AverageTime (ns): {} ms",
392 dataStoreStats.getConfigurationReadCount(), dataStoreStats.getConfigurationReadTotalTime(),
393 dataStoreStats.getConfigurationReadAverageTime());
395 LOG.info("BIDataStore Statistics: Operational Read Count: {} TotalTime: {} ms AverageTime (ns): {} ms",
396 dataStoreStats.getOperationalReadCount(), dataStoreStats.getOperationalReadTotalTime(),
397 dataStoreStats.getOperationalReadAverageTime());
399 LOG.info("BIDataStore Statistics: Request Commit Count: {} TotalTime: {} ms AverageTime (ns): {} ms",
400 dataStoreStats.getRequestCommitCount(), dataStoreStats.getRequestCommitTotalTime(),
401 dataStoreStats.getRequestCommitAverageTime());
404 public RpcProviderRegistry getBindingRpcRegistry() {
405 return baBrokerImpl.getRoot();
408 public RpcProvisionRegistry getDomRpcRegistry() {
409 if (biBrokerImpl == null) {
412 return biBrokerImpl.getRouter();
415 public RpcImplementation getDomRpcInvoker() {
416 return biBrokerImpl.getRouter();
420 public void close() throws Exception {
424 public MountProviderService getBindingMountProviderService() {
425 return baBrokerImpl.getMountManager();
428 public MountProvisionService getDomMountProviderService() {