openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/statistics/StatisticsManagerImplTest.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.statistics;
   9
  10 import static org.junit.Assert.assertNotNull;
  11 import static org.mockito.ArgumentMatchers.eq;
  12 import static org.mockito.Mockito.verify;
  13 import static org.mockito.Mockito.when;
  14
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import java.lang.reflect.Field;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.concurrent.ExecutionException;
  21 import java.util.concurrent.Future;
  22 import org.junit.Assert;
  23 import org.junit.Before;
  24 import org.junit.Test;
  25 import org.junit.runner.RunWith;
  26 import org.mockito.ArgumentMatchers;
  27 import org.mockito.Mock;
  28 import org.mockito.Mockito;
  29 import org.mockito.runners.MockitoJUnitRunner;
  30 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  31 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  32 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  33 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  34 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  35 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  36 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  37 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  38 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  39 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  40 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  41 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ReconciliationFrameworkRegistrar;
  42 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  43 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  44 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  45 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfigBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInputBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeOutput;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
  59 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  60 import org.opendaylight.yangtools.yang.common.RpcResult;
  61 import org.slf4j.Logger;
  62 import org.slf4j.LoggerFactory;
  63
  64
  65 @RunWith(MockitoJUnitRunner.class)
  66 public class StatisticsManagerImplTest {
  67
  68     private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImplTest.class);
  69
  70     public static final NodeId NODE_ID = new NodeId("ofp-unit-dummy-node-id");
  71
  72     @Mock
  73     private ConnectionContext mockedPrimConnectionContext;
  74     @Mock
  75     private FeaturesReply mockedFeatures;
  76     @Mock
  77     private ConnectionAdapter mockedConnectionAdapter;
  78     @Mock
  79     private MessageSpy mockedMessagSpy;
  80     @Mock
  81     private DeviceContext mockedDeviceContext;
  82     @Mock
  83     private DeviceState mockedDeviceState;
  84     @Mock
  85     private DeviceInfo mockedDeviceInfo;
  86     @Mock
  87     private RpcProviderRegistry rpcProviderRegistry;
  88     @Mock
  89     private OutboundQueue outboundQueue;
  90     @Mock
  91     private MultiMsgCollector multiMagCollector;
  92     @Mock
  93     private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
  94     @Mock
  95     private DeviceInfo deviceInfo;
  96     @Mock
  97     private DataBroker dataBroker;
  98     @Mock
  99     private ReconciliationFrameworkRegistrar reconciliationFrameworkRegistrar;
 100
 101     private RequestContext<List<MultipartReply>> currentRequestContext;
 102     private StatisticsManagerImpl statisticsManager;
 103
 104
 105     @Before
 106     public void initialization() {
 107         final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
 108                 .create(Nodes.class)
 109                 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
 110
 111         when(rpcProviderRegistry.addRpcImplementation(
 112                 eq(StatisticsManagerControlService.class),
 113                 ArgumentMatchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
 114
 115         final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
 116         final long basicTimerDelay = 3000L;
 117         final long maximumTimerDelay = 900000L;
 118
 119         statisticsManager = new StatisticsManagerImpl(
 120                 new OpenflowProviderConfigBuilder()
 121                         .setBasicTimerDelay(new NonZeroUint32Type(basicTimerDelay))
 122                         .setMaximumTimerDelay(new NonZeroUint32Type(maximumTimerDelay))
 123                         .setIsStatisticsPollingOn(false)
 124                         .build(), rpcProviderRegistry,
 125                 convertorManager,
 126                 MoreExecutors.newDirectExecutorService());
 127     }
 128
 129     private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
 130             throws NoSuchFieldException, IllegalAccessException {
 131         // HACK: contexts map for testing shall be accessed in some more civilized way
 132         final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
 133         assertNotNull(contextsField);
 134         contextsField.setAccessible(true);
 135         return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
 136     }
 137
 138     @Test
 139     public void testGetStatisticsWorkMode() throws Exception {
 140         final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode(null);
 141         Assert.assertTrue(workMode.isDone());
 142         Assert.assertTrue(workMode.get().isSuccessful());
 143         assertNotNull(workMode.get().getResult());
 144         Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
 145     }
 146
 147     /**
 148      * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry.
 149      *
 150      */
 151     @Test
 152     public void testChangeStatisticsWorkMode1() throws Exception {
 153         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 154
 155         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 156
 157         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 158                 new ChangeStatisticsWorkModeInputBuilder()
 159                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 160
 161         final ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
 162                 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 163
 164         checkWorkModeChangeOutcome(workMode);
 165         verify(statisticContext).disableGathering();
 166     }
 167
 168     private static void checkWorkModeChangeOutcome(ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode)
 169             throws InterruptedException, ExecutionException {
 170         Assert.assertTrue(workMode.isDone());
 171         Assert.assertTrue(workMode.get().isSuccessful());
 172     }
 173
 174
 175     /**
 176      * Switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry.
 177      *
 178      */
 179     @Test
 180     public void testChangeStatisticsWorkMode2() throws Exception {
 181         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 182
 183         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 184
 185         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 186                 new ChangeStatisticsWorkModeInputBuilder()
 187                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 188
 189         ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
 190             .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 191         checkWorkModeChangeOutcome(workMode);
 192
 193         verify(statisticContext).disableGathering();
 194     }
 195
 196     /**
 197      * Tests switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
 198      * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout.
 199      *
 200      */
 201     @Test
 202     public void testChangeStatisticsWorkMode3() throws Exception {
 203         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 204
 205         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 206
 207         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 208                 new ChangeStatisticsWorkModeInputBuilder()
 209                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 210
 211         ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode;
 212         workMode = statisticsManager.changeStatisticsWorkMode(
 213                 changeStatisticsWorkModeInputBld.build());
 214         checkWorkModeChangeOutcome(workMode);
 215
 216         verify(statisticContext).disableGathering();
 217
 218         changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
 219         workMode = statisticsManager.changeStatisticsWorkMode(
 220                 changeStatisticsWorkModeInputBld.build());
 221         checkWorkModeChangeOutcome(workMode);
 222
 223         verify(statisticContext).enableGathering();
 224     }
 225
 226     @Test
 227     public void testClose() throws Exception {
 228         statisticsManager.close();
 229         verify(serviceControlRegistration).close();
 230     }
 231 }