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