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.sal.binding.api.BindingAwareBroker;
39 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
40 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
41 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
42 import org.opendaylight.openflowplugin.api.OFConstants;
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.LifecycleConductor;
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.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInputBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
73 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
74 import org.opendaylight.yangtools.yang.common.RpcResult;
75 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
76 import org.slf4j.Logger;
77 import org.slf4j.LoggerFactory;
80 @RunWith(MockitoJUnitRunner.class)
81 public class StatisticsManagerImplTest {
83 private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImplTest.class);
85 private static final BigInteger DUMMY_DATAPATH_ID = new BigInteger("444");
86 private static final Short DUMMY_VERSION = OFConstants.OFP_VERSION_1_3;
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 LifecycleConductor conductor;
130 private GetFeaturesOutput featuresOutput;
132 private DeviceInitializationPhaseHandler deviceInitializationPhaseHandler;
134 private DeviceInfo deviceInfo;
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(new NodeId("ofp-unit-dummy-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());
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 statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, false, conductor);
183 statisticsManager.setDeviceInitializationPhaseHandler(deviceInitializationPhaseHandler);
184 when(conductor.getDeviceContext(deviceInfo)).thenReturn(mockedDeviceContext);
188 public void testOnDeviceContextLevelUp() throws Exception {
189 Mockito.doAnswer(new Answer<Void>() {
191 public Void answer(InvocationOnMock invocation) throws Throwable {
192 final FutureCallback<OfHeader> callback = (FutureCallback<OfHeader>) invocation.getArguments()[2];
193 LOG.debug("committing entry: {}", ((MultipartRequestInput) invocation.getArguments()[1]).getType());
194 callback.onSuccess(null);
195 currentRequestContext.setResult(RpcResultBuilder.<List<MultipartReply>>success().build());
198 }).when(outboundQueue)
199 .commitEntry(Matchers.anyLong(), Matchers.<OfHeader>any(), Matchers.<FutureCallback<OfHeader>>any());
201 statisticsManager.setDeviceInitializationPhaseHandler(mockedDevicePhaseHandler);
202 statisticsManager.onDeviceContextLevelUp(deviceInfo);
203 verify(mockedDevicePhaseHandler).onDeviceContextLevelUp(deviceInfo);
207 public void testOnDeviceContextClosed() throws Exception {
208 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
209 final Map<DeviceInfo, StatisticsContext> contextsMap = getContextsMap(statisticsManager);
211 contextsMap.put(deviceInfo, statisticContext);
212 Assert.assertEquals(1, contextsMap.size());
214 statisticsManager.setDeviceTerminationPhaseHandler(mockedTerminationPhaseHandler);
215 statisticsManager.onDeviceContextLevelDown(deviceInfo);
216 verify(statisticContext).close();
217 verify(mockedTerminationPhaseHandler).onDeviceContextLevelDown(deviceInfo);
218 Assert.assertEquals(0, contextsMap.size());
221 private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
222 throws NoSuchFieldException, IllegalAccessException {
223 // HACK: contexts map for testing shall be accessed in some more civilized way
224 final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
225 Assert.assertNotNull(contextsField);
226 contextsField.setAccessible(true);
227 return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
231 public void testGetStatisticsWorkMode() throws Exception {
232 final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode();
233 Assert.assertTrue(workMode.isDone());
234 Assert.assertTrue(workMode.get().isSuccessful());
235 Assert.assertNotNull(workMode.get().getResult());
236 Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
240 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry
245 public void testChangeStatisticsWorkMode1() throws Exception {
246 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
247 when(statisticContext.getPollTimeout()).thenReturn(
248 Optional.<Timeout>empty());
249 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
250 Collections.<ItemLifeCycleSource>emptyList());
252 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
254 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
255 new ChangeStatisticsWorkModeInputBuilder()
256 .setMode(StatisticsWorkMode.FULLYDISABLED);
258 final Future<RpcResult<Void>> workMode = statisticsManager
259 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
261 checkWorkModeChangeOutcome(workMode);
262 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
263 Mockito.verify(statisticContext).getPollTimeout();
266 private static void checkWorkModeChangeOutcome(Future<RpcResult<Void>> workMode) throws InterruptedException, ExecutionException {
267 Assert.assertTrue(workMode.isDone());
268 Assert.assertTrue(workMode.get().isSuccessful());
273 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry
278 public void testChangeStatisticsWorkMode2() throws Exception {
279 final Timeout pollTimeout = Mockito.mock(Timeout.class);
280 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
281 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
282 when(statisticContext.getPollTimeout()).thenReturn(
283 Optional.of(pollTimeout));
284 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
285 Collections.singletonList(itemLifecycleSource));
287 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
289 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
290 new ChangeStatisticsWorkModeInputBuilder()
291 .setMode(StatisticsWorkMode.FULLYDISABLED);
293 Future<RpcResult<Void>> workMode = statisticsManager.changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
294 checkWorkModeChangeOutcome(workMode);
296 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
297 Mockito.verify(statisticContext).getPollTimeout();
298 Mockito.verify(pollTimeout).cancel();
299 Mockito.verify(itemLifecycleSource).setItemLifecycleListener(Matchers.<ItemLifecycleListener>any());
303 * switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
304 * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout
309 public void testChangeStatisticsWorkMode3() throws Exception {
310 final Timeout pollTimeout = Mockito.mock(Timeout.class);
311 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
312 Mockito.doNothing().when(itemLifecycleSource)
313 .setItemLifecycleListener(itemLifeCycleListenerCapt.capture());
315 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
316 when(statisticContext.getPollTimeout()).thenReturn(
317 Optional.of(pollTimeout));
318 when(statisticContext.getItemLifeCycleListener()).thenReturn(
319 Mockito.mock(ItemLifecycleListener.class));
320 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
321 Collections.singletonList(itemLifecycleSource));
323 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
325 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
326 new ChangeStatisticsWorkModeInputBuilder()
327 .setMode(StatisticsWorkMode.FULLYDISABLED);
329 Future<RpcResult<Void>> workMode;
330 workMode = statisticsManager.changeStatisticsWorkMode(
331 changeStatisticsWorkModeInputBld.build());
332 checkWorkModeChangeOutcome(workMode);
334 changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
335 workMode = statisticsManager.changeStatisticsWorkMode(
336 changeStatisticsWorkModeInputBld.build());
337 checkWorkModeChangeOutcome(workMode);
339 Mockito.verify(itemLifeCycleRegistry, Mockito.times(2)).getLifeCycleSources();
340 Mockito.verify(statisticContext).getPollTimeout();
341 Mockito.verify(pollTimeout).cancel();
343 final List<ItemLifecycleListener> itemLifeCycleListenerValues = itemLifeCycleListenerCapt.getAllValues();
344 Assert.assertEquals(2, itemLifeCycleListenerValues.size());
345 Assert.assertNotNull(itemLifeCycleListenerValues.get(0));
346 Assert.assertNull(itemLifeCycleListenerValues.get(1));
350 public void testClose() throws Exception {
351 statisticsManager.close();
352 Mockito.verify(serviceControlRegistration).close();
356 public void testCalculateTimerDelay() throws Exception {
357 final TimeCounter timeCounter = Mockito.mock(TimeCounter.class);
358 when(timeCounter.getAverageTimeBetweenMarks()).thenReturn(2000L, (Long)4000L);
360 statisticsManager.calculateTimerDelay(timeCounter);
361 Assert.assertEquals(3000L, StatisticsManagerImpl.getCurrentTimerDelay());
362 statisticsManager.calculateTimerDelay(timeCounter);
363 Assert.assertEquals(6000L, StatisticsManagerImpl.getCurrentTimerDelay());
367 public void testPollStatistics() throws Exception {
368 final StatisticsContext statisticsContext = Mockito.mock(StatisticsContext.class);
369 final TimeCounter mockTimerCounter = Mockito.mock(TimeCounter.class);
371 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
372 verify(mockedDeviceContext).getDeviceState();
374 when(mockedDeviceContext.getDeviceState().isValid()).thenReturn(true);
375 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
377 when(mockedDeviceContext.getDeviceState().isStatisticsPollingEnabled()).thenReturn(true);
378 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
380 when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateCheckedFuture(Boolean.TRUE));
381 when(statisticsContext.isSchedulingEnabled()).thenReturn(Boolean.TRUE);
382 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
383 Mockito.verify(mockTimerCounter).markStart();
384 Mockito.verify(mockTimerCounter).addTimeMark();
386 when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateFailedFuture(new Throwable("error msg")));
387 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
388 Mockito.verify(mockTimerCounter,times(2)).addTimeMark();