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