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

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