openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/device/DeviceManagerImplTest.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.openflowplugin.impl.device;
  10
  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;
  17
  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.mdsal.singleton.common.api.ClusterSingletonService;
  44 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  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.lifecycle.LifecycleService;
  61 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  62 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
  63 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  64 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  65 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  66 import org.opendaylight.openflowplugin.openflow.md.util.OpenflowPortsUtil;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.features.reply.PhyPortBuilder;
  74
  75 @RunWith(MockitoJUnitRunner.class)
  76 public class DeviceManagerImplTest {
  77
  78     private static final long TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA = 2000l;
  79     private static final int barrierCountLimit = 25600;
  80     private static final int barrierIntervalNanos = 500;
  81     public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
  82
  83     @Mock
  84     CheckedFuture<Void, TransactionCommitFailedException> mockedFuture;
  85     @Mock
  86     private FeaturesReply mockFeatures;
  87     @Mock
  88     private OutboundQueue outboundQueueProvider;
  89     @Mock
  90     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
  91     @Mock
  92     private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
  93     @Mock
  94     private TranslatorLibrary translatorLibrary;
  95     @Mock
  96     private ConnectionContext mockConnectionContext;
  97     @Mock
  98     private ConnectionAdapter mockedConnectionAdapter;
  99     @Mock
 100     private DeviceContextImpl mockedDeviceContext;
 101     @Mock
 102     private NodeId mockedNodeId;
 103     @Mock
 104     private LifecycleConductor lifecycleConductor;
 105     @Mock
 106     private MessageIntelligenceAgency messageIntelligenceAgency;
 107     @Mock
 108     private DeviceInfo deviceInfo;
 109     @Mock
 110     private LifecycleService lifecycleService;
 111     @Mock
 112     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
 113     @Mock
 114     private ConvertorExecutor convertorExecutor;
 115
 116     @Before
 117     public void setUp() throws Exception {
 118         OpenflowPortsUtil.init();
 119
 120         when(mockConnectionContext.getNodeId()).thenReturn(DUMMY_NODE_ID);
 121         when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
 122         when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
 123         when(mockConnectionContext.getDeviceInfo()).thenReturn(deviceInfo);
 124         when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockConnectionContext);
 125         when(deviceInfo.getNodeId()).thenReturn(DUMMY_NODE_ID);
 126
 127         final Capabilities capabilitiesV13 = mock(Capabilities.class);
 128         final CapabilitiesV10 capabilitiesV10 = mock(CapabilitiesV10.class);
 129         when(mockFeatures.getCapabilities()).thenReturn(capabilitiesV13);
 130         when(mockFeatures.getCapabilitiesV10()).thenReturn(capabilitiesV10);
 131         when(mockFeatures.getDatapathId()).thenReturn(BigInteger.valueOf(21L));
 132
 133         when(lifecycleConductor.getMessageIntelligenceAgency()).thenReturn(messageIntelligenceAgency);
 134     }
 135
 136     @Test
 137     public void onDeviceContextLevelUpSuccessTest() throws Exception {
 138         onDeviceContextLevelUp(false);
 139     }
 140
 141     private DeviceManagerImpl prepareDeviceManager() {
 142         return prepareDeviceManager(false);
 143     }
 144
 145     private DeviceManagerImpl prepareDeviceManager(final boolean withException) {
 146         final DataBroker mockedDataBroker = mock(DataBroker.class);
 147         final WriteTransaction mockedWriteTransaction = mock(WriteTransaction.class);
 148
 149         final BindingTransactionChain mockedTxChain = mock(BindingTransactionChain.class);
 150         final WriteTransaction mockedWTx = mock(WriteTransaction.class);
 151         when(mockedTxChain.newWriteOnlyTransaction()).thenReturn(mockedWTx);
 152         when(mockedDataBroker.createTransactionChain(any(TransactionChainListener.class))).thenReturn
 153                 (mockedTxChain);
 154         when(mockedDataBroker.newWriteOnlyTransaction()).thenReturn(mockedWriteTransaction);
 155
 156         when(mockedWriteTransaction.submit()).thenReturn(mockedFuture);
 157
 158         final DeviceManagerImpl deviceManager = new DeviceManagerImpl(
 159                 mockedDataBroker,
 160                 TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA,
 161                 false,
 162                 barrierIntervalNanos,
 163                 barrierCountLimit,
 164                 lifecycleConductor,
 165                 true,
 166                 convertorExecutor,
 167                 clusterSingletonServiceProvider);
 168
 169         deviceManager.setDeviceInitializationPhaseHandler(deviceInitPhaseHandler);
 170         deviceManager.setDeviceTerminationPhaseHandler(deviceTerminationPhaseHandler);
 171
 172         return deviceManager;
 173     }
 174
 175     public void onDeviceContextLevelUp(final boolean withException) throws Exception {
 176         final DeviceManagerImpl deviceManager = prepareDeviceManager(withException);
 177         final DeviceState mockedDeviceState = mock(DeviceState.class);
 178         when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
 179
 180         if (withException) {
 181             doThrow(new IllegalStateException("dummy")).when(mockedDeviceContext).initialSubmitTransaction();
 182         }
 183         deviceManager.addDeviceContextToMap(deviceInfo, mockedDeviceContext);
 184         deviceManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 185         if (withException) {
 186             verify(mockedDeviceContext).close();
 187         } else {
 188             verify(mockedDeviceContext).onPublished();
 189         }
 190     }
 191
 192     @Test
 193     public void deviceConnectedTest() throws Exception{
 194         final DeviceManagerImpl deviceManager = prepareDeviceManager();
 195         injectMockTranslatorLibrary(deviceManager);
 196         final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
 197
 198         deviceManager.deviceConnected(mockConnectionContext);
 199
 200         final InOrder order = inOrder(mockConnectionContext);
 201         order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
 202         order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
 203                 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
 204         verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<DeviceInfo>any(), Mockito.<LifecycleService>any());
 205     }
 206
 207     @Test
 208     public void deviceConnectedV10Test() throws Exception{
 209         final DeviceManagerImpl deviceManager = prepareDeviceManager();
 210         injectMockTranslatorLibrary(deviceManager);
 211         final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_0);
 212
 213         final PhyPortBuilder phyPort = new PhyPortBuilder()
 214                 .setPortNo(41L);
 215         when(mockFeatures.getPhyPort()).thenReturn(Collections.singletonList(phyPort.build()));
 216         final MessageTranslator<Object, Object> mockedTranslator = mock(MessageTranslator.class);
 217         when(mockedTranslator.translate(Matchers.<Object>any(), Matchers.<DeviceInfo>any(), Matchers.any()))
 218                 .thenReturn(null);
 219         when(translatorLibrary.lookupTranslator(Matchers.<TranslatorKey>any())).thenReturn(mockedTranslator);
 220
 221         deviceManager.deviceConnected(mockConnectionContext);
 222
 223         final InOrder order = inOrder(mockConnectionContext);
 224         order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
 225         order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
 226                 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
 227         verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<DeviceInfo>any(), Mockito.<LifecycleService>any());
 228     }
 229
 230     @Test
 231     public void deviceDisconnectedTest() throws Exception {
 232         final DeviceState deviceState = mock(DeviceState.class);
 233
 234         final DeviceManagerImpl deviceManager = prepareDeviceManager();
 235         injectMockTranslatorLibrary(deviceManager);
 236
 237         final ConnectionContext connectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
 238         when(connectionContext.getNodeId()).thenReturn(mockedNodeId);
 239
 240         final DeviceContext deviceContext = mock(DeviceContext.class);
 241         when(deviceContext.shuttingDownDataStoreTransactions()).thenReturn(Futures.immediateCheckedFuture(null));
 242         when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
 243         when(deviceContext.getDeviceState()).thenReturn(deviceState);
 244
 245         final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
 246         deviceContexts.put(deviceInfo, deviceContext);
 247
 248         deviceManager.onDeviceDisconnected(connectionContext);
 249
 250         verify(lifecycleConductor).newTimeout(Mockito.<TimerTask>any(), Mockito.anyLong(), Mockito.<TimeUnit>any());
 251     }
 252
 253     protected ConnectionContext buildMockConnectionContext(final short ofpVersion) {
 254         when(mockFeatures.getVersion()).thenReturn(ofpVersion);
 255         when(outboundQueueProvider.reserveEntry()).thenReturn(43L);
 256         Mockito.doAnswer(new Answer<Void>() {
 257             @Override
 258             public Void answer(final InvocationOnMock invocation) throws Throwable {
 259                 final FutureCallback<OfHeader> callBack = (FutureCallback<OfHeader>) invocation.getArguments()[2];
 260                 callBack.onSuccess(null);
 261                 return null;
 262             }
 263         })
 264                 .when(outboundQueueProvider)
 265                 .commitEntry(Matchers.anyLong(), Matchers.<MultipartRequestInput>any(), Matchers.<FutureCallback<OfHeader>>any());
 266
 267         when(mockedConnectionAdapter.registerOutboundQueueHandler(Matchers.<OutboundQueueHandler>any(), Matchers.anyInt(), Matchers.anyLong()))
 268                 .thenAnswer(new Answer<OutboundQueueHandlerRegistration<OutboundQueueHandler>>() {
 269                     @Override
 270                     public OutboundQueueHandlerRegistration<OutboundQueueHandler> answer(final InvocationOnMock invocation) throws Throwable {
 271                         final OutboundQueueHandler handler = (OutboundQueueHandler) invocation.getArguments()[0];
 272                         handler.onConnectionQueueChanged(outboundQueueProvider);
 273                         return null;
 274                     }
 275                 });
 276
 277         when(mockConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueueProvider);
 278         return mockConnectionContext;
 279     }
 280
 281     private void injectMockTranslatorLibrary(final DeviceManagerImpl deviceManager) {
 282         deviceManager.setTranslatorLibrary(translatorLibrary);
 283     }
 284
 285     @Test
 286     public void testClose() throws Exception {
 287         final DeviceContext deviceContext = mock(DeviceContext.class);
 288         final DeviceManagerImpl deviceManager = prepareDeviceManager();
 289         final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
 290         deviceContexts.put(deviceInfo, deviceContext);
 291         Assert.assertEquals(1, deviceContexts.size());
 292
 293         deviceManager.close();
 294
 295         verify(deviceContext).shutdownConnection();
 296         verify(deviceContext, Mockito.never()).close();
 297     }
 298
 299     private static ConcurrentHashMap<DeviceInfo, DeviceContext> getContextsCollection(final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
 300         // HACK: contexts collection for testing shall be accessed in some more civilized way
 301         final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
 302         Assert.assertNotNull(contextsField);
 303         contextsField.setAccessible(true);
 304         return (ConcurrentHashMap<DeviceInfo, DeviceContext>) contextsField.get(deviceManager);
 305     }
 306
 307 }