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