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