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