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.times;
11 import static org.mockito.Mockito.verify;
12 import static org.mockito.Mockito.when;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import io.netty.util.HashedWheelTimer;
17 import io.netty.util.Timeout;
18 import java.lang.reflect.Field;
19 import java.math.BigInteger;
20 import java.util.Collections;
21 import java.util.List;
23 import java.util.Optional;
24 import java.util.concurrent.ExecutionException;
25 import java.util.concurrent.Future;
26 import org.junit.Assert;
27 import org.junit.Before;
28 import org.junit.Test;
29 import org.junit.runner.RunWith;
30 import org.mockito.ArgumentCaptor;
31 import org.mockito.Captor;
32 import org.mockito.Matchers;
33 import org.mockito.Mock;
34 import org.mockito.Mockito;
35 import org.mockito.invocation.InvocationOnMock;
36 import org.mockito.runners.MockitoJUnitRunner;
37 import org.mockito.stubbing.Answer;
38 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
39 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
40 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
41 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
42 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
43 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
45 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
46 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
47 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
48 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
49 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
50 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
51 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
52 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
53 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
54 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
55 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
56 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
57 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
58 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
59 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
60 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
61 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInputBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
75 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
76 import org.opendaylight.yangtools.yang.common.RpcResult;
77 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
78 import org.slf4j.Logger;
79 import org.slf4j.LoggerFactory;
82 @RunWith(MockitoJUnitRunner.class)
83 public class StatisticsManagerImplTest {
85 private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImplTest.class);
87 public static final NodeId NODE_ID = new NodeId("ofp-unit-dummy-node-id");
90 RequestContextStack mockedRequestContextStack;
92 ConnectionContext mockedPrimConnectionContext;
94 FeaturesReply mockedFeatures;
96 GetFeaturesOutput mockedFeaturesOutput;
98 ConnectionAdapter mockedConnectionAdapter;
100 MessageSpy mockedMessagSpy;
102 DeviceContext mockedDeviceContext;
104 DeviceState mockedDeviceState;
106 DeviceInfo mockedDeviceInfo;
108 DeviceInitializationPhaseHandler mockedDevicePhaseHandler;
110 DeviceTerminationPhaseHandler mockedTerminationPhaseHandler;
112 private RpcProviderRegistry rpcProviderRegistry;
114 private HashedWheelTimer hashedWheelTimer;
116 private OutboundQueue outboundQueue;
118 private MultiMsgCollector multiMagCollector;
120 private ItemLifeCycleRegistry itemLifeCycleRegistry;
122 private ArgumentCaptor<ItemLifecycleListener> itemLifeCycleListenerCapt;
124 private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
126 private DeviceManager deviceManager;
128 private GetFeaturesOutput featuresOutput;
130 private DeviceInitializationPhaseHandler deviceInitializationPhaseHandler;
132 private DeviceInfo deviceInfo;
134 private DataBroker dataBroker;
136 private LifecycleService lifecycleService;
138 private RequestContext<List<MultipartReply>> currentRequestContext;
139 private StatisticsManagerImpl statisticsManager;
143 public void initialization() {
144 final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
146 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
148 when(mockedPrimConnectionContext.getFeatures()).thenReturn(mockedFeatures);
149 when(mockedPrimConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
150 when(mockedPrimConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.WORKING);
151 when(mockedPrimConnectionContext.getNodeId()).thenReturn(NODE_ID);
152 when(mockedPrimConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueue);
154 when(mockedDeviceState.isFlowStatisticsAvailable()).thenReturn(Boolean.TRUE);
155 when(mockedDeviceState.isGroupAvailable()).thenReturn(Boolean.TRUE);
156 when(mockedDeviceState.isMetersAvailable()).thenReturn(Boolean.TRUE);
157 when(mockedDeviceState.isPortStatisticsAvailable()).thenReturn(Boolean.TRUE);
158 when(mockedDeviceState.isQueueStatisticsAvailable()).thenReturn(Boolean.TRUE);
159 when(mockedDeviceState.isTableStatisticsAvailable()).thenReturn(Boolean.TRUE);
160 when(mockedDeviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
161 when(mockedDeviceInfo.getDatapathId()).thenReturn(BigInteger.TEN);
162 when(mockedDeviceInfo.getNodeId()).thenReturn(NODE_ID);
164 when(mockedDeviceContext.getDeviceInfo()).thenReturn(mockedDeviceInfo);
165 when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimConnectionContext);
166 when(mockedDeviceContext.getMessageSpy()).thenReturn(mockedMessagSpy);
167 when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(new DeviceFlowRegistryImpl(dataBroker, nodePath));
168 when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
169 when(mockedDeviceContext.getMultiMsgCollector(
170 Matchers.<RequestContext<List<MultipartReply>>>any())).thenAnswer(
171 new Answer<MultiMsgCollector>() {
173 public MultiMsgCollector answer(InvocationOnMock invocation) throws Throwable {
174 currentRequestContext = (RequestContext<List<MultipartReply>>) invocation.getArguments()[0];
175 return multiMagCollector;
179 when(mockedDeviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
180 when(rpcProviderRegistry.addRpcImplementation(
181 Matchers.eq(StatisticsManagerControlService.class),
182 Matchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
184 final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
185 statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, false, new HashedWheelTimer(), convertorManager);
186 statisticsManager.setDeviceInitializationPhaseHandler(deviceInitializationPhaseHandler);
190 public void testOnDeviceContextLevelUp() throws Exception {
191 Mockito.doAnswer(new Answer<Void>() {
193 public Void answer(InvocationOnMock invocation) throws Throwable {
194 final FutureCallback<OfHeader> callback = (FutureCallback<OfHeader>) invocation.getArguments()[2];
195 LOG.debug("committing entry: {}", ((MultipartRequestInput) invocation.getArguments()[1]).getType());
196 callback.onSuccess(null);
197 currentRequestContext.setResult(RpcResultBuilder.<List<MultipartReply>>success().build());
200 }).when(outboundQueue)
201 .commitEntry(Matchers.anyLong(), Matchers.<OfHeader>any(), Matchers.<FutureCallback<OfHeader>>any());
203 Mockito.when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
204 Mockito.when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
206 statisticsManager.setDeviceInitializationPhaseHandler(mockedDevicePhaseHandler);
207 statisticsManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
208 verify(mockedDevicePhaseHandler).onDeviceContextLevelUp(deviceInfo, lifecycleService);
212 public void testOnDeviceContextClosed() throws Exception {
213 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
214 final Map<DeviceInfo, StatisticsContext> contextsMap = getContextsMap(statisticsManager);
216 contextsMap.put(deviceInfo, statisticContext);
217 Assert.assertEquals(1, contextsMap.size());
219 statisticsManager.setDeviceTerminationPhaseHandler(mockedTerminationPhaseHandler);
220 statisticsManager.onDeviceContextLevelDown(deviceInfo);
221 verify(statisticContext).close();
222 verify(mockedTerminationPhaseHandler).onDeviceContextLevelDown(deviceInfo);
223 Assert.assertEquals(1, contextsMap.size());
226 private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
227 throws NoSuchFieldException, IllegalAccessException {
228 // HACK: contexts map for testing shall be accessed in some more civilized way
229 final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
230 Assert.assertNotNull(contextsField);
231 contextsField.setAccessible(true);
232 return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
236 public void testGetStatisticsWorkMode() throws Exception {
237 final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode();
238 Assert.assertTrue(workMode.isDone());
239 Assert.assertTrue(workMode.get().isSuccessful());
240 Assert.assertNotNull(workMode.get().getResult());
241 Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
245 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry
250 public void testChangeStatisticsWorkMode1() throws Exception {
251 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
252 when(statisticContext.getPollTimeout()).thenReturn(
253 Optional.<Timeout>empty());
254 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
255 Collections.<ItemLifeCycleSource>emptyList());
257 when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
258 when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
259 when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
261 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
263 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
264 new ChangeStatisticsWorkModeInputBuilder()
265 .setMode(StatisticsWorkMode.FULLYDISABLED);
267 final Future<RpcResult<Void>> workMode = statisticsManager
268 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
270 checkWorkModeChangeOutcome(workMode);
271 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
272 Mockito.verify(statisticContext).getPollTimeout();
275 private static void checkWorkModeChangeOutcome(Future<RpcResult<Void>> workMode) throws InterruptedException, ExecutionException {
276 Assert.assertTrue(workMode.isDone());
277 Assert.assertTrue(workMode.get().isSuccessful());
282 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry
287 public void testChangeStatisticsWorkMode2() throws Exception {
288 final Timeout pollTimeout = Mockito.mock(Timeout.class);
289 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
290 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
291 when(statisticContext.getPollTimeout()).thenReturn(
292 Optional.of(pollTimeout));
293 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
294 Collections.singletonList(itemLifecycleSource));
296 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
298 when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
299 when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
300 when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
302 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
303 new ChangeStatisticsWorkModeInputBuilder()
304 .setMode(StatisticsWorkMode.FULLYDISABLED);
306 Future<RpcResult<Void>> workMode = statisticsManager.changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
307 checkWorkModeChangeOutcome(workMode);
309 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
310 Mockito.verify(statisticContext).getPollTimeout();
311 Mockito.verify(pollTimeout).cancel();
312 Mockito.verify(itemLifecycleSource).setItemLifecycleListener(Matchers.<ItemLifecycleListener>any());
316 * switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
317 * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout
322 public void testChangeStatisticsWorkMode3() throws Exception {
323 final Timeout pollTimeout = Mockito.mock(Timeout.class);
324 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
325 Mockito.doNothing().when(itemLifecycleSource)
326 .setItemLifecycleListener(itemLifeCycleListenerCapt.capture());
328 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
329 when(statisticContext.getPollTimeout()).thenReturn(
330 Optional.of(pollTimeout));
331 when(statisticContext.getItemLifeCycleListener()).thenReturn(
332 Mockito.mock(ItemLifecycleListener.class));
333 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
334 Collections.singletonList(itemLifecycleSource));
336 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
338 when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
339 when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
340 when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
342 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
343 new ChangeStatisticsWorkModeInputBuilder()
344 .setMode(StatisticsWorkMode.FULLYDISABLED);
346 Future<RpcResult<Void>> workMode;
347 workMode = statisticsManager.changeStatisticsWorkMode(
348 changeStatisticsWorkModeInputBld.build());
349 checkWorkModeChangeOutcome(workMode);
351 changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
352 workMode = statisticsManager.changeStatisticsWorkMode(
353 changeStatisticsWorkModeInputBld.build());
354 checkWorkModeChangeOutcome(workMode);
356 Mockito.verify(itemLifeCycleRegistry, Mockito.times(2)).getLifeCycleSources();
357 Mockito.verify(statisticContext).getPollTimeout();
358 Mockito.verify(pollTimeout).cancel();
360 final List<ItemLifecycleListener> itemLifeCycleListenerValues = itemLifeCycleListenerCapt.getAllValues();
361 Assert.assertEquals(2, itemLifeCycleListenerValues.size());
362 Assert.assertNotNull(itemLifeCycleListenerValues.get(0));
363 Assert.assertNull(itemLifeCycleListenerValues.get(1));
367 public void testClose() throws Exception {
368 statisticsManager.close();
369 Mockito.verify(serviceControlRegistration).close();
373 public void testCalculateTimerDelay() throws Exception {
374 final TimeCounter timeCounter = Mockito.mock(TimeCounter.class);
375 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();