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 java.util.concurrent.ExecutorService;
  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.Mock;
  31 import org.mockito.Mockito;
  32 import org.mockito.junit.MockitoJUnitRunner;
  33 import org.opendaylight.mdsal.binding.api.DataBroker;
  34 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
  35 import org.opendaylight.mdsal.binding.api.TransactionChain;
  36 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  37 import org.opendaylight.mdsal.common.api.CommitInfo;
  38 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  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 import org.opendaylight.yangtools.yang.common.Uint16;
  63 import org.opendaylight.yangtools.yang.common.Uint32;
  64 import org.opendaylight.yangtools.yang.common.Uint8;
  65
  66 @RunWith(MockitoJUnitRunner.class)
  67 public class DeviceManagerImplTest {
  68
  69     private static final Uint32 TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA = Uint32.valueOf(2000);
  70     private static final Uint16 BARRIER_COUNT_LIMIT = Uint16.valueOf(25600);
  71     private static final Uint32 BARRIER_INTERVAL_NANOS = Uint32.valueOf(500);
  72     private static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
  73     private static final KeyedInstanceIdentifier<Node, NodeKey> DUMMY_IDENTIFIER  = DeviceStateUtil
  74             .createNodeInstanceIdentifier(DUMMY_NODE_ID);
  75
  76     @Mock
  77     private FluentFuture<CommitInfo> mockedFuture;
  78     @Mock
  79     private FeaturesReply mockFeatures;
  80     @Mock
  81     private ConnectionContext mockConnectionContext;
  82     @Mock
  83     private ConnectionAdapter mockedConnectionAdapter;
  84     @Mock
  85     private DeviceContextImpl mockedDeviceContext;
  86     @Mock
  87     private MessageIntelligenceAgency messageIntelligenceAgency;
  88     @Mock
  89     private DeviceInfo deviceInfo;
  90     @Mock
  91     private ConvertorExecutor convertorExecutor;
  92     @Mock
  93     private DataBroker dataBroker;
  94     @Mock
  95     private WriteTransaction writeTransaction;
  96     @Mock
  97     private TransactionChain transactionChain;
  98     @Mock
  99     private Capabilities capabilities;
 100     @Mock
 101     private CapabilitiesV10 capabilitiesV10;
 102     @Mock
 103     private NotificationPublishService notificationPublishService;
 104     @Mock
 105     private TranslatorLibrary translatorLibrary;
 106     @Mock
 107     private ExecutorService executorService;
 108
 109     private DeviceManagerImpl deviceManager;
 110
 111     @Before
 112     public void setUp() {
 113         when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
 114         when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
 115         when(mockConnectionContext.getDeviceInfo()).thenReturn(deviceInfo);
 116         when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(DUMMY_IDENTIFIER);
 117         when(deviceInfo.getNodeId()).thenReturn(DUMMY_NODE_ID);
 118         when(deviceInfo.getVersion()).thenReturn(Uint8.ONE);
 119
 120         when(mockedFuture.isDone()).thenReturn(true);
 121         doReturn(mockedFuture).when(writeTransaction).commit();
 122         when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
 123
 124         deviceManager = new DeviceManagerImpl(
 125                 new OpenflowProviderConfigBuilder()
 126                         .setBarrierCountLimit(new NonZeroUint16Type(BARRIER_COUNT_LIMIT))
 127                         .setBarrierIntervalTimeoutLimit(new NonZeroUint32Type(BARRIER_INTERVAL_NANOS))
 128                         .setGlobalNotificationQuota(TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA)
 129                         .setSwitchFeaturesMandatory(false)
 130                         .setEnableFlowRemovedNotification(true)
 131                         .setSkipTableFeatures(false)
 132                         .setUseSingleLayerSerialization(true)
 133                         .setIsStatisticsPollingOn(false)
 134                         .build(),
 135                 dataBroker,
 136                 messageIntelligenceAgency,
 137                 notificationPublishService,
 138                 new HashedWheelTimer(),
 139                 convertorExecutor,
 140                 DeviceInitializerProviderFactory.createDefaultProvider(),
 141                 executorService);
 142
 143         deviceManager.setTranslatorLibrary(translatorLibrary);
 144         verify(dataBroker).newWriteOnlyTransaction();
 145         verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
 146         verify(writeTransaction).commit();
 147     }
 148
 149     @Test
 150     public void createContext() {
 151         final DeviceContext context = deviceManager.createContext(mockConnectionContext);
 152         assertEquals(deviceInfo, context.getDeviceInfo());
 153
 154     }
 155
 156     @Test
 157     public void removeDeviceFromOperationalDS() throws Exception {
 158         final ListenableFuture<?> future = deviceManager
 159                 .removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
 160
 161         future.get();
 162         assertTrue(future.isDone());
 163         verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
 164     }
 165
 166     @Test(expected = ExecutionException.class)
 167     public void removeDeviceFromOperationalDSException() throws Exception {
 168         final FluentFuture<?> failedFuture = FluentFutures.immediateFailedFluentFuture(
 169                         new ExecutionException(new Throwable("Test failed transaction")));
 170         Mockito.doReturn(failedFuture).when(writeTransaction).commit();
 171         final ListenableFuture<?> future = deviceManager.removeDeviceFromOperationalDS(DUMMY_IDENTIFIER);
 172         future.get();
 173         assertTrue(future.isDone());
 174         verify(writeTransaction).delete(LogicalDatastoreType.OPERATIONAL, DUMMY_IDENTIFIER);
 175     }
 176
 177     @Test
 178     public void sendNodeAddedNotification() {
 179         deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
 180         deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
 181         verify(notificationPublishService).offerNotification(new NodeUpdatedBuilder()
 182                 .setId(DUMMY_NODE_ID)
 183                 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
 184                 .build());
 185     }
 186
 187     @Test
 188     public void sendNodeRemovedNotification() {
 189         deviceManager.sendNodeAddedNotification(DUMMY_IDENTIFIER);
 190         deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
 191         deviceManager.sendNodeRemovedNotification(DUMMY_IDENTIFIER);
 192         verify(notificationPublishService).offerNotification(new NodeRemovedBuilder()
 193                 .setNodeRef(new NodeRef(DUMMY_IDENTIFIER))
 194                 .build());
 195     }
 196
 197     @Test
 198     public void close() throws Exception {
 199         final DeviceContext deviceContext = mock(DeviceContext.class);
 200         final ConcurrentHashMap<DeviceInfo, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
 201         deviceContexts.put(deviceInfo, deviceContext);
 202         Assert.assertEquals(1, deviceContexts.size());
 203         deviceManager.close();
 204         verify(deviceContext).close();
 205     }
 206
 207     @SuppressWarnings("unchecked")
 208     private static ConcurrentHashMap<DeviceInfo, DeviceContext> getContextsCollection(
 209             final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
 210         // HACK: contexts collection for testing shall be accessed in some more civilized way
 211         final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
 212         Assert.assertNotNull(contextsField);
 213         contextsField.setAccessible(true);
 214         return (ConcurrentHashMap<DeviceInfo, DeviceContext>) contextsField.get(deviceManager);
 215     }
 216
 217 }