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.mockito.Matchers.any;
12 import static org.mockito.Mockito.doThrow;
13 import static org.mockito.Mockito.inOrder;
14 import static org.mockito.Mockito.mock;
15 import static org.mockito.Mockito.verify;
16 import static org.mockito.Mockito.when;
18 import com.google.common.util.concurrent.CheckedFuture;
19 import com.google.common.util.concurrent.FutureCallback;
20 import com.google.common.util.concurrent.Futures;
21 import io.netty.util.TimerTask;
22 import java.lang.reflect.Field;
23 import java.math.BigInteger;
24 import java.util.Collections;
25 import java.util.concurrent.ConcurrentHashMap;
26 import java.util.concurrent.TimeUnit;
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.InOrder;
32 import org.mockito.Matchers;
33 import org.mockito.Mock;
34 import org.mockito.Mockito;
35 import org.mockito.invocation.InvocationOnMock;
36 import org.mockito.runners.MockitoJUnitRunner;
37 import org.mockito.stubbing.Answer;
38 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
39 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
40 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
41 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
42 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
43 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
44 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
45 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandler;
46 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
47 import org.opendaylight.openflowplugin.api.OFConstants;
48 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
49 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
50 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
51 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
52 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
53 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
54 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
55 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
56 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
57 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
58 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
59 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
60 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
61 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
62 import org.opendaylight.openflowplugin.openflow.md.util.OpenflowPortsUtil;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.features.reply.PhyPortBuilder;
71 @RunWith(MockitoJUnitRunner.class)
72 public class DeviceManagerImplTest {
74 private static final long TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA = 2000l;
75 private static final int barrierCountLimit = 25600;
76 private static final int barrierIntervalNanos = 500;
77 public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
80 CheckedFuture<Void, TransactionCommitFailedException> mockedFuture;
82 private FeaturesReply mockFeatures;
84 private OutboundQueue outboundQueueProvider;
86 private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
88 private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
90 private TranslatorLibrary translatorLibrary;
92 private ConnectionContext mockConnectionContext;
94 private ConnectionAdapter mockedConnectionAdapter;
96 private DeviceContextImpl mockedDeviceContext;
98 private NodeId mockedNodeId;
100 private LifecycleConductor lifecycleConductor;
102 private MessageIntelligenceAgency messageIntelligenceAgency;
104 private DeviceInfo deviceInfo;
107 public void setUp() throws Exception {
108 OpenflowPortsUtil.init();
110 when(mockConnectionContext.getNodeId()).thenReturn(DUMMY_NODE_ID);
111 when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
112 when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
113 when(mockConnectionContext.getDeviceInfo()).thenReturn(deviceInfo);
114 when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockConnectionContext);
115 when(deviceInfo.getNodeId()).thenReturn(DUMMY_NODE_ID);
117 final Capabilities capabilitiesV13 = mock(Capabilities.class);
118 final CapabilitiesV10 capabilitiesV10 = mock(CapabilitiesV10.class);
119 when(mockFeatures.getCapabilities()).thenReturn(capabilitiesV13);
120 when(mockFeatures.getCapabilitiesV10()).thenReturn(capabilitiesV10);
121 when(mockFeatures.getDatapathId()).thenReturn(BigInteger.valueOf(21L));
123 when(lifecycleConductor.getMessageIntelligenceAgency()).thenReturn(messageIntelligenceAgency);
127 public void onDeviceContextLevelUpSuccessTest() throws Exception {
128 onDeviceContextLevelUp(false);
131 private DeviceManagerImpl prepareDeviceManager() {
132 return prepareDeviceManager(false);
135 private DeviceManagerImpl prepareDeviceManager(final boolean withException) {
136 final DataBroker mockedDataBroker = mock(DataBroker.class);
137 final WriteTransaction mockedWriteTransaction = mock(WriteTransaction.class);
139 final BindingTransactionChain mockedTxChain = mock(BindingTransactionChain.class);
140 final WriteTransaction mockedWTx = mock(WriteTransaction.class);
141 when(mockedTxChain.newWriteOnlyTransaction()).thenReturn(mockedWTx);
142 when(mockedDataBroker.createTransactionChain(any(TransactionChainListener.class))).thenReturn
144 when(mockedDataBroker.newWriteOnlyTransaction()).thenReturn(mockedWriteTransaction);
146 when(mockedWriteTransaction.submit()).thenReturn(mockedFuture);
148 final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
149 final DeviceManagerImpl deviceManager = new DeviceManagerImpl(mockedDataBroker,
150 TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA, false, barrierIntervalNanos, barrierCountLimit, lifecycleConductor, true, convertorManager);
152 deviceManager.setDeviceInitializationPhaseHandler(deviceInitPhaseHandler);
153 deviceManager.setDeviceTerminationPhaseHandler(deviceTerminationPhaseHandler);
155 return deviceManager;
158 public void onDeviceContextLevelUp(final boolean withException) throws Exception {
159 final DeviceManagerImpl deviceManager = prepareDeviceManager(withException);
160 final DeviceState mockedDeviceState = mock(DeviceState.class);
161 when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
164 doThrow(new IllegalStateException("dummy")).when(mockedDeviceContext).initialSubmitTransaction();
166 deviceManager.addDeviceContextToMap(deviceInfo, mockedDeviceContext);
167 deviceManager.onDeviceContextLevelUp(deviceInfo);
169 verify(mockedDeviceContext).close();
171 verify(mockedDeviceContext).onPublished();
176 public void deviceConnectedTest() throws Exception{
177 final DeviceManagerImpl deviceManager = prepareDeviceManager();
178 injectMockTranslatorLibrary(deviceManager);
179 final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
181 deviceManager.deviceConnected(mockConnectionContext);
183 final InOrder order = inOrder(mockConnectionContext);
184 order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
185 order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
186 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
187 verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<DeviceInfo>any());
191 public void deviceConnectedV10Test() throws Exception{
192 final DeviceManagerImpl deviceManager = prepareDeviceManager();
193 injectMockTranslatorLibrary(deviceManager);
194 final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_0);
196 final PhyPortBuilder phyPort = new PhyPortBuilder()
198 when(mockFeatures.getPhyPort()).thenReturn(Collections.singletonList(phyPort.build()));
199 final MessageTranslator<Object, Object> mockedTranslator = mock(MessageTranslator.class);
200 when(mockedTranslator.translate(Matchers.<Object>any(), Matchers.<DeviceInfo>any(), Matchers.any()))
202 when(translatorLibrary.lookupTranslator(Matchers.<TranslatorKey>any())).thenReturn(mockedTranslator);
204 deviceManager.deviceConnected(mockConnectionContext);
206 final InOrder order = inOrder(mockConnectionContext);
207 order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
208 order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
209 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
210 verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<DeviceInfo>any());
214 public void deviceDisconnectedTest() throws Exception {
215 final DeviceState deviceState = mock(DeviceState.class);
217 final DeviceManagerImpl deviceManager = prepareDeviceManager();
218 injectMockTranslatorLibrary(deviceManager);
220 final ConnectionContext connectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
221 when(connectionContext.getNodeId()).thenReturn(mockedNodeId);
223 final DeviceContext deviceContext = mock(DeviceContext.class);
224 when(deviceContext.shuttingDownDataStoreTransactions()).thenReturn(Futures.immediateCheckedFuture(null));
225 when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
226 when(deviceContext.getDeviceState()).thenReturn(deviceState);
228 final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
229 deviceContexts.put(deviceInfo, deviceContext);
231 deviceManager.onDeviceDisconnected(connectionContext);
233 verify(lifecycleConductor).newTimeout(Mockito.<TimerTask>any(), Mockito.anyLong(), Mockito.<TimeUnit>any());
236 protected ConnectionContext buildMockConnectionContext(final short ofpVersion) {
237 when(mockFeatures.getVersion()).thenReturn(ofpVersion);
238 when(outboundQueueProvider.reserveEntry()).thenReturn(43L);
239 Mockito.doAnswer(new Answer<Void>() {
241 public Void answer(final InvocationOnMock invocation) throws Throwable {
242 final FutureCallback<OfHeader> callBack = (FutureCallback<OfHeader>) invocation.getArguments()[2];
243 callBack.onSuccess(null);
247 .when(outboundQueueProvider)
248 .commitEntry(Matchers.anyLong(), Matchers.<MultipartRequestInput>any(), Matchers.<FutureCallback<OfHeader>>any());
250 when(mockedConnectionAdapter.registerOutboundQueueHandler(Matchers.<OutboundQueueHandler>any(), Matchers.anyInt(), Matchers.anyLong()))
251 .thenAnswer(new Answer<OutboundQueueHandlerRegistration<OutboundQueueHandler>>() {
253 public OutboundQueueHandlerRegistration<OutboundQueueHandler> answer(final InvocationOnMock invocation) throws Throwable {
254 final OutboundQueueHandler handler = (OutboundQueueHandler) invocation.getArguments()[0];
255 handler.onConnectionQueueChanged(outboundQueueProvider);
260 when(mockConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueueProvider);
261 return mockConnectionContext;
264 private void injectMockTranslatorLibrary(final DeviceManagerImpl deviceManager) {
265 deviceManager.setTranslatorLibrary(translatorLibrary);
269 public void testClose() throws Exception {
270 final DeviceContext deviceContext = mock(DeviceContext.class);
271 final DeviceManagerImpl deviceManager = prepareDeviceManager();
272 final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
273 deviceContexts.put(deviceInfo, deviceContext);
274 Assert.assertEquals(1, deviceContexts.size());
276 deviceManager.close();
278 verify(deviceContext).shutdownConnection();
279 verify(deviceContext, Mockito.never()).close();
282 private static ConcurrentHashMap<DeviceInfo, DeviceContext> getContextsCollection(final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
283 // HACK: contexts collection for testing shall be accessed in some more civilized way
284 final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
285 Assert.assertNotNull(contextsField);
286 contextsField.setAccessible(true);
287 return (ConcurrentHashMap<DeviceInfo, DeviceContext>) contextsField.get(deviceManager);