3 * * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
5 * * This program and the accompanying materials are made available under the
6 * * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * * and is available at http://www.eclipse.org/legal/epl-v10.html
12 package org.opendaylight.openflowplugin.impl.device;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Mockito.doThrow;
16 import static org.mockito.Mockito.inOrder;
17 import static org.mockito.Mockito.mock;
18 import static org.mockito.Mockito.verify;
19 import static org.mockito.Mockito.when;
20 import com.google.common.util.concurrent.CheckedFuture;
21 import com.google.common.util.concurrent.FutureCallback;
22 import com.google.common.util.concurrent.Futures;
23 import io.netty.util.TimerTask;
24 import java.lang.reflect.Field;
25 import java.math.BigInteger;
26 import java.util.Collections;
27 import java.util.concurrent.ConcurrentHashMap;
28 import java.util.concurrent.TimeUnit;
29 import org.junit.Assert;
30 import org.junit.Before;
31 import org.junit.Test;
32 import org.junit.runner.RunWith;
33 import org.mockito.InOrder;
34 import org.mockito.Matchers;
35 import org.mockito.Mock;
36 import org.mockito.Mockito;
37 import org.mockito.invocation.InvocationOnMock;
38 import org.mockito.runners.MockitoJUnitRunner;
39 import org.mockito.stubbing.Answer;
40 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
41 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
42 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
43 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
44 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
45 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
46 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
47 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandler;
48 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
49 import org.opendaylight.openflowplugin.api.OFConstants;
50 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
51 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
52 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
53 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
54 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
55 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
56 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
57 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
58 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
59 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
60 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
61 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
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(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockConnectionContext);
114 when(mockConnectionContext.getDeviceInfo()).thenReturn(deviceInfo);
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);
126 @Test(expected = IllegalStateException.class)
127 public void onDeviceContextLevelUpFailTest() throws Exception {
128 onDeviceContextLevelUp(true);
132 public void onDeviceContextLevelUpSuccessTest() throws Exception {
133 onDeviceContextLevelUp(false);
136 private DeviceManagerImpl prepareDeviceManager() {
137 return prepareDeviceManager(false);
140 private DeviceManagerImpl prepareDeviceManager(final boolean withException) {
141 final DataBroker mockedDataBroker = mock(DataBroker.class);
142 final WriteTransaction mockedWriteTransaction = mock(WriteTransaction.class);
144 final BindingTransactionChain mockedTxChain = mock(BindingTransactionChain.class);
145 final WriteTransaction mockedWTx = mock(WriteTransaction.class);
146 when(mockedTxChain.newWriteOnlyTransaction()).thenReturn(mockedWTx);
147 when(mockedDataBroker.createTransactionChain(any(TransactionChainListener.class))).thenReturn
149 when(mockedDataBroker.newWriteOnlyTransaction()).thenReturn(mockedWriteTransaction);
151 when(mockedWriteTransaction.submit()).thenReturn(mockedFuture);
153 final DeviceManagerImpl deviceManager = new DeviceManagerImpl(mockedDataBroker,
154 TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA, false, barrierIntervalNanos, barrierCountLimit, lifecycleConductor);
156 deviceManager.setDeviceInitializationPhaseHandler(deviceInitPhaseHandler);
157 deviceManager.setDeviceTerminationPhaseHandler(deviceTerminationPhaseHandler);
159 return deviceManager;
162 public void onDeviceContextLevelUp(final boolean withException) throws Exception {
163 final DeviceManagerImpl deviceManager = prepareDeviceManager(withException);
164 final DeviceState mockedDeviceState = mock(DeviceState.class);
165 when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
168 doThrow(new IllegalStateException("dummy")).when(mockedDeviceContext).initialSubmitTransaction();
170 deviceManager.addDeviceContextToMap(deviceInfo, mockedDeviceContext);
171 deviceManager.onDeviceContextLevelUp(deviceInfo);
173 verify(mockedDeviceContext).close();
175 verify(mockedDeviceContext).initialSubmitTransaction();
176 verify(mockedDeviceContext).onPublished();
181 public void deviceConnectedTest() throws Exception{
182 final DeviceManagerImpl deviceManager = prepareDeviceManager();
183 injectMockTranslatorLibrary(deviceManager);
184 final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
186 deviceManager.deviceConnected(mockConnectionContext);
188 final InOrder order = inOrder(mockConnectionContext);
189 order.verify(mockConnectionContext).getFeatures();
190 order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
191 order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
192 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
193 verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<DeviceInfo>any());
197 public void deviceConnectedV10Test() throws Exception{
198 final DeviceManagerImpl deviceManager = prepareDeviceManager();
199 injectMockTranslatorLibrary(deviceManager);
200 final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_0);
202 final PhyPortBuilder phyPort = new PhyPortBuilder()
204 when(mockFeatures.getPhyPort()).thenReturn(Collections.singletonList(phyPort.build()));
205 final MessageTranslator<Object, Object> mockedTranslator = mock(MessageTranslator.class);
206 when(mockedTranslator.translate(Matchers.<Object>any(), Matchers.<DeviceInfo>any(), Matchers.any()))
208 when(translatorLibrary.lookupTranslator(Matchers.<TranslatorKey>any())).thenReturn(mockedTranslator);
210 deviceManager.deviceConnected(mockConnectionContext);
212 final InOrder order = inOrder(mockConnectionContext);
213 order.verify(mockConnectionContext).getFeatures();
214 order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
215 order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
216 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
217 verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<DeviceInfo>any());
221 public void deviceDisconnectedTest() throws Exception {
222 final DeviceState deviceState = mock(DeviceState.class);
224 final DeviceManagerImpl deviceManager = prepareDeviceManager();
225 injectMockTranslatorLibrary(deviceManager);
227 final ConnectionContext connectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
228 when(connectionContext.getNodeId()).thenReturn(mockedNodeId);
230 final DeviceContext deviceContext = mock(DeviceContext.class);
231 when(deviceContext.shuttingDownDataStoreTransactions()).thenReturn(Futures.immediateCheckedFuture(null));
232 when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
233 when(deviceContext.getDeviceState()).thenReturn(deviceState);
235 final ConcurrentHashMap<NodeId, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
236 deviceContexts.put(DUMMY_NODE_ID, deviceContext);
238 deviceManager.onDeviceDisconnected(connectionContext);
240 verify(lifecycleConductor).newTimeout(Mockito.<TimerTask>any(), Mockito.anyLong(), Mockito.<TimeUnit>any());
243 protected ConnectionContext buildMockConnectionContext(final short ofpVersion) {
244 when(mockFeatures.getVersion()).thenReturn(ofpVersion);
245 when(outboundQueueProvider.reserveEntry()).thenReturn(43L);
246 Mockito.doAnswer(new Answer<Void>() {
248 public Void answer(final InvocationOnMock invocation) throws Throwable {
249 final FutureCallback<OfHeader> callBack = (FutureCallback<OfHeader>) invocation.getArguments()[2];
250 callBack.onSuccess(null);
254 .when(outboundQueueProvider)
255 .commitEntry(Matchers.anyLong(), Matchers.<MultipartRequestInput>any(), Matchers.<FutureCallback<OfHeader>>any());
257 when(mockedConnectionAdapter.registerOutboundQueueHandler(Matchers.<OutboundQueueHandler>any(), Matchers.anyInt(), Matchers.anyLong()))
258 .thenAnswer(new Answer<OutboundQueueHandlerRegistration<OutboundQueueHandler>>() {
260 public OutboundQueueHandlerRegistration<OutboundQueueHandler> answer(final InvocationOnMock invocation) throws Throwable {
261 final OutboundQueueHandler handler = (OutboundQueueHandler) invocation.getArguments()[0];
262 handler.onConnectionQueueChanged(outboundQueueProvider);
267 when(mockConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueueProvider);
268 return mockConnectionContext;
271 private void injectMockTranslatorLibrary(final DeviceManagerImpl deviceManager) {
272 deviceManager.setTranslatorLibrary(translatorLibrary);
276 public void testClose() throws Exception {
277 final DeviceContext deviceContext = mock(DeviceContext.class);
278 final DeviceManagerImpl deviceManager = prepareDeviceManager();
279 final ConcurrentHashMap<NodeId, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
280 deviceContexts.put(mockedNodeId, deviceContext);
281 Assert.assertEquals(1, deviceContexts.size());
283 deviceManager.close();
285 verify(deviceContext).shutdownConnection();
286 verify(deviceContext, Mockito.never()).close();
289 private static ConcurrentHashMap<NodeId, DeviceContext> getContextsCollection(final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
290 // HACK: contexts collection for testing shall be accessed in some more civilized way
291 final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
292 Assert.assertNotNull(contextsField);
293 contextsField.setAccessible(true);
294 return (ConcurrentHashMap<NodeId, DeviceContext>) contextsField.get(deviceManager);