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.openflow.connection.ConnectionContext;
  44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  45 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  46 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  47 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  48 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  49 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  50 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  51 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  52 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  53 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
  54 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  55 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
  56 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  57 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  58 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  59 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  60 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  61 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInputBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
  75 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  76 import org.opendaylight.yangtools.yang.common.RpcResult;
  77 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  78 import org.slf4j.Logger;
  79 import org.slf4j.LoggerFactory;
  80
  81
  82 @RunWith(MockitoJUnitRunner.class)
  83 public class StatisticsManagerImplTest {
  84
  85     private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImplTest.class);
  86
  87     public static final NodeId NODE_ID = new NodeId("ofp-unit-dummy-node-id");
  88
  89     @Mock
  90     RequestContextStack mockedRequestContextStack;
  91     @Mock
  92     ConnectionContext mockedPrimConnectionContext;
  93     @Mock
  94     FeaturesReply mockedFeatures;
  95     @Mock
  96     GetFeaturesOutput mockedFeaturesOutput;
  97     @Mock
  98     ConnectionAdapter mockedConnectionAdapter;
  99     @Mock
 100     MessageSpy mockedMessagSpy;
 101     @Mock
 102     DeviceContext mockedDeviceContext;
 103     @Mock
 104     DeviceState mockedDeviceState;
 105     @Mock
 106     DeviceInfo mockedDeviceInfo;
 107     @Mock
 108     DeviceInitializationPhaseHandler mockedDevicePhaseHandler;
 109     @Mock
 110     DeviceTerminationPhaseHandler mockedTerminationPhaseHandler;
 111     @Mock
 112     private RpcProviderRegistry rpcProviderRegistry;
 113     @Mock
 114     private HashedWheelTimer hashedWheelTimer;
 115     @Mock
 116     private OutboundQueue outboundQueue;
 117     @Mock
 118     private MultiMsgCollector multiMagCollector;
 119     @Mock
 120     private ItemLifeCycleRegistry itemLifeCycleRegistry;
 121     @Captor
 122     private ArgumentCaptor<ItemLifecycleListener> itemLifeCycleListenerCapt;
 123     @Mock
 124     private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
 125     @Mock
 126     private DeviceManager deviceManager;
 127     @Mock
 128     private GetFeaturesOutput featuresOutput;
 129     @Mock
 130     private DeviceInitializationPhaseHandler deviceInitializationPhaseHandler;
 131     @Mock
 132     private DeviceInfo deviceInfo;
 133     @Mock
 134     private DataBroker dataBroker;
 135     @Mock
 136     private LifecycleService lifecycleService;
 137
 138     private RequestContext<List<MultipartReply>> currentRequestContext;
 139     private StatisticsManagerImpl statisticsManager;
 140
 141
 142     @Before
 143     public void initialization() {
 144         final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
 145                 .create(Nodes.class)
 146                 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
 147
 148         when(mockedPrimConnectionContext.getFeatures()).thenReturn(mockedFeatures);
 149         when(mockedPrimConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
 150         when(mockedPrimConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.WORKING);
 151         when(mockedPrimConnectionContext.getNodeId()).thenReturn(NODE_ID);
 152         when(mockedPrimConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueue);
 153
 154         when(mockedDeviceState.isFlowStatisticsAvailable()).thenReturn(Boolean.TRUE);
 155         when(mockedDeviceState.isGroupAvailable()).thenReturn(Boolean.TRUE);
 156         when(mockedDeviceState.isMetersAvailable()).thenReturn(Boolean.TRUE);
 157         when(mockedDeviceState.isPortStatisticsAvailable()).thenReturn(Boolean.TRUE);
 158         when(mockedDeviceState.isQueueStatisticsAvailable()).thenReturn(Boolean.TRUE);
 159         when(mockedDeviceState.isTableStatisticsAvailable()).thenReturn(Boolean.TRUE);
 160         when(mockedDeviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
 161         when(mockedDeviceInfo.getDatapathId()).thenReturn(BigInteger.TEN);
 162         when(mockedDeviceInfo.getNodeId()).thenReturn(NODE_ID);
 163
 164         when(mockedDeviceContext.getDeviceInfo()).thenReturn(mockedDeviceInfo);
 165         when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimConnectionContext);
 166         when(mockedDeviceContext.getMessageSpy()).thenReturn(mockedMessagSpy);
 167         when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(new DeviceFlowRegistryImpl(dataBroker, nodePath));
 168         when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
 169         when(mockedDeviceContext.getMultiMsgCollector(
 170                 Matchers.<RequestContext<List<MultipartReply>>>any())).thenAnswer(
 171                 new Answer<MultiMsgCollector>() {
 172                     @Override
 173                     public MultiMsgCollector answer(InvocationOnMock invocation) throws Throwable {
 174                         currentRequestContext = (RequestContext<List<MultipartReply>>) invocation.getArguments()[0];
 175                         return multiMagCollector;
 176                     }
 177                 }
 178         );
 179         when(mockedDeviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
 180         when(rpcProviderRegistry.addRpcImplementation(
 181                 Matchers.eq(StatisticsManagerControlService.class),
 182                 Matchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
 183
 184         final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
 185         final long basicTimerDelay = 3000L;
 186         final long maximumTimerDelay = 900000L;
 187         statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, false, new HashedWheelTimer(),
 188                 convertorManager, basicTimerDelay, maximumTimerDelay);
 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(1, 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.gainDeviceContext()).thenReturn(mockedDeviceContext);
 261         when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
 262         when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
 263
 264         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 265
 266         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 267                 new ChangeStatisticsWorkModeInputBuilder()
 268                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 269
 270         final Future<RpcResult<Void>> workMode = statisticsManager
 271                 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 272
 273         checkWorkModeChangeOutcome(workMode);
 274         Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
 275         Mockito.verify(statisticContext).getPollTimeout();
 276     }
 277
 278     private static void checkWorkModeChangeOutcome(Future<RpcResult<Void>> workMode) throws InterruptedException, ExecutionException {
 279         Assert.assertTrue(workMode.isDone());
 280         Assert.assertTrue(workMode.get().isSuccessful());
 281     }
 282
 283
 284     /**
 285      * switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry
 286      *
 287      * @throws Exception
 288      */
 289     @Test
 290     public void testChangeStatisticsWorkMode2() throws Exception {
 291         final Timeout pollTimeout = Mockito.mock(Timeout.class);
 292         final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
 293         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 294         when(statisticContext.getPollTimeout()).thenReturn(
 295                 Optional.of(pollTimeout));
 296         when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
 297                 Collections.singletonList(itemLifecycleSource));
 298
 299         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 300
 301         when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
 302         when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
 303         when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
 304
 305         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 306                 new ChangeStatisticsWorkModeInputBuilder()
 307                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 308
 309         Future<RpcResult<Void>> workMode = statisticsManager.changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 310         checkWorkModeChangeOutcome(workMode);
 311
 312         Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
 313         Mockito.verify(statisticContext).getPollTimeout();
 314         Mockito.verify(pollTimeout).cancel();
 315         Mockito.verify(itemLifecycleSource).setItemLifecycleListener(Matchers.<ItemLifecycleListener>any());
 316     }
 317
 318     /**
 319      * switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
 320      * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout
 321      *
 322      * @throws Exception
 323      */
 324     @Test
 325     public void testChangeStatisticsWorkMode3() throws Exception {
 326         final Timeout pollTimeout = Mockito.mock(Timeout.class);
 327         final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
 328         Mockito.doNothing().when(itemLifecycleSource)
 329                 .setItemLifecycleListener(itemLifeCycleListenerCapt.capture());
 330
 331         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 332         when(statisticContext.getPollTimeout()).thenReturn(
 333                 Optional.of(pollTimeout));
 334         when(statisticContext.getItemLifeCycleListener()).thenReturn(
 335                 Mockito.mock(ItemLifecycleListener.class));
 336         when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
 337                 Collections.singletonList(itemLifecycleSource));
 338
 339         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 340
 341         when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
 342         when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
 343         when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
 344
 345         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
 346                 new ChangeStatisticsWorkModeInputBuilder()
 347                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 348
 349         Future<RpcResult<Void>> workMode;
 350         workMode = statisticsManager.changeStatisticsWorkMode(
 351                 changeStatisticsWorkModeInputBld.build());
 352         checkWorkModeChangeOutcome(workMode);
 353
 354         changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
 355         workMode = statisticsManager.changeStatisticsWorkMode(
 356                 changeStatisticsWorkModeInputBld.build());
 357         checkWorkModeChangeOutcome(workMode);
 358
 359         Mockito.verify(itemLifeCycleRegistry, Mockito.times(2)).getLifeCycleSources();
 360         Mockito.verify(statisticContext).getPollTimeout();
 361         Mockito.verify(pollTimeout).cancel();
 362
 363         final List<ItemLifecycleListener> itemLifeCycleListenerValues = itemLifeCycleListenerCapt.getAllValues();
 364         Assert.assertEquals(2, itemLifeCycleListenerValues.size());
 365         Assert.assertNotNull(itemLifeCycleListenerValues.get(0));
 366         Assert.assertNull(itemLifeCycleListenerValues.get(1));
 367     }
 368
 369     @Test
 370     public void testClose() throws Exception {
 371         statisticsManager.close();
 372         Mockito.verify(serviceControlRegistration).close();
 373     }
 374
 375     @Test
 376     public void testCalculateTimerDelay() throws Exception {
 377         final TimeCounter timeCounter = Mockito.mock(TimeCounter.class);
 378         when(timeCounter.getAverageTimeBetweenMarks()).thenReturn(2000L, (Long)4000L);
 379
 380         statisticsManager.calculateTimerDelay(timeCounter);
 381         Assert.assertEquals(3000L, StatisticsManagerImpl.getCurrentTimerDelay());
 382         statisticsManager.calculateTimerDelay(timeCounter);
 383         Assert.assertEquals(6000L, StatisticsManagerImpl.getCurrentTimerDelay());
 384     }
 385
 386     @Test
 387     public void testPollStatistics() throws Exception {
 388         final StatisticsContext statisticsContext = Mockito.mock(StatisticsContext.class);
 389         final TimeCounter mockTimerCounter = Mockito.mock(TimeCounter.class);
 390
 391         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 392         verify(mockedDeviceContext).getDeviceState();
 393
 394         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 395
 396         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 397
 398         when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateCheckedFuture(Boolean.TRUE));
 399         when(statisticsContext.isSchedulingEnabled()).thenReturn(Boolean.TRUE);
 400         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 401         Mockito.verify(mockTimerCounter).markStart();
 402         Mockito.verify(mockTimerCounter).addTimeMark();
 403
 404         when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateFailedFuture(new Throwable("error msg")));
 405         statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
 406         Mockito.verify(mockTimerCounter,times(2)).addTimeMark();
 407     }
 408 }