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 package org.opendaylight.openflowplugin.impl.device;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.mockito.ArgumentMatchers.any;
  13 import static org.mockito.ArgumentMatchers.eq;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.verify;
  17 import static org.mockito.Mockito.when;
  18
  19 import com.google.common.util.concurrent.FluentFuture;
  20 import com.google.common.util.concurrent.ListenableFuture;
  21 import io.netty.util.HashedWheelTimer;
  22 import java.lang.reflect.Field;
  23 import java.util.concurrent.ConcurrentHashMap;
  24 import java.util.concurrent.ExecutionException;
  25 import org.junit.Assert;
  26 import org.junit.Before;
  27 import org.junit.Test;
  28 import org.junit.runner.RunWith;
  29 import org.mockito.Mock;
  30 import org.mockito.Mockito;
  31 import org.mockito.junit.MockitoJUnitRunner;
  32 import org.opendaylight.mdsal.binding.api.DataBroker;
  33 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
  34 import org.opendaylight.mdsal.binding.api.TransactionChain;
  35 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  36 import org.opendaylight.mdsal.common.api.CommitInfo;
  37 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  38 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  39 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  40 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  42 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  43 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  44 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
  45 import org.opendaylight.openflowplugin.impl.device.initialization.DeviceInitializerProviderFactory;
  46 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
  47 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRemovedBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdatedBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint16Type;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfigBuilder;
  60 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  61 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  62
  63 @RunWith(MockitoJUnitRunner.class)
  64 public class DeviceManagerImplTest {
  65
  66     private static final long TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA = 2000L;
  67     private static final int BARRIER_COUNT_LIMIT = 25600;
  68     private static final long BARRIER_INTERVAL_NANOS = 500;
  69     private static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
  70     private static final KeyedInstanceIdentifier<Node, NodeKey> DUMMY_IDENTIFIER  = DeviceStateUtil
  71             .createNodeInstanceIdentifier(DUMMY_NODE_ID);
  72
  73     @Mock
  74     private FluentFuture<CommitInfo> mockedFuture;
  75     @Mock
  76     private FeaturesReply mockFeatures;
  77     @Mock
  78     private ConnectionContext mockConnectionContext;
  79     @Mock
  80     private ConnectionAdapter mockedConnectionAdapter;
  81     @Mock
  82     private DeviceContextImpl mockedDeviceContext;
  83     @Mock
  84     private MessageIntelligenceAgency messageIntelligenceAgency;
  85     @Mock
  86     private DeviceInfo deviceInfo;
  87     @Mock
  88     private ConvertorExecutor convertorExecutor;
  89     @Mock
  90     private DataBroker dataBroker;
  91     @Mock
  92     private WriteTransaction writeTransaction;
  93     @Mock
  94     private TransactionChain transactionChain;
  95     @Mock
  96     private Capabilities capabilities;
  97     @Mock
  98     private CapabilitiesV10 capabilitiesV10;
  99     @Mock
 100     private NotificationPublishService notificationPublishService;
 101     @Mock
 102     private TranslatorLibrary translatorLibrary;
 103
 104     private DeviceManagerImpl deviceManager;
 105
 106     @Before
 107     public void setUp() {
 108         when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
 109         when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
 110         when(mockConnectionContext.getDeviceInfo()).thenReturn(deviceInfo);
 111         when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(DUMMY_IDENTIFIER);
 112         when(deviceInfo.getNodeId()).thenReturn(DUMMY_NODE_ID);
 113
 114         when(mockedFuture.isDone()).thenReturn(true);
 115         doReturn(mockedFuture).when(writeTransaction).commit();
 116         when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
 117
 118         deviceManager = new DeviceManagerImpl(
 119                 new OpenflowProviderConfigBuilder()
 120                         .setBarrierCountLimit(new NonZeroUint16Type(BARRIER_COUNT_LIMIT))
 121                         .setBarrierIntervalTimeoutLimit(new NonZeroUint32Type(BARRIER_INTERVAL_NANOS))
 122                         .setGlobalNotificationQuota(TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA)
 123                         .setSwitchFeaturesMandatory(false)
 124                         .setEnableFlowRemovedNotification(true)
 125                         .setSkipTableFeatures(false)
 126                         .setUseSingleLayerSerialization(true)
 127                         .build(),
 128                 dataBroker,
 129                 messageIntelligenceAgency,
 130                 notificationPublishService,
 131                 new HashedWheelTimer(),
 132                 convertorExecutor,
 133                 DeviceInitializerProviderFactory.createDefaultProvider());
 134
 135         deviceManager.setTranslatorLibrary(translatorLibrary);
 136         verify(dataBroker).newWriteOnlyTransaction();
 137         verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
 138         verify(writeTransaction).commit();
 139     }
 140
 141     @Test
 142     public void createContext() {
 143         final DeviceContext context = deviceManager.createContext(mockConnectionContext);
 144         assertEquals(deviceInfo, context.getDeviceInfo());
 145
 146     }
 147
 148     @Test
 149     public void removeDeviceFromOperationalDS() throws Exception {
 150         final ListenableFuture<?> future = deviceManager
 151                 .removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
 152
 153         future.get();
 154         assertTrue(future.isDone());
 155         verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
 156     }
 157
 158     @Test(expected = ExecutionException.class)
 159     public void removeDeviceFromOperationalDSException() throws Exception {
 160         final FluentFuture<CommitInfo> failedFuture = FluentFutures.immediateFailedFluentFuture(
 161                         new TransactionCommitFailedException("Test failed transaction"));
 162         Mockito.doReturn(failedFuture).when(writeTransaction).commit();
 163         final ListenableFuture<?> future = deviceManager.removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
 164         future.get();
 165         assertTrue(future.isDone());
 166         verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
 167     }
 168
 169     @Test
 170     public void sendNodeAddedNotification() {
 171         deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
 172         deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
 173         verify(notificationPublishService).offerNotification(new NodeUpdatedBuilder()
 174                 .setId(DUMMY_NODE_ID)
 175                 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
 176                 .build());
 177     }
 178
 179     @Test
 180     public void sendNodeRemovedNotification() {
 181         deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
 182         deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
 183         deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
 184         verify(notificationPublishService).offerNotification(new NodeRemovedBuilder()
 185                 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
 186                 .build());
 187     }
 188
 189     @Test
 190     public void close() throws Exception {
 191         final DeviceContext deviceContext = mock(DeviceContext.class);
 192         final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
 193         deviceContexts.put(deviceInfo, deviceContext);
 194         Assert.assertEquals(1, deviceContexts.size());
 195         deviceManager.close();
 196         verify(deviceContext).close();
 197     }
 198
 199     @SuppressWarnings("unchecked")
 200     private static ConcurrentHashMap<DeviceInfo, DeviceContext> getContextsCollection(
 201             final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
 202         // HACK: contexts collection for testing shall be accessed in some more civilized way
 203         final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
 204         Assert.assertNotNull(contextsField);
 205         contextsField.setAccessible(true);
 206         return (ConcurrentHashMap<DeviceInfo, DeviceContext>) contextsField.get(deviceManager);
 207     }
 208
 209 }