2 * Copyright (c) 2015 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.openflowplugin.impl.device;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertTrue;
12 import static org.mockito.ArgumentMatchers.any;
13 import static org.mockito.ArgumentMatchers.eq;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.mock;
16 import static org.mockito.Mockito.verify;
17 import static org.mockito.Mockito.when;
19 import com.google.common.util.concurrent.FluentFuture;
20 import com.google.common.util.concurrent.ListenableFuture;
21 import io.netty.util.HashedWheelTimer;
22 import java.lang.reflect.Field;
23 import java.util.concurrent.ConcurrentHashMap;
24 import java.util.concurrent.ExecutionException;
25 import java.util.concurrent.ExecutorService;
26 import org.junit.Assert;
27 import org.junit.Before;
28 import org.junit.Test;
29 import org.junit.runner.RunWith;
30 import org.mockito.Mock;
31 import org.mockito.Mockito;
32 import org.mockito.junit.MockitoJUnitRunner;
33 import org.opendaylight.mdsal.binding.api.DataBroker;
34 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
35 import org.opendaylight.mdsal.binding.api.TransactionChain;
36 import org.opendaylight.mdsal.binding.api.WriteTransaction;
37 import org.opendaylight.mdsal.common.api.CommitInfo;
38 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
39 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
40 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
42 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
43 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
44 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
45 import org.opendaylight.openflowplugin.impl.device.initialization.DeviceInitializerProviderFactory;
46 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
47 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRemovedBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdatedBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint16Type;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfigBuilder;
60 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
61 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
62 import org.opendaylight.yangtools.yang.common.Uint16;
63 import org.opendaylight.yangtools.yang.common.Uint32;
65 @RunWith(MockitoJUnitRunner.class)
66 public class DeviceManagerImplTest {
68 private static final Uint32 TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA = Uint32.valueOf(2000);
69 private static final Uint16 BARRIER_COUNT_LIMIT = Uint16.valueOf(25600);
70 private static final Uint32 BARRIER_INTERVAL_NANOS = Uint32.valueOf(500);
71 private static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
72 private static final KeyedInstanceIdentifier<Node, NodeKey> DUMMY_IDENTIFIER = DeviceStateUtil
73 .createNodeInstanceIdentifier(DUMMY_NODE_ID);
76 private FluentFuture<CommitInfo> mockedFuture;
78 private FeaturesReply mockFeatures;
80 private ConnectionContext mockConnectionContext;
82 private ConnectionAdapter mockedConnectionAdapter;
84 private DeviceContextImpl mockedDeviceContext;
86 private MessageIntelligenceAgency messageIntelligenceAgency;
88 private DeviceInfo deviceInfo;
90 private ConvertorExecutor convertorExecutor;
92 private DataBroker dataBroker;
94 private WriteTransaction writeTransaction;
96 private TransactionChain transactionChain;
98 private Capabilities capabilities;
100 private CapabilitiesV10 capabilitiesV10;
102 private NotificationPublishService notificationPublishService;
104 private TranslatorLibrary translatorLibrary;
106 private ExecutorService executorService;
108 private DeviceManagerImpl deviceManager;
111 public void setUp() {
112 when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
113 when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
114 when(mockConnectionContext.getDeviceInfo()).thenReturn(deviceInfo);
115 when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(DUMMY_IDENTIFIER);
116 when(deviceInfo.getNodeId()).thenReturn(DUMMY_NODE_ID);
118 when(mockedFuture.isDone()).thenReturn(true);
119 doReturn(mockedFuture).when(writeTransaction).commit();
120 when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
122 deviceManager = new DeviceManagerImpl(
123 new OpenflowProviderConfigBuilder()
124 .setBarrierCountLimit(new NonZeroUint16Type(BARRIER_COUNT_LIMIT))
125 .setBarrierIntervalTimeoutLimit(new NonZeroUint32Type(BARRIER_INTERVAL_NANOS))
126 .setGlobalNotificationQuota(TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA)
127 .setSwitchFeaturesMandatory(false)
128 .setEnableFlowRemovedNotification(true)
129 .setSkipTableFeatures(false)
130 .setUseSingleLayerSerialization(true)
131 .setIsStatisticsPollingOn(false)
134 messageIntelligenceAgency,
135 notificationPublishService,
136 new HashedWheelTimer(),
138 DeviceInitializerProviderFactory.createDefaultProvider(),
141 deviceManager.setTranslatorLibrary(translatorLibrary);
142 verify(dataBroker).newWriteOnlyTransaction();
143 verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
144 verify(writeTransaction).commit();
148 public void createContext() {
149 final DeviceContext context = deviceManager.createContext(mockConnectionContext);
150 assertEquals(deviceInfo, context.getDeviceInfo());
155 public void removeDeviceFromOperationalDS() throws Exception {
156 final ListenableFuture<?> future = deviceManager
157 .removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
160 assertTrue(future.isDone());
161 verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
164 @Test(expected = ExecutionException.class)
165 public void removeDeviceFromOperationalDSException() throws Exception {
166 final FluentFuture<?> failedFuture = FluentFutures.immediateFailedFluentFuture(
167 new ExecutionException(new Throwable("Test failed transaction")));
168 Mockito.doReturn(failedFuture).when(writeTransaction).commit();
169 final ListenableFuture<?> future = deviceManager.removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
171 assertTrue(future.isDone());
172 verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
176 public void sendNodeAddedNotification() {
177 deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
178 deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
179 verify(notificationPublishService).offerNotification(new NodeUpdatedBuilder()
180 .setId(DUMMY_NODE_ID)
181 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
186 public void sendNodeRemovedNotification() {
187 deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
188 deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
189 deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
190 verify(notificationPublishService).offerNotification(new NodeRemovedBuilder()
191 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
196 public void close() throws Exception {
197 final DeviceContext deviceContext = mock(DeviceContext.class);
198 final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
199 deviceContexts.put(deviceInfo, deviceContext);
200 Assert.assertEquals(1, deviceContexts.size());
201 deviceManager.close();
202 verify(deviceContext).close();
205 @SuppressWarnings("unchecked")
206 private static ConcurrentHashMap<DeviceInfo, DeviceContext> getContextsCollection(
207 final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
208 // HACK: contexts collection for testing shall be accessed in some more civilized way
209 final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
210 Assert.assertNotNull(contextsField);
211 contextsField.setAccessible(true);
212 return (ConcurrentHashMap<DeviceInfo, DeviceContext>) contextsField.get(deviceManager);