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