2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.openflowplugin.impl.statistics;
10 import static org.mockito.Mockito.*;
12 import com.google.common.util.concurrent.FutureCallback;
13 import com.google.common.util.concurrent.Futures;
14 import java.lang.reflect.Field;
15 import java.math.BigInteger;
16 import java.util.Collections;
17 import java.util.List;
19 import java.util.Optional;
20 import java.util.concurrent.ExecutionException;
21 import java.util.concurrent.Future;
22 import org.junit.Assert;
23 import org.junit.Before;
24 import org.junit.Test;
25 import org.junit.runner.RunWith;
26 import org.mockito.ArgumentCaptor;
27 import org.mockito.Captor;
28 import org.mockito.Matchers;
29 import org.mockito.Mock;
30 import org.mockito.Mockito;
31 import org.mockito.invocation.InvocationOnMock;
32 import org.mockito.runners.MockitoJUnitRunner;
33 import org.mockito.stubbing.Answer;
34 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
35 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
36 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
37 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
38 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
39 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
42 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
43 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
44 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
45 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
46 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
47 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
48 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
49 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
50 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
51 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
52 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
53 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
54 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
55 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
56 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
57 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInputBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
71 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
72 import org.opendaylight.yangtools.yang.common.RpcResult;
73 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
74 import org.slf4j.Logger;
75 import org.slf4j.LoggerFactory;
76 import io.netty.util.HashedWheelTimer;
77 import io.netty.util.Timeout;
80 @RunWith(MockitoJUnitRunner.class)
81 public class StatisticsManagerImplTest {
83 private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImplTest.class);
85 public static final NodeId NODE_ID = new NodeId("ofp-unit-dummy-node-id");
88 RequestContextStack mockedRequestContextStack;
90 ConnectionContext mockedPrimConnectionContext;
92 FeaturesReply mockedFeatures;
94 GetFeaturesOutput mockedFeaturesOutput;
96 ConnectionAdapter mockedConnectionAdapter;
98 MessageSpy mockedMessagSpy;
100 DeviceContext mockedDeviceContext;
102 DeviceState mockedDeviceState;
104 DeviceInfo mockedDeviceInfo;
106 DeviceInitializationPhaseHandler mockedDevicePhaseHandler;
108 DeviceTerminationPhaseHandler mockedTerminationPhaseHandler;
110 private RpcProviderRegistry rpcProviderRegistry;
112 private HashedWheelTimer hashedWheelTimer;
114 private OutboundQueue outboundQueue;
116 private MultiMsgCollector multiMagCollector;
118 private ItemLifeCycleRegistry itemLifeCycleRegistry;
120 private ArgumentCaptor<ItemLifecycleListener> itemLifeCycleListenerCapt;
122 private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
124 private DeviceManager deviceManager;
126 private GetFeaturesOutput featuresOutput;
128 private DeviceInitializationPhaseHandler deviceInitializationPhaseHandler;
130 private DeviceInfo deviceInfo;
132 private DataBroker dataBroker;
134 private LifecycleService lifecycleService;
136 private RequestContext<List<MultipartReply>> currentRequestContext;
137 private StatisticsManagerImpl statisticsManager;
141 public void initialization() {
142 final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
144 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
146 when(mockedPrimConnectionContext.getFeatures()).thenReturn(mockedFeatures);
147 when(mockedPrimConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
148 when(mockedPrimConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.WORKING);
149 when(mockedPrimConnectionContext.getNodeId()).thenReturn(NODE_ID);
150 when(mockedPrimConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueue);
152 when(mockedDeviceState.isFlowStatisticsAvailable()).thenReturn(Boolean.TRUE);
153 when(mockedDeviceState.isGroupAvailable()).thenReturn(Boolean.TRUE);
154 when(mockedDeviceState.isMetersAvailable()).thenReturn(Boolean.TRUE);
155 when(mockedDeviceState.isPortStatisticsAvailable()).thenReturn(Boolean.TRUE);
156 when(mockedDeviceState.isQueueStatisticsAvailable()).thenReturn(Boolean.TRUE);
157 when(mockedDeviceState.isTableStatisticsAvailable()).thenReturn(Boolean.TRUE);
158 when(mockedDeviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
159 when(mockedDeviceInfo.getDatapathId()).thenReturn(BigInteger.TEN);
160 when(mockedDeviceInfo.getNodeId()).thenReturn(NODE_ID);
162 when(mockedDeviceContext.getDeviceInfo()).thenReturn(mockedDeviceInfo);
163 when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimConnectionContext);
164 when(mockedDeviceContext.getMessageSpy()).thenReturn(mockedMessagSpy);
165 when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(new DeviceFlowRegistryImpl(dataBroker, nodePath));
166 when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
167 when(mockedDeviceContext.getMultiMsgCollector(
168 Matchers.<RequestContext<List<MultipartReply>>>any())).thenAnswer(
169 new Answer<MultiMsgCollector>() {
171 public MultiMsgCollector answer(InvocationOnMock invocation) throws Throwable {
172 currentRequestContext = (RequestContext<List<MultipartReply>>) invocation.getArguments()[0];
173 return multiMagCollector;
177 when(mockedDeviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
178 when(rpcProviderRegistry.addRpcImplementation(
179 Matchers.eq(StatisticsManagerControlService.class),
180 Matchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
182 final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
183 final long basicTimerDelay = 3000L;
184 final long maximumTimerDelay = 900000L;
185 statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, false, new HashedWheelTimer(),
186 convertorManager, basicTimerDelay, maximumTimerDelay);
187 statisticsManager.setDeviceInitializationPhaseHandler(deviceInitializationPhaseHandler);
191 public void testOnDeviceContextLevelUp() throws Exception {
192 Mockito.doAnswer(new Answer<Void>() {
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());
201 }).when(outboundQueue)
202 .commitEntry(Matchers.anyLong(), Matchers.<OfHeader>any(), Matchers.<FutureCallback<OfHeader>>any());
204 Mockito.when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
205 Mockito.when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
207 statisticsManager.setDeviceInitializationPhaseHandler(mockedDevicePhaseHandler);
208 statisticsManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
209 verify(mockedDevicePhaseHandler).onDeviceContextLevelUp(deviceInfo, lifecycleService);
213 public void testOnDeviceContextClosed() throws Exception {
214 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
215 final Map<DeviceInfo, StatisticsContext> contextsMap = getContextsMap(statisticsManager);
217 contextsMap.put(deviceInfo, statisticContext);
218 Assert.assertEquals(1, contextsMap.size());
220 statisticsManager.setDeviceTerminationPhaseHandler(mockedTerminationPhaseHandler);
221 statisticsManager.onDeviceContextLevelDown(deviceInfo);
222 verify(statisticContext).close();
223 verify(mockedTerminationPhaseHandler).onDeviceContextLevelDown(deviceInfo);
224 Assert.assertEquals(1, contextsMap.size());
227 private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
228 throws NoSuchFieldException, IllegalAccessException {
229 // HACK: contexts map for testing shall be accessed in some more civilized way
230 final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
231 Assert.assertNotNull(contextsField);
232 contextsField.setAccessible(true);
233 return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
237 public void testGetStatisticsWorkMode() throws Exception {
238 final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode();
239 Assert.assertTrue(workMode.isDone());
240 Assert.assertTrue(workMode.get().isSuccessful());
241 Assert.assertNotNull(workMode.get().getResult());
242 Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
246 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry
251 public void testChangeStatisticsWorkMode1() throws Exception {
252 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
253 when(statisticContext.getPollTimeout()).thenReturn(
254 Optional.<Timeout>empty());
255 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
256 Collections.<ItemLifeCycleSource>emptyList());
258 when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
259 when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
260 when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
262 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
264 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
265 new ChangeStatisticsWorkModeInputBuilder()
266 .setMode(StatisticsWorkMode.FULLYDISABLED);
268 final Future<RpcResult<Void>> workMode = statisticsManager
269 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
271 checkWorkModeChangeOutcome(workMode);
272 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
273 Mockito.verify(statisticContext).getPollTimeout();
276 private static void checkWorkModeChangeOutcome(Future<RpcResult<Void>> workMode) throws InterruptedException, ExecutionException {
277 Assert.assertTrue(workMode.isDone());
278 Assert.assertTrue(workMode.get().isSuccessful());
283 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry
288 public void testChangeStatisticsWorkMode2() throws Exception {
289 final Timeout pollTimeout = Mockito.mock(Timeout.class);
290 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
291 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
292 when(statisticContext.getPollTimeout()).thenReturn(
293 Optional.of(pollTimeout));
294 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
295 Collections.singletonList(itemLifecycleSource));
297 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
299 when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
300 when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
301 when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
303 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
304 new ChangeStatisticsWorkModeInputBuilder()
305 .setMode(StatisticsWorkMode.FULLYDISABLED);
307 Future<RpcResult<Void>> workMode = statisticsManager.changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
308 checkWorkModeChangeOutcome(workMode);
310 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
311 Mockito.verify(statisticContext).getPollTimeout();
312 Mockito.verify(pollTimeout).cancel();
313 Mockito.verify(itemLifecycleSource).setItemLifecycleListener(Matchers.<ItemLifecycleListener>any());
317 * switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
318 * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout
323 public void testChangeStatisticsWorkMode3() throws Exception {
324 final Timeout pollTimeout = Mockito.mock(Timeout.class);
325 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
326 Mockito.doNothing().when(itemLifecycleSource)
327 .setItemLifecycleListener(itemLifeCycleListenerCapt.capture());
329 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
330 when(statisticContext.getPollTimeout()).thenReturn(
331 Optional.of(pollTimeout));
332 when(statisticContext.getItemLifeCycleListener()).thenReturn(
333 Mockito.mock(ItemLifecycleListener.class));
334 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
335 Collections.singletonList(itemLifecycleSource));
337 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
339 when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
340 when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
341 when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
343 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
344 new ChangeStatisticsWorkModeInputBuilder()
345 .setMode(StatisticsWorkMode.FULLYDISABLED);
347 Future<RpcResult<Void>> workMode;
348 workMode = statisticsManager.changeStatisticsWorkMode(
349 changeStatisticsWorkModeInputBld.build());
350 checkWorkModeChangeOutcome(workMode);
352 changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
353 workMode = statisticsManager.changeStatisticsWorkMode(
354 changeStatisticsWorkModeInputBld.build());
355 checkWorkModeChangeOutcome(workMode);
357 Mockito.verify(itemLifeCycleRegistry, Mockito.times(2)).getLifeCycleSources();
358 Mockito.verify(statisticContext).getPollTimeout();
359 Mockito.verify(pollTimeout).cancel();
361 final List<ItemLifecycleListener> itemLifeCycleListenerValues = itemLifeCycleListenerCapt.getAllValues();
362 Assert.assertEquals(2, itemLifeCycleListenerValues.size());
363 Assert.assertNotNull(itemLifeCycleListenerValues.get(0));
364 Assert.assertNull(itemLifeCycleListenerValues.get(1));
368 public void testClose() throws Exception {
369 statisticsManager.close();
370 Mockito.verify(serviceControlRegistration).close();
374 public void testCalculateTimerDelay() throws Exception {
375 final TimeCounter timeCounter = Mockito.mock(TimeCounter.class);
376 when(timeCounter.getAverageTimeBetweenMarks()).thenReturn(2000L, (Long)4000L);
377 statisticsManager.calculateTimerDelay(timeCounter);
378 Assert.assertEquals(3000L, StatisticsManagerImpl.getCurrentTimerDelay());
379 statisticsManager.calculateTimerDelay(timeCounter);
380 Assert.assertEquals(6000L, StatisticsManagerImpl.getCurrentTimerDelay());
384 public void testPollStatistics() throws Exception {
385 final StatisticsContext statisticsContext = Mockito.mock(StatisticsContext.class);
386 final TimeCounter mockTimerCounter = Mockito.mock(TimeCounter.class);
388 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
389 verify(mockedDeviceContext).getDeviceState();
391 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
393 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
395 when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateCheckedFuture(Boolean.TRUE));
396 when(statisticsContext.isSchedulingEnabled()).thenReturn(Boolean.TRUE);
397 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
398 Mockito.verify(mockTimerCounter).markStart();
399 Mockito.verify(mockTimerCounter).addTimeMark();
401 when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateFailedFuture(new Throwable("error msg")));
402 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
403 Mockito.verify(mockTimerCounter,times(2)).addTimeMark();