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