3 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.openflowplugin.impl.statistics;
11 import static org.mockito.Mockito.times;
12 import static org.mockito.Mockito.verify;
13 import static org.mockito.Mockito.when;
15 import com.google.common.util.concurrent.FutureCallback;
16 import com.google.common.util.concurrent.Futures;
17 import io.netty.util.HashedWheelTimer;
18 import io.netty.util.Timeout;
19 import java.lang.reflect.Field;
20 import java.math.BigInteger;
21 import java.util.Collections;
22 import java.util.List;
24 import java.util.Optional;
25 import java.util.concurrent.ExecutionException;
26 import java.util.concurrent.Future;
27 import org.junit.Assert;
28 import org.junit.Before;
29 import org.junit.Test;
30 import org.junit.runner.RunWith;
31 import org.mockito.ArgumentCaptor;
32 import org.mockito.Captor;
33 import org.mockito.Matchers;
34 import org.mockito.Mock;
35 import org.mockito.Mockito;
36 import org.mockito.invocation.InvocationOnMock;
37 import org.mockito.runners.MockitoJUnitRunner;
38 import org.mockito.stubbing.Answer;
39 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
40 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
41 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
42 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
43 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
44 import org.opendaylight.openflowplugin.api.OFConstants;
45 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
46 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
47 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
48 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
49 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
50 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
51 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
52 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
53 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
54 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
55 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
56 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
57 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
58 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
59 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
60 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
61 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
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 private static final BigInteger DUMMY_DATAPATH_ID = new BigInteger("444");
88 private static final Short DUMMY_VERSION = OFConstants.OFP_VERSION_1_3;
89 public static final NodeId NODE_ID = new NodeId("ofp-unit-dummy-node-id");
92 RequestContextStack mockedRequestContextStack;
94 ConnectionContext mockedPrimConnectionContext;
96 FeaturesReply mockedFeatures;
98 GetFeaturesOutput mockedFeaturesOutput;
100 ConnectionAdapter mockedConnectionAdapter;
102 MessageSpy mockedMessagSpy;
104 DeviceContext mockedDeviceContext;
106 DeviceState mockedDeviceState;
108 DeviceInfo mockedDeviceInfo;
110 DeviceInitializationPhaseHandler mockedDevicePhaseHandler;
112 DeviceTerminationPhaseHandler mockedTerminationPhaseHandler;
114 private RpcProviderRegistry rpcProviderRegistry;
116 private HashedWheelTimer hashedWheelTimer;
118 private OutboundQueue outboundQueue;
120 private MultiMsgCollector multiMagCollector;
122 private ItemLifeCycleRegistry itemLifeCycleRegistry;
124 private ArgumentCaptor<ItemLifecycleListener> itemLifeCycleListenerCapt;
126 private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
128 private DeviceManager deviceManager;
130 private LifecycleConductor conductor;
132 private GetFeaturesOutput featuresOutput;
134 private DeviceInitializationPhaseHandler deviceInitializationPhaseHandler;
136 private DeviceInfo deviceInfo;
138 private DataBroker dataBroker;
140 private RequestContext<List<MultipartReply>> currentRequestContext;
141 private StatisticsManagerImpl statisticsManager;
145 public void initialization() {
146 final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
148 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
150 when(mockedPrimConnectionContext.getFeatures()).thenReturn(mockedFeatures);
151 when(mockedPrimConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
152 when(mockedPrimConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.WORKING);
153 when(mockedPrimConnectionContext.getNodeId()).thenReturn(NODE_ID);
154 when(mockedPrimConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueue);
156 when(mockedDeviceState.isFlowStatisticsAvailable()).thenReturn(Boolean.TRUE);
157 when(mockedDeviceState.isGroupAvailable()).thenReturn(Boolean.TRUE);
158 when(mockedDeviceState.isMetersAvailable()).thenReturn(Boolean.TRUE);
159 when(mockedDeviceState.isPortStatisticsAvailable()).thenReturn(Boolean.TRUE);
160 when(mockedDeviceState.isQueueStatisticsAvailable()).thenReturn(Boolean.TRUE);
161 when(mockedDeviceState.isTableStatisticsAvailable()).thenReturn(Boolean.TRUE);
162 when(mockedDeviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
163 when(mockedDeviceInfo.getDatapathId()).thenReturn(BigInteger.TEN);
164 when(mockedDeviceInfo.getNodeId()).thenReturn(new NodeId("ofp-unit-dummy-node-id"));
166 when(mockedDeviceContext.getDeviceInfo()).thenReturn(mockedDeviceInfo);
167 when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimConnectionContext);
168 when(mockedDeviceContext.getMessageSpy()).thenReturn(mockedMessagSpy);
169 when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(new DeviceFlowRegistryImpl(dataBroker, nodePath));
170 when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
171 when(mockedDeviceContext.getMultiMsgCollector(
172 Matchers.<RequestContext<List<MultipartReply>>>any())).thenAnswer(
173 new Answer<MultiMsgCollector>() {
175 public MultiMsgCollector answer(InvocationOnMock invocation) throws Throwable {
176 currentRequestContext = (RequestContext<List<MultipartReply>>) invocation.getArguments()[0];
177 return multiMagCollector;
181 when(mockedDeviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
182 when(rpcProviderRegistry.addRpcImplementation(
183 Matchers.eq(StatisticsManagerControlService.class),
184 Matchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
186 statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, false, conductor);
187 statisticsManager.setDeviceInitializationPhaseHandler(deviceInitializationPhaseHandler);
188 when(conductor.getDeviceContext(deviceInfo)).thenReturn(mockedDeviceContext);
192 public void testOnDeviceContextLevelUp() throws Exception {
193 Mockito.doAnswer(new Answer<Void>() {
195 public Void answer(InvocationOnMock invocation) throws Throwable {
196 final FutureCallback<OfHeader> callback = (FutureCallback<OfHeader>) invocation.getArguments()[2];
197 LOG.debug("committing entry: {}", ((MultipartRequestInput) invocation.getArguments()[1]).getType());
198 callback.onSuccess(null);
199 currentRequestContext.setResult(RpcResultBuilder.<List<MultipartReply>>success().build());
202 }).when(outboundQueue)
203 .commitEntry(Matchers.anyLong(), Matchers.<OfHeader>any(), Matchers.<FutureCallback<OfHeader>>any());
205 statisticsManager.setDeviceInitializationPhaseHandler(mockedDevicePhaseHandler);
206 statisticsManager.onDeviceContextLevelUp(deviceInfo);
207 verify(mockedDevicePhaseHandler).onDeviceContextLevelUp(deviceInfo);
211 public void testOnDeviceContextClosed() throws Exception {
212 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
213 final Map<DeviceInfo, StatisticsContext> contextsMap = getContextsMap(statisticsManager);
215 contextsMap.put(deviceInfo, statisticContext);
216 Assert.assertEquals(1, contextsMap.size());
218 statisticsManager.setDeviceTerminationPhaseHandler(mockedTerminationPhaseHandler);
219 statisticsManager.onDeviceContextLevelDown(deviceInfo);
220 verify(statisticContext).close();
221 verify(mockedTerminationPhaseHandler).onDeviceContextLevelDown(deviceInfo);
222 Assert.assertEquals(0, contextsMap.size());
225 private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
226 throws NoSuchFieldException, IllegalAccessException {
227 // HACK: contexts map for testing shall be accessed in some more civilized way
228 final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
229 Assert.assertNotNull(contextsField);
230 contextsField.setAccessible(true);
231 return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
235 public void testGetStatisticsWorkMode() throws Exception {
236 final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode();
237 Assert.assertTrue(workMode.isDone());
238 Assert.assertTrue(workMode.get().isSuccessful());
239 Assert.assertNotNull(workMode.get().getResult());
240 Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
244 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry
249 public void testChangeStatisticsWorkMode1() throws Exception {
250 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
251 when(statisticContext.getPollTimeout()).thenReturn(
252 Optional.<Timeout>empty());
253 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
254 Collections.<ItemLifeCycleSource>emptyList());
256 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
258 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
259 new ChangeStatisticsWorkModeInputBuilder()
260 .setMode(StatisticsWorkMode.FULLYDISABLED);
262 final Future<RpcResult<Void>> workMode = statisticsManager
263 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
265 checkWorkModeChangeOutcome(workMode);
266 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
267 Mockito.verify(statisticContext).getPollTimeout();
270 private static void checkWorkModeChangeOutcome(Future<RpcResult<Void>> workMode) throws InterruptedException, ExecutionException {
271 Assert.assertTrue(workMode.isDone());
272 Assert.assertTrue(workMode.get().isSuccessful());
277 * switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry
282 public void testChangeStatisticsWorkMode2() throws Exception {
283 final Timeout pollTimeout = Mockito.mock(Timeout.class);
284 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
285 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
286 when(statisticContext.getPollTimeout()).thenReturn(
287 Optional.of(pollTimeout));
288 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
289 Collections.singletonList(itemLifecycleSource));
291 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
293 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
294 new ChangeStatisticsWorkModeInputBuilder()
295 .setMode(StatisticsWorkMode.FULLYDISABLED);
297 Future<RpcResult<Void>> workMode = statisticsManager.changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
298 checkWorkModeChangeOutcome(workMode);
300 Mockito.verify(itemLifeCycleRegistry).getLifeCycleSources();
301 Mockito.verify(statisticContext).getPollTimeout();
302 Mockito.verify(pollTimeout).cancel();
303 Mockito.verify(itemLifecycleSource).setItemLifecycleListener(Matchers.<ItemLifecycleListener>any());
307 * switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
308 * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout
313 public void testChangeStatisticsWorkMode3() throws Exception {
314 final Timeout pollTimeout = Mockito.mock(Timeout.class);
315 final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
316 Mockito.doNothing().when(itemLifecycleSource)
317 .setItemLifecycleListener(itemLifeCycleListenerCapt.capture());
319 final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
320 when(statisticContext.getPollTimeout()).thenReturn(
321 Optional.of(pollTimeout));
322 when(statisticContext.getItemLifeCycleListener()).thenReturn(
323 Mockito.mock(ItemLifecycleListener.class));
324 when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
325 Collections.singletonList(itemLifecycleSource));
327 getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
329 final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
330 new ChangeStatisticsWorkModeInputBuilder()
331 .setMode(StatisticsWorkMode.FULLYDISABLED);
333 Future<RpcResult<Void>> workMode;
334 workMode = statisticsManager.changeStatisticsWorkMode(
335 changeStatisticsWorkModeInputBld.build());
336 checkWorkModeChangeOutcome(workMode);
338 changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
339 workMode = statisticsManager.changeStatisticsWorkMode(
340 changeStatisticsWorkModeInputBld.build());
341 checkWorkModeChangeOutcome(workMode);
343 Mockito.verify(itemLifeCycleRegistry, Mockito.times(2)).getLifeCycleSources();
344 Mockito.verify(statisticContext).getPollTimeout();
345 Mockito.verify(pollTimeout).cancel();
347 final List<ItemLifecycleListener> itemLifeCycleListenerValues = itemLifeCycleListenerCapt.getAllValues();
348 Assert.assertEquals(2, itemLifeCycleListenerValues.size());
349 Assert.assertNotNull(itemLifeCycleListenerValues.get(0));
350 Assert.assertNull(itemLifeCycleListenerValues.get(1));
354 public void testClose() throws Exception {
355 statisticsManager.close();
356 Mockito.verify(serviceControlRegistration).close();
360 public void testCalculateTimerDelay() throws Exception {
361 final TimeCounter timeCounter = Mockito.mock(TimeCounter.class);
362 when(timeCounter.getAverageTimeBetweenMarks()).thenReturn(2000L, (Long)4000L);
364 statisticsManager.calculateTimerDelay(timeCounter);
365 Assert.assertEquals(3000L, StatisticsManagerImpl.getCurrentTimerDelay());
366 statisticsManager.calculateTimerDelay(timeCounter);
367 Assert.assertEquals(6000L, StatisticsManagerImpl.getCurrentTimerDelay());
371 public void testPollStatistics() throws Exception {
372 final StatisticsContext statisticsContext = Mockito.mock(StatisticsContext.class);
373 final TimeCounter mockTimerCounter = Mockito.mock(TimeCounter.class);
375 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
376 verify(mockedDeviceContext).getDeviceState();
378 when(mockedDeviceContext.getDeviceState().isValid()).thenReturn(true);
379 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
381 when(mockedDeviceContext.getDeviceState().isStatisticsPollingEnabled()).thenReturn(true);
382 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
384 when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateCheckedFuture(Boolean.TRUE));
385 when(statisticsContext.isSchedulingEnabled()).thenReturn(Boolean.TRUE);
386 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
387 Mockito.verify(mockTimerCounter).markStart();
388 Mockito.verify(mockTimerCounter).addTimeMark();
390 when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateFailedFuture(new Throwable("error msg")));
391 statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
392 Mockito.verify(mockTimerCounter,times(2)).addTimeMark();