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.mockito.Mockito.times;
  11 import static org.mockito.Mockito.verify;
  12 import static org.mockito.Mockito.when;
  13
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.Futures;
  16 import io.netty.util.HashedWheelTimer;
  17 import io.netty.util.Timeout;
  18 import java.lang.reflect.Field;
  19 import java.math.BigInteger;
  20 import java.util.Collections;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Optional;
  24 import java.util.concurrent.ExecutionException;
  25 import java.util.concurrent.Future;
  26 import org.junit.Assert;
  27 import org.junit.Before;
  28 import org.junit.Test;
  29 import org.junit.runner.RunWith;
  30 import org.mockito.ArgumentCaptor;
  31 import org.mockito.Captor;
  32 import org.mockito.Matchers;
  33 import org.mockito.Mock;
  34 import org.mockito.Mockito;
  35 import org.mockito.invocation.InvocationOnMock;
  36 import org.mockito.runners.MockitoJUnitRunner;
  37 import org.mockito.stubbing.Answer;
  38 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  39 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  40 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  41 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  42 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  43 import org.opendaylight.openflowplugin.api.OFConstants;
  44 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  45 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  46 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  47 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  48 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  49 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  50 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  51 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  52 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  53 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  54 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
  55 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  56 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
  57 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  58 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  59 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  60 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  61 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  62 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInputBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
  76 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  77 import org.opendaylight.yangtools.yang.common.RpcResult;
  78 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  79 import org.slf4j.Logger;
  80 import org.slf4j.LoggerFactory;
  81
  82
  83 @RunWith(MockitoJUnitRunner.class)
  84 public class StatisticsManagerImplTest {
  85
  86     private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImplTest.class);
  87
  88     private static final BigInteger DUMMY_DATAPATH_ID = new BigInteger("444");
  89     private static final Short DUMMY_VERSION = OFConstants.OFP_VERSION_1_3;
  90     public static final NodeId NODE_ID = new NodeId("ofp-unit-dummy-node-id");
  91
  92     @Mock
  93     RequestContextStack mockedRequestContextStack;
  94     @Mock
  95     ConnectionContext mockedPrimConnectionContext;
  96     @Mock
  97     FeaturesReply mockedFeatures;
  98     @Mock
  99     GetFeaturesOutput mockedFeaturesOutput;
 100     @Mock
 101     ConnectionAdapter mockedConnectionAdapter;
 102     @Mock
 103     MessageSpy mockedMessagSpy;
 104     @Mock
 105     DeviceContext mockedDeviceContext;
 106     @Mock
 107     DeviceState mockedDeviceState;
 108     @Mock
 109     DeviceInfo mockedDeviceInfo;
 110     @Mock
 111     DeviceInitializationPhaseHandler mockedDevicePhaseHandler;
 112     @Mock
 113     DeviceTerminationPhaseHandler mockedTerminationPhaseHandler;
 114     @Mock
 115     private RpcProviderRegistry rpcProviderRegistry;
 116     @Mock
 117     private HashedWheelTimer hashedWheelTimer;
 118     @Mock
 119     private OutboundQueue outboundQueue;
 120     @Mock
 121     private MultiMsgCollector multiMagCollector;
 122     @Mock
 123     private ItemLifeCycleRegistry itemLifeCycleRegistry;
 124     @Captor
 125     private ArgumentCaptor<ItemLifecycleListener> itemLifeCycleListenerCapt;
 126     @Mock
 127     private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
 128     @Mock
 129     private DeviceManager deviceManager;
 130     @Mock
 131     private GetFeaturesOutput featuresOutput;
 132     @Mock
 133     private DeviceInitializationPhaseHandler deviceInitializationPhaseHandler;
 134     @Mock
 135     private DeviceInfo deviceInfo;
 136     @Mock
 137     private DataBroker dataBroker;
 138     @Mock
 139     private LifecycleService lifecycleService;
 140
 141     private RequestContext<List<MultipartReply>> currentRequestContext;
 142     private StatisticsManagerImpl statisticsManager;
 143
 144
 145     @Before
 146     public void initialization() {
 147         final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
 148                 .create(Nodes.class)
 149                 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
 150
 151         when(mockedPrimConnectionContext.getFeatures()).thenReturn(mockedFeatures);
 152         when(mockedPrimConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
 153         when(mockedPrimConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.WORKING);
 154         when(mockedPrimConnectionContext.getNodeId()).thenReturn(NODE_ID);
 155         when(mockedPrimConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueue);
 156
 157         when(mockedDeviceState.isFlowStatisticsAvailable()).thenReturn(Boolean.TRUE);
 158         when(mockedDeviceState.isGroupAvailable()).thenReturn(Boolean.TRUE);
 159         when(mockedDeviceState.isMetersAvailable()).thenReturn(Boolean.TRUE);
 160         when(mockedDeviceState.isPortStatisticsAvailable()).thenReturn(Boolean.TRUE);
 161         when(mockedDeviceState.isQueueStatisticsAvailable()).thenReturn(Boolean.TRUE);
 162         when(mockedDeviceState.isTableStatisticsAvailable()).thenReturn(Boolean.TRUE);
 163         when(mockedDeviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
 164         when(mockedDeviceInfo.getDatapathId()).thenReturn(BigInteger.TEN);
 165         when(mockedDeviceInfo.getNodeId()).thenReturn(NODE_ID);
 166
 167         when(mockedDeviceContext.getDeviceInfo()).thenReturn(mockedDeviceInfo);
 168         when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimConnectionContext);
 169         when(mockedDeviceContext.getMessageSpy()).thenReturn(mockedMessagSpy);
 170         when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(new DeviceFlowRegistryImpl(dataBroker, nodePath));
 171         when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
 172         when(mockedDeviceContext.getMultiMsgCollector(
 173                 Matchers.<RequestContext<List<MultipartReply>>>any())).thenAnswer(
 174                 new Answer<MultiMsgCollector>() {
 175                     @Override
 176                     public MultiMsgCollector answer(InvocationOnMock invocation) throws Throwable {
 177                         currentRequestContext = (RequestContext<List<MultipartReply>>) invocation.getArguments()[0];
 178                         return multiMagCollector;
 179                     }
 180                 }
 181         );
 182         when(mockedDeviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
 183         when(rpcProviderRegistry.addRpcImplementation(
 184                 Matchers.eq(StatisticsManagerControlService.class),
 185                 Matchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
 186
 187         final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
 188         statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, false, new HashedWheelTimer(), convertorManager);
 189         statisticsManager.setDeviceInitializationPhaseHandler(deviceInitializationPhaseHandler);
 190     }
 191
 192     @Test
 193     public void testOnDeviceContextLevelUp() throws Exception {
 194         Mockito.doAnswer(new Answer<Void>() {
 195             @Override
 196             public Void answer(InvocationOnMock invocation) throws Throwable {
 197                 final FutureCallback<OfHeader> callback = (FutureCallback<OfHeader>) invocation.getArguments()[2];
 198                 LOG.debug("committing entry: {}", ((MultipartRequestInput) invocation.getArguments()[1]).getType());
 199                 callback.onSuccess(null);
 200                 currentRequestContext.setResult(RpcResultBuilder.<List<MultipartReply>>success().build());
 201                 return null;
 202             }
 203         }).when(outboundQueue)
 204                 .commitEntry(Matchers.anyLong(), Matchers.<OfHeader>any(), Matchers.<FutureCallback<OfHeader>>any());
 205
 206         Mockito.when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
 207         Mockito.when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
 208
 209         statisticsManager.setDeviceInitializationPhaseHandler(mockedDevicePhaseHandler);
 210         statisticsManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 211         verify(mockedDevicePhaseHandler).onDeviceContextLevelUp(deviceInfo, lifecycleService);
 212     }
 213
 214     @Test
 215     public void testOnDeviceContextClosed() throws Exception {
 216         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 217         final Map<DeviceInfo, StatisticsContext> contextsMap = getContextsMap(statisticsManager);
 218
 219         contextsMap.put(deviceInfo, statisticContext);
 220         Assert.assertEquals(1, contextsMap.size());
 221
 222         statisticsManager.setDeviceTerminationPhaseHandler(mockedTerminationPhaseHandler);
 223         statisticsManager.onDeviceContextLevelDown(deviceInfo);
 224         verify(statisticContext).close();
 225         verify(mockedTerminationPhaseHandler).onDeviceContextLevelDown(deviceInfo);
 226         Assert.assertEquals(0, contextsMap.size());
 227     }
 228
 229     private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
 230             throws NoSuchFieldException, IllegalAccessException {
 231         // HACK: contexts map for testing shall be accessed in some more civilized way
 232         final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
 233         Assert.assertNotNull(contextsField);
 234         contextsField.setAccessible(true);
 235         return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
 236     }
 237
 238     @Test
 239     public void testGetStatisticsWorkMode() throws Exception {
 240         final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode();
 241         Assert.assertTrue(workMode.isDone());
 242         Assert.assertTrue(workMode.get().isSuccessful());
 243         Assert.assertNotNull(workMode.get().getResult());
 244         Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
 245     }
 246
 247     /**
 248      * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry
 249      *
 250      * @throws Exception
 251      */
 252     @Test
 253     public void testChangeStatisticsWorkMode1() throws Exception {
 254         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 255         when(statisticContext.getPollTimeout()).thenReturn(
 256                 Optional.<Timeout>empty());
 257         when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
 258                 Collections.<ItemLifeCycleSource>emptyList());
 259
 260         when(statisticContext.getLifecycleService()).thenReturn(lifecycleService);
 261         when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
 262
 263         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 264
 265         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 266                 new ChangeStatisticsWorkModeInputBuilder()
 267                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 268
 269         final Future<RpcResult<Void>> workMode = statisticsManager
 270                 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 271
 272         checkWorkModeChangeOutcome(workMode);
 273         Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
 274         Mockito.verify(statisticContext).getPollTimeout();
 275     }
 276
 277     private static void checkWorkModeChangeOutcome(Future<RpcResult<Void>> workMode) throws InterruptedException, ExecutionException {
 278         Assert.assertTrue(workMode.isDone());
 279         Assert.assertTrue(workMode.get().isSuccessful());
 280     }
 281
 282
 283     /**
 284      * switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry
 285      *
 286      * @throws Exception
 287      */
 288     @Test
 289     public void testChangeStatisticsWorkMode2() throws Exception {
 290         final Timeout pollTimeout = Mockito.mock(Timeout.class);
 291         final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
 292         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 293         when(statisticContext.getPollTimeout()).thenReturn(
 294                 Optional.of(pollTimeout));
 295         when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
 296                 Collections.singletonList(itemLifecycleSource));
 297
 298         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 299
 300         when(statisticContext.getLifecycleService()).thenReturn(lifecycleService);
 301         when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
 302
 303         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 304                 new ChangeStatisticsWorkModeInputBuilder()
 305                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 306
 307         Future<RpcResult<Void>> workMode = statisticsManager.changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 308         checkWorkModeChangeOutcome(workMode);
 309
 310         Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
 311         Mockito.verify(statisticContext).getPollTimeout();
 312         Mockito.verify(pollTimeout).cancel();
 313         Mockito.verify(itemLifecycleSource).setItemLifecycleListener(Matchers.<ItemLifecycleListener>any());
 314     }
 315
 316     /**
 317      * switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
 318      * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout
 319      *
 320      * @throws Exception
 321      */
 322     @Test
 323     public void testChangeStatisticsWorkMode3() throws Exception {
 324         final Timeout pollTimeout = Mockito.mock(Timeout.class);
 325         final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
 326         Mockito.doNothing().when(itemLifecycleSource)
 327                 .setItemLifecycleListener(itemLifeCycleListenerCapt.capture());
 328
 329         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 330         when(statisticContext.getPollTimeout()).thenReturn(
 331                 Optional.of(pollTimeout));
 332         when(statisticContext.getItemLifeCycleListener()).thenReturn(
 333                 Mockito.mock(ItemLifecycleListener.class));
 334         when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
 335                 Collections.singletonList(itemLifecycleSource));
 336
 337         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 338
 339         when(statisticContext.getLifecycleService()).thenReturn(lifecycleService);
 340         when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
 341
 342         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 343                 new ChangeStatisticsWorkModeInputBuilder()
 344                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 345
 346         Future<RpcResult<Void>> workMode;
 347         workMode = statisticsManager.changeStatisticsWorkMode(
 348                 changeStatisticsWorkModeInputBld.build());
 349         checkWorkModeChangeOutcome(workMode);
 350
 351         changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
 352         workMode = statisticsManager.changeStatisticsWorkMode(
 353                 changeStatisticsWorkModeInputBld.build());
 354         checkWorkModeChangeOutcome(workMode);
 355
 356         Mockito.verify(itemLifeCycleRegistry, Mockito.times(2)).getLifeCycleSources();
 357         Mockito.verify(statisticContext).getPollTimeout();
 358         Mockito.verify(pollTimeout).cancel();
 359
 360         final List<ItemLifecycleListener> itemLifeCycleListenerValues = itemLifeCycleListenerCapt.getAllValues();
 361         Assert.assertEquals(2, itemLifeCycleListenerValues.size());
 362         Assert.assertNotNull(itemLifeCycleListenerValues.get(0));
 363         Assert.assertNull(itemLifeCycleListenerValues.get(1));
 364     }
 365
 366     @Test
 367     public void testClose() throws Exception {
 368         statisticsManager.close();
 369         Mockito.verify(serviceControlRegistration).close();
 370     }
 371
 372     @Test
 373     public void testCalculateTimerDelay() throws Exception {
 374         final TimeCounter timeCounter = Mockito.mock(TimeCounter.class);
 375         when(timeCounter.getAverageTimeBetweenMarks()).thenReturn(2000L, (Long)4000L);
 376
 377         statisticsManager.calculateTimerDelay(timeCounter);
 378         Assert.assertEquals(3000L, StatisticsManagerImpl.getCurrentTimerDelay());
 379         statisticsManager.calculateTimerDelay(timeCounter);
 380         Assert.assertEquals(6000L, StatisticsManagerImpl.getCurrentTimerDelay());
 381     }
 382
 383     @Test
 384     public void testPollStatistics() throws Exception {
 385         final StatisticsContext statisticsContext = Mockito.mock(StatisticsContext.class);
 386         final TimeCounter mockTimerCounter = Mockito.mock(TimeCounter.class);
 387
 388         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 389         verify(mockedDeviceContext).getDeviceState();
 390
 391         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 392
 393         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 394
 395         when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateCheckedFuture(Boolean.TRUE));
 396         when(statisticsContext.isSchedulingEnabled()).thenReturn(Boolean.TRUE);
 397         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 398         Mockito.verify(mockTimerCounter).markStart();
 399         Mockito.verify(mockTimerCounter).addTimeMark();
 400
 401         when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateFailedFuture(new Throwable("error msg")));
 402         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 403         Mockito.verify(mockTimerCounter,times(2)).addTimeMark();
 404     }
 405 }