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