openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/statistics/StatisticsManagerImplTest.java

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