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