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
  21 import com.google.common.util.concurrent.CheckedFuture;
  22 import com.google.common.util.concurrent.FutureCallback;
  23 import java.lang.reflect.Field;
  24 import java.math.BigInteger;
  25 import java.util.Collections;
  26 import java.util.concurrent.ConcurrentHashMap;
  27 import java.util.concurrent.TimeUnit;
  28
  29 import com.google.common.util.concurrent.Futures;
  30 import io.netty.util.TimerTask;
  31 import org.junit.Assert;
  32 import org.junit.Before;
  33 import org.junit.Test;
  34 import org.junit.runner.RunWith;
  35 import org.mockito.InOrder;
  36 import org.mockito.Matchers;
  37 import org.mockito.Mock;
  38 import org.mockito.Mockito;
  39 import org.mockito.invocation.InvocationOnMock;
  40 import org.mockito.runners.MockitoJUnitRunner;
  41 import org.mockito.stubbing.Answer;
  42 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  43 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  44 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  45 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  46 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  47 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  48 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  49 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandler;
  50 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
  51 import org.opendaylight.openflowplugin.api.OFConstants;
  52 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  53 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  54 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  55 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  56 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  57 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  58 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  59 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  60 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
  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.util.OpenflowPortsUtil;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  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.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
  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
  80     @Mock
  81     CheckedFuture<Void, TransactionCommitFailedException> mockedFuture;
  82     @Mock
  83     private FeaturesReply mockFeatures;
  84     @Mock
  85     private OutboundQueue outboundQueueProvider;
  86     @Mock
  87     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
  88     @Mock
  89     private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
  90     @Mock
  91     private TranslatorLibrary translatorLibrary;
  92     @Mock
  93     private ConnectionContext mockConnectionContext;
  94     @Mock
  95     private ConnectionAdapter mockedConnectionAdapter;
  96     @Mock
  97     private DeviceContextImpl mockedDeviceContext;
  98     @Mock
  99     private NodeId mockedNodeId;
 100     @Mock
 101     private LifecycleConductor lifecycleConductor;
 102     @Mock
 103     private MessageIntelligenceAgency messageIntelligenceAgency;
 104
 105     @Before
 106     public void setUp() throws Exception {
 107         OpenflowPortsUtil.init();
 108
 109         when(mockConnectionContext.getNodeId()).thenReturn(new NodeId("dummyNodeId"));
 110         when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
 111         when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
 112         when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockConnectionContext);
 113
 114         final Capabilities capabilitiesV13 = mock(Capabilities.class);
 115         final CapabilitiesV10 capabilitiesV10 = mock(CapabilitiesV10.class);
 116         when(mockFeatures.getCapabilities()).thenReturn(capabilitiesV13);
 117         when(mockFeatures.getCapabilitiesV10()).thenReturn(capabilitiesV10);
 118         when(mockFeatures.getDatapathId()).thenReturn(BigInteger.valueOf(21L));
 119
 120         when(lifecycleConductor.getMessageIntelligenceAgency()).thenReturn(messageIntelligenceAgency);
 121     }
 122
 123     @Test(expected = IllegalStateException.class)
 124     public void onDeviceContextLevelUpFailTest() throws Exception {
 125         onDeviceContextLevelUp(true);
 126     }
 127
 128     @Test
 129     public void onDeviceContextLevelUpSuccessTest() throws Exception {
 130         onDeviceContextLevelUp(false);
 131     }
 132
 133     private DeviceManagerImpl prepareDeviceManager() {
 134         return prepareDeviceManager(false);
 135     }
 136
 137     private DeviceManagerImpl prepareDeviceManager(final boolean withException) {
 138         final DataBroker mockedDataBroker = mock(DataBroker.class);
 139         final WriteTransaction mockedWriteTransaction = mock(WriteTransaction.class);
 140
 141         final BindingTransactionChain mockedTxChain = mock(BindingTransactionChain.class);
 142         final WriteTransaction mockedWTx = mock(WriteTransaction.class);
 143         when(mockedTxChain.newWriteOnlyTransaction()).thenReturn(mockedWTx);
 144         when(mockedDataBroker.createTransactionChain(any(TransactionChainListener.class))).thenReturn
 145                 (mockedTxChain);
 146         when(mockedDataBroker.newWriteOnlyTransaction()).thenReturn(mockedWriteTransaction);
 147
 148         when(mockedWriteTransaction.submit()).thenReturn(mockedFuture);
 149
 150         final DeviceManagerImpl deviceManager = new DeviceManagerImpl(mockedDataBroker,
 151                 TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA, false, barrierIntervalNanos, barrierCountLimit, lifecycleConductor);
 152
 153         deviceManager.setDeviceInitializationPhaseHandler(deviceInitPhaseHandler);
 154         deviceManager.setDeviceTerminationPhaseHandler(deviceTerminationPhaseHandler);
 155
 156         return deviceManager;
 157     }
 158
 159     public void onDeviceContextLevelUp(final boolean withException) throws Exception {
 160         final DeviceManagerImpl deviceManager = prepareDeviceManager(withException);
 161         final DeviceState mockedDeviceState = mock(DeviceState.class);
 162         when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
 163         when(mockedDeviceState.getNodeId()).thenReturn(mockedNodeId);
 164
 165         if (withException) {
 166             doThrow(new IllegalStateException("dummy")).when(mockedDeviceContext).initialSubmitTransaction();
 167         }
 168         deviceManager.addDeviceContextToMap(mockedNodeId, mockedDeviceContext);
 169         deviceManager.onDeviceContextLevelUp(mockedDeviceContext.getDeviceState().getNodeId());
 170         if (withException) {
 171             verify(mockedDeviceContext).close();
 172         } else {
 173             verify(mockedDeviceContext).initialSubmitTransaction();
 174             verify(mockedDeviceContext).onPublished();
 175         }
 176     }
 177
 178     @Test
 179     public void deviceConnectedTest() throws Exception{
 180         final DeviceManagerImpl deviceManager = prepareDeviceManager();
 181         injectMockTranslatorLibrary(deviceManager);
 182         final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
 183
 184         deviceManager.deviceConnected(mockConnectionContext);
 185
 186         final InOrder order = inOrder(mockConnectionContext);
 187         order.verify(mockConnectionContext).getFeatures();
 188         order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
 189         order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
 190                 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
 191         order.verify(mockConnectionContext).getNodeId();
 192         verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<NodeId>any());
 193     }
 194
 195     @Test
 196     public void deviceConnectedV10Test() throws Exception{
 197         final DeviceManagerImpl deviceManager = prepareDeviceManager();
 198         injectMockTranslatorLibrary(deviceManager);
 199         final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_0);
 200
 201         final PhyPortBuilder phyPort = new PhyPortBuilder()
 202                 .setPortNo(41L);
 203         when(mockFeatures.getPhyPort()).thenReturn(Collections.singletonList(phyPort.build()));
 204         final MessageTranslator<Object, Object> mockedTranslator = mock(MessageTranslator.class);
 205         when(mockedTranslator.translate(Matchers.<Object>any(), Matchers.<DeviceState>any(), Matchers.any()))
 206                 .thenReturn(null);
 207         when(translatorLibrary.lookupTranslator(Matchers.<TranslatorKey>any())).thenReturn(mockedTranslator);
 208
 209         deviceManager.deviceConnected(mockConnectionContext);
 210
 211         final InOrder order = inOrder(mockConnectionContext);
 212         order.verify(mockConnectionContext).getFeatures();
 213         order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
 214         order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
 215                 Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
 216         order.verify(mockConnectionContext).getNodeId();
 217         verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<NodeId>any());
 218     }
 219
 220     @Test
 221     public void deviceDisconnectedTest() throws Exception {
 222         final DeviceState deviceState = mock(DeviceState.class);
 223
 224         final DeviceManagerImpl deviceManager = prepareDeviceManager();
 225         injectMockTranslatorLibrary(deviceManager);
 226
 227         final ConnectionContext connectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
 228         when(connectionContext.getNodeId()).thenReturn(mockedNodeId);
 229
 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);
 234
 235         final ConcurrentHashMap<NodeId, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
 236         deviceContexts.put(mockedNodeId, deviceContext);
 237
 238         deviceManager.onDeviceDisconnected(connectionContext);
 239
 240         verify(lifecycleConductor).newTimeout(Mockito.<TimerTask>any(), Mockito.anyLong(), Mockito.<TimeUnit>any());
 241     }
 242
 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>() {
 247             @Override
 248             public Void answer(final InvocationOnMock invocation) throws Throwable {
 249                 final FutureCallback<OfHeader> callBack = (FutureCallback<OfHeader>) invocation.getArguments()[2];
 250                 callBack.onSuccess(null);
 251                 return null;
 252             }
 253         })
 254                 .when(outboundQueueProvider)
 255                 .commitEntry(Matchers.anyLong(), Matchers.<MultipartRequestInput>any(), Matchers.<FutureCallback<OfHeader>>any());
 256
 257         when(mockedConnectionAdapter.registerOutboundQueueHandler(Matchers.<OutboundQueueHandler>any(), Matchers.anyInt(), Matchers.anyLong()))
 258                 .thenAnswer(new Answer<OutboundQueueHandlerRegistration<OutboundQueueHandler>>() {
 259                     @Override
 260                     public OutboundQueueHandlerRegistration<OutboundQueueHandler> answer(final InvocationOnMock invocation) throws Throwable {
 261                         final OutboundQueueHandler handler = (OutboundQueueHandler) invocation.getArguments()[0];
 262                         handler.onConnectionQueueChanged(outboundQueueProvider);
 263                         return null;
 264                     }
 265                 });
 266
 267         when(mockConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueueProvider);
 268         return mockConnectionContext;
 269     }
 270
 271     private void injectMockTranslatorLibrary(final DeviceManagerImpl deviceManager) {
 272         deviceManager.setTranslatorLibrary(translatorLibrary);
 273     }
 274
 275     @Test
 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());
 282
 283         deviceManager.close();
 284
 285         verify(deviceContext).shutdownConnection();
 286         verify(deviceContext, Mockito.never()).close();
 287     }
 288
 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);
 295     }
 296
 297 }