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