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
9 package org.opendaylight.openflowplugin.impl.device;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertTrue;
13 import static org.mockito.Matchers.any;
14 import static org.mockito.Matchers.eq;
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.CheckedFuture;
20 import com.google.common.util.concurrent.Futures;
21 import com.google.common.util.concurrent.ListenableFuture;
22 import io.netty.util.HashedWheelTimer;
23 import java.lang.reflect.Field;
24 import java.math.BigInteger;
25 import java.util.concurrent.ConcurrentHashMap;
26 import java.util.concurrent.ExecutionException;
27 import org.junit.Assert;
28 import org.junit.Before;
29 import org.junit.Test;
30 import org.junit.runner.RunWith;
31 import org.mockito.Mock;
32 import org.mockito.Mockito;
33 import org.mockito.runners.MockitoJUnitRunner;
34 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
35 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
36 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
37 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
38 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
39 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
40 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
41 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
42 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
43 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
45 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
46 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
47 import org.opendaylight.openflowplugin.impl.device.initialization.DeviceInitializerProviderFactory;
48 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
49 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRemovedBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdatedBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint16Type;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfigBuilder;
62 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
64 @RunWith(MockitoJUnitRunner.class)
65 public class DeviceManagerImplTest {
67 private static final long TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA = 2000L;
68 private static final int BARRIER_COUNT_LIMIT = 25600;
69 private static final long BARRIER_INTERVAL_NANOS = 500;
70 private static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
71 private static final KeyedInstanceIdentifier<Node, NodeKey> DUMMY_IDENTIFIER = DeviceStateUtil
72 .createNodeInstanceIdentifier(DUMMY_NODE_ID);
75 private CheckedFuture<Void, TransactionCommitFailedException> mockedFuture;
77 private FeaturesReply mockFeatures;
79 private ConnectionContext mockConnectionContext;
81 private ConnectionAdapter mockedConnectionAdapter;
83 private DeviceContextImpl mockedDeviceContext;
85 private MessageIntelligenceAgency messageIntelligenceAgency;
87 private DeviceInfo deviceInfo;
89 private ConvertorExecutor convertorExecutor;
91 private DataBroker dataBroker;
93 private WriteTransaction writeTransaction;
95 private BindingTransactionChain transactionChain;
97 private Capabilities capabilities;
99 private CapabilitiesV10 capabilitiesV10;
101 private NotificationPublishService notificationPublishService;
103 private TranslatorLibrary translatorLibrary;
105 private DeviceManagerImpl deviceManager;
108 public void setUp() throws Exception {
109 when(mockConnectionContext.getNodeId()).thenReturn(DUMMY_NODE_ID);
110 when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
111 when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
112 when(mockConnectionContext.getDeviceInfo()).thenReturn(deviceInfo);
113 when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockConnectionContext);
114 when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(DUMMY_IDENTIFIER);
115 when(deviceInfo.getNodeId()).thenReturn(DUMMY_NODE_ID);
117 when(mockFeatures.getCapabilities()).thenReturn(capabilities);
118 when(mockFeatures.getCapabilitiesV10()).thenReturn(capabilitiesV10);
119 when(mockFeatures.getDatapathId()).thenReturn(BigInteger.valueOf(21L));
121 when(mockedFuture.isDone()).thenReturn(true);
122 when(writeTransaction.submit()).thenReturn(mockedFuture);
123 when(transactionChain.newWriteOnlyTransaction()).thenReturn(writeTransaction);
124 when(dataBroker.createTransactionChain(any(TransactionChainListener.class))).thenReturn(transactionChain);
125 when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
127 deviceManager = new DeviceManagerImpl(
128 new OpenflowProviderConfigBuilder()
129 .setBarrierCountLimit(new NonZeroUint16Type(BARRIER_COUNT_LIMIT))
130 .setBarrierIntervalTimeoutLimit(new NonZeroUint32Type(BARRIER_INTERVAL_NANOS))
131 .setGlobalNotificationQuota(TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA)
132 .setSwitchFeaturesMandatory(false)
133 .setEnableFlowRemovedNotification(true)
134 .setSkipTableFeatures(false)
135 .setUseSingleLayerSerialization(true)
138 messageIntelligenceAgency,
139 notificationPublishService,
140 new HashedWheelTimer(),
142 DeviceInitializerProviderFactory.createDefaultProvider());
144 deviceManager.setTranslatorLibrary(translatorLibrary);
145 verify(dataBroker).newWriteOnlyTransaction();
146 verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
147 verify(writeTransaction).submit();
151 public void createContext() throws Exception {
152 final DeviceContext context = deviceManager.createContext(mockConnectionContext);
153 assertEquals(deviceInfo, context.getDeviceInfo());
158 public void removeDeviceFromOperationalDS() throws Exception {
159 final ListenableFuture<Void> future = deviceManager
160 .removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
163 assertTrue(future.isDone());
164 verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
167 @Test(expected = ExecutionException.class)
168 public void removeDeviceFromOperationalDSException() throws Exception {
169 final CheckedFuture<Void, TransactionCommitFailedException> failedFuture =
170 Futures.immediateFailedCheckedFuture(
171 new TransactionCommitFailedException("Test failed transaction", null, null));
172 Mockito.when(writeTransaction.submit()).thenReturn(failedFuture);
173 final ListenableFuture<Void> future = deviceManager
174 .removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
176 assertTrue(future.isDone());
177 verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
181 public void sendNodeAddedNotification() throws Exception {
182 deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
183 deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
184 verify(notificationPublishService).offerNotification(new NodeUpdatedBuilder()
185 .setId(DUMMY_NODE_ID)
186 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
191 public void sendNodeRemovedNotification() throws Exception {
192 deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
193 deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
194 deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
195 verify(notificationPublishService).offerNotification(new NodeRemovedBuilder()
196 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
201 public void close() throws Exception {
202 final DeviceContext deviceContext = mock(DeviceContext.class);
203 final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
204 deviceContexts.put(deviceInfo, deviceContext);
205 Assert.assertEquals(1, deviceContexts.size());
206 deviceManager.close();
207 verify(deviceContext).close();
210 @SuppressWarnings("unchecked")
211 private static ConcurrentHashMap<DeviceInfo, DeviceContext> getContextsCollection(
212 final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
213 // HACK: contexts collection for testing shall be accessed in some more civilized way
214 final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
215 Assert.assertNotNull(contextsField);
216 contextsField.setAccessible(true);
217 return (ConcurrentHashMap<DeviceInfo, DeviceContext>) contextsField.get(deviceManager);