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.opendaylight.yangtools.yang.common.Uint32;
  62 import org.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  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 RpcProviderService rpcProviderRegistry;
  88     @Mock
  89     private OutboundQueue outboundQueue;
  90     @Mock
  91     private MultiMsgCollector multiMagCollector;
  92     @Mock
  93     private ObjectRegistration<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.registerRpcImplementation(
 112                 eq(StatisticsManagerControlService.class),
 113                 ArgumentMatchers.any())).thenReturn(serviceControlRegistration);
 114
 115         final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
 116
 117         statisticsManager = new StatisticsManagerImpl(
 118                 new OpenflowProviderConfigBuilder()
 119                         .setBasicTimerDelay(new NonZeroUint32Type(Uint32.valueOf(3000)))
 120                         .setMaximumTimerDelay(new NonZeroUint32Type(Uint32.valueOf(900000)))
 121                         .setIsStatisticsPollingOn(false)
 122                         .build(), rpcProviderRegistry,
 123                 convertorManager,
 124                 MoreExecutors.newDirectExecutorService());
 125     }
 126
 127     private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
 128             throws NoSuchFieldException, IllegalAccessException {
 129         // HACK: contexts map for testing shall be accessed in some more civilized way
 130         final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
 131         assertNotNull(contextsField);
 132         contextsField.setAccessible(true);
 133         return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
 134     }
 135
 136     @Test
 137     public void testGetStatisticsWorkMode() throws Exception {
 138         final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode(null);
 139         Assert.assertTrue(workMode.isDone());
 140         Assert.assertTrue(workMode.get().isSuccessful());
 141         assertNotNull(workMode.get().getResult());
 142         Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
 143     }
 144
 145     /**
 146      * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry.
 147      *
 148      */
 149     @Test
 150     public void testChangeStatisticsWorkMode1() throws Exception {
 151         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 152
 153         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 154
 155         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 156                 new ChangeStatisticsWorkModeInputBuilder()
 157                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 158
 159         final ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
 160                 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 161
 162         checkWorkModeChangeOutcome(workMode);
 163         verify(statisticContext).disableGathering();
 164     }
 165
 166     private static void checkWorkModeChangeOutcome(ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode)
 167             throws InterruptedException, ExecutionException {
 168         Assert.assertTrue(workMode.isDone());
 169         Assert.assertTrue(workMode.get().isSuccessful());
 170     }
 171
 172
 173     /**
 174      * Switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry.
 175      *
 176      */
 177     @Test
 178     public void testChangeStatisticsWorkMode2() throws Exception {
 179         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 180
 181         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 182
 183         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 184                 new ChangeStatisticsWorkModeInputBuilder()
 185                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 186
 187         ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
 188             .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 189         checkWorkModeChangeOutcome(workMode);
 190
 191         verify(statisticContext).disableGathering();
 192     }
 193
 194     /**
 195      * Tests switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
 196      * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout.
 197      *
 198      */
 199     @Test
 200     public void testChangeStatisticsWorkMode3() throws Exception {
 201         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 202
 203         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 204
 205         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 206                 new ChangeStatisticsWorkModeInputBuilder()
 207                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 208
 209         ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode;
 210         workMode = statisticsManager.changeStatisticsWorkMode(
 211                 changeStatisticsWorkModeInputBld.build());
 212         checkWorkModeChangeOutcome(workMode);
 213
 214         verify(statisticContext).disableGathering();
 215
 216         changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
 217         workMode = statisticsManager.changeStatisticsWorkMode(
 218                 changeStatisticsWorkModeInputBld.build());
 219         checkWorkModeChangeOutcome(workMode);
 220
 221         verify(statisticContext).enableGathering();
 222     }
 223
 224     @Test
 225     public void testClose() {
 226         statisticsManager.close();
 227         verify(serviceControlRegistration).close();
 228     }
 229 }