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