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