Modernize codebase
[openflowplugin.git] / openflowplugin-impl / src / test / java / org / opendaylight / openflowplugin / impl / statistics / StatisticsGatheringUtilsTest.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.openflowplugin.impl.statistics;
9
10 import static org.mockito.ArgumentMatchers.any;
11 import static org.mockito.ArgumentMatchers.eq;
12 import static org.mockito.Mockito.doReturn;
13 import static org.mockito.Mockito.verify;
14 import static org.mockito.Mockito.when;
15
16 import com.google.common.util.concurrent.Futures;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import com.google.common.util.concurrent.MoreExecutors;
19 import java.util.List;
20 import java.util.Optional;
21 import java.util.concurrent.ExecutionException;
22 import java.util.concurrent.TimeUnit;
23 import java.util.concurrent.TimeoutException;
24 import org.junit.Assert;
25 import org.junit.Before;
26 import org.junit.Test;
27 import org.junit.runner.RunWith;
28 import org.mockito.ArgumentCaptor;
29 import org.mockito.ArgumentMatchers;
30 import org.mockito.InOrder;
31 import org.mockito.Mock;
32 import org.mockito.Mockito;
33 import org.mockito.junit.MockitoJUnitRunner;
34 import org.opendaylight.mdsal.binding.api.ReadTransaction;
35 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
36 import org.opendaylight.openflowplugin.api.OFConstants;
37 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
38 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
39 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
41 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
42 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
43 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
44 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
45 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
46 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.EventIdentifier;
47 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.StatisticsGatherer;
48 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
49 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProviderFactory;
50 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.FlowsStatisticsUpdate;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.FlowsStatisticsUpdateBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.and.statistics.map.list.FlowAndStatisticsMapListBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.flow.table.statistics.FlowTableStatistics;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.Queue;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.QueueKey;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.queue.rev130925.QueueId;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupStatistics;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.statistics.GroupStatistics;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterStatistics;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.node.meter.statistics.MeterStatistics;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModFlags;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupId;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupType;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterFlags;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterId;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping.BucketsListBuilder;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.MultipartReplyBody;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCaseBuilder;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupCaseBuilder;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupDescCaseBuilder;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterCaseBuilder;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterConfigCaseBuilder;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortStatsCaseBuilder;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyQueueCaseBuilder;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableCaseBuilder;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.MultipartReplyFlowBuilder;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStatsBuilder;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.MultipartReplyGroupBuilder;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.multipart.reply.group.GroupStatsBuilder;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.multipart.reply.group.group.stats.BucketStats;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.multipart.reply.group.group.stats.BucketStatsBuilder;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.desc._case.MultipartReplyGroupDescBuilder;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.desc._case.multipart.reply.group.desc.GroupDescBuilder;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.MultipartReplyMeterBuilder;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.multipart.reply.meter.MeterStatsBuilder;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.multipart.reply.meter.meter.stats.MeterBandStatsBuilder;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.MultipartReplyMeterConfigBuilder;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.multipart.reply.meter.config.MeterConfigBuilder;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.MultipartReplyPortStatsBuilder;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats.PortStatsBuilder;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.MultipartReplyQueueBuilder;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStatsBuilder;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.MultipartReplyTableBuilder;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStatsBuilder;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.flow.capable.node.connector.statistics.FlowCapableNodeConnectorStatistics;
128 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
129 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
130 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
131 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
132 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
133 import org.opendaylight.yangtools.yang.common.Uint32;
134 import org.opendaylight.yangtools.yang.common.Uint64;
135 import org.opendaylight.yangtools.yang.common.Uint8;
136
137 @RunWith(MockitoJUnitRunner.class)
138 public class StatisticsGatheringUtilsTest {
139
140     static final String DUMMY_NODE_ID_VALUE = "1";
141     static final NodeId DUMMY_NODE_ID = new NodeId(DUMMY_NODE_ID_VALUE);
142
143     private final KeyedInstanceIdentifier<Node, NodeKey> dummyNodePath = InstanceIdentifier.create(Nodes.class)
144             .child(Node.class, new NodeKey(DUMMY_NODE_ID));
145     @Mock
146     private DeviceContext deviceContext;
147     @Mock
148     private DeviceState deviceState;
149     @Mock
150     private DeviceFlowRegistry deviceFlowRegistry;
151     @Mock
152     private DeviceGroupRegistry deviceGroupRegistry;
153     @Mock
154     private DeviceMeterRegistry deviceMeterRegistry;
155     @Mock
156     private FlowDescriptor flowDescriptor;
157     @Mock
158     private FlowId flowId;
159     @Mock
160     private GetFeaturesOutput features;
161     @Mock
162     private ReadTransaction readTx;
163     @Mock
164     private ConnectionContext connectionAdapter;
165     @Mock
166     private StatisticsGatherer<MultipartReply> statisticsService;
167     @Mock
168     private DeviceInfo deviceInfo;
169
170     private MultipartWriterProvider provider;
171
172     @Before
173     public void setUp() {
174         when(deviceContext.getDeviceInfo()).thenReturn(deviceInfo);
175         when(deviceContext.getDeviceFlowRegistry()).thenReturn(deviceFlowRegistry);
176         when(deviceContext.getDeviceGroupRegistry()).thenReturn(deviceGroupRegistry);
177         when(deviceContext.getDeviceMeterRegistry()).thenReturn(deviceMeterRegistry);
178         when(deviceFlowRegistry.retrieveDescriptor(any(FlowRegistryKey.class))).thenReturn(flowDescriptor);
179         when(flowDescriptor.getFlowId()).thenReturn(new FlowId("MOCK_FLOW"));
180         when(deviceContext.getReadTransaction()).thenReturn(readTx);
181         when(deviceContext.getReadTransaction()).thenReturn(readTx);
182         when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionAdapter);
183         when(deviceContext.isTransactionsEnabled()).thenReturn(Boolean.TRUE);
184         when(connectionAdapter.getFeatures()).thenReturn(features);
185         when(features.getDatapathId()).thenReturn(Uint64.ONE);
186         when(features.getVersion()).thenReturn(OFConstants.OFP_VERSION_1_3);
187         when(deviceInfo.getVersion()).thenReturn(OFConstants.OFP_VERSION_1_3);
188         when(deviceInfo.getDatapathId()).thenReturn(Uint64.ONE);
189         when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(dummyNodePath);
190         when(deviceInfo.getNodeId()).thenReturn(DUMMY_NODE_ID);
191         provider = MultipartWriterProviderFactory.createDefaultProvider(deviceContext);
192     }
193
194     @Test
195     public void testWriteFlowStatistics() {
196         final ArgumentCaptor<LogicalDatastoreType> dataStoreType = ArgumentCaptor.forClass(LogicalDatastoreType.class);
197         final ArgumentCaptor<InstanceIdentifier> flowPath = ArgumentCaptor.forClass(InstanceIdentifier.class);
198         final ArgumentCaptor<Flow> flow = ArgumentCaptor.forClass(Flow.class);
199
200         provider.lookup(MultipartType.OFPMPFLOW).orElseThrow().write(prepareFlowStatisticsData().iterator().next(),
201             false);
202
203         Mockito.verify(deviceContext).writeToTransaction(
204                 dataStoreType.capture(), flowPath.capture(), flow.capture());
205         Assert.assertEquals(LogicalDatastoreType.OPERATIONAL, dataStoreType.getValue());
206         final InstanceIdentifier<FlowCapableNode> flowCapableNodePath = flowPath.getValue();
207         Assert.assertEquals(DUMMY_NODE_ID, flowCapableNodePath.firstKeyOf(Node.class).getId());
208         Assert.assertEquals(42, flow.getValue().getTableId().intValue());
209     }
210
211     private static Iterable<FlowsStatisticsUpdate> prepareFlowStatisticsData() {
212         final FlowAndStatisticsMapListBuilder flowAndStatsMapListBld = new FlowAndStatisticsMapListBuilder();
213         flowAndStatsMapListBld.setTableId(Uint8.valueOf(42));
214         flowAndStatsMapListBld.setMatch(new MatchBuilder().build());
215
216         final FlowsStatisticsUpdateBuilder flowStatsUpdateBld1 = new FlowsStatisticsUpdateBuilder();
217         flowStatsUpdateBld1.setFlowAndStatisticsMapList(List.of(flowAndStatsMapListBld.build()));
218
219         return List.of(flowStatsUpdateBld1.build());
220     }
221
222     @Test
223     public void testGatherStatistics_group() throws Exception {
224         final MultipartType type = MultipartType.OFPMPGROUP;
225         final Uint32 groupIdValue = Uint32.valueOf(19);
226
227         final GroupStatsBuilder groupStatsBld = new GroupStatsBuilder()
228                 .setBucketStats(List.of(createBucketStat(21L, 42L)))
229                 .setByteCount(Uint64.valueOf(84))
230                 .setPacketCount(Uint64.valueOf(63))
231                 .setDurationSec(Uint32.valueOf(11))
232                 .setDurationNsec(Uint32.valueOf(12))
233                 .setRefCount(Uint32.valueOf(13))
234                 .setGroupId(new GroupId(groupIdValue));
235         final MultipartReplyGroupBuilder mpReplyGroupBld = new MultipartReplyGroupBuilder();
236         mpReplyGroupBld.setGroupStats(List.of(groupStatsBld.build()));
237         final MultipartReplyGroupCaseBuilder mpReplyGroupCaseBld = new MultipartReplyGroupCaseBuilder();
238         mpReplyGroupCaseBld.setMultipartReplyGroup(mpReplyGroupBld.build());
239
240         final MultipartReply groupStatsUpdated = assembleMPReplyMessage(type, mpReplyGroupCaseBld.build());
241         final List<MultipartReply> statsData = List.of(groupStatsUpdated);
242
243         fireAndCheck(type, statsData);
244
245         final InstanceIdentifier<GroupStatistics> groupPath = dummyNodePath.augmentation(FlowCapableNode.class)
246                 .child(Group.class, new GroupKey(new org.opendaylight.yang.gen.v1.urn
247                         .opendaylight.group.types.rev131018.GroupId(groupIdValue)))
248                 .augmentation(NodeGroupStatistics.class)
249                 .child(GroupStatistics.class);
250         verify(deviceContext).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL),
251                 eq(groupPath), any(GroupStatistics.class));
252     }
253
254     @Test
255     public void testGatherStatistics_groupDesc() throws Exception {
256         final MultipartType type = MultipartType.OFPMPGROUPDESC;
257         final Uint32 groupIdValue = Uint32.valueOf(27);
258
259         final BucketsListBuilder bucketsListBld = new BucketsListBuilder()
260                 .setWatchPort(new PortNumber(Uint32.valueOf(5)));
261         final GroupDescBuilder groupStatsBld = new GroupDescBuilder()
262                 .setBucketsList(List.of(bucketsListBld.build()))
263                 .setGroupId(new GroupId(groupIdValue))
264                 .setType(GroupType.OFPGTALL);
265         final MultipartReplyGroupDescBuilder mpReplyGroupBld = new MultipartReplyGroupDescBuilder();
266         mpReplyGroupBld.setGroupDesc(List.of(groupStatsBld.build()));
267         final MultipartReplyGroupDescCaseBuilder mpReplyGroupCaseBld = new MultipartReplyGroupDescCaseBuilder();
268         mpReplyGroupCaseBld.setMultipartReplyGroupDesc(mpReplyGroupBld.build());
269
270         final MultipartReply groupStatsUpdated = assembleMPReplyMessage(type, mpReplyGroupCaseBld.build());
271         final List<MultipartReply> statsData = List.of(groupStatsUpdated);
272
273         fireAndCheck(type, statsData);
274
275         final org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId storedGroupId =
276                 new org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId(groupIdValue);
277         final KeyedInstanceIdentifier<Group, GroupKey> groupPath =
278                 dummyNodePath.augmentation(FlowCapableNode.class).child(Group.class, new GroupKey(storedGroupId));
279
280         verify(deviceContext, Mockito.never()).addDeleteToTxChain(eq(LogicalDatastoreType.OPERATIONAL),
281                 ArgumentMatchers.<InstanceIdentifier<?>>any());
282         verify(deviceGroupRegistry).store(storedGroupId);
283         verify(deviceContext).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL),
284                                                  eq(groupPath), any(Group.class));
285     }
286
287     @Test
288     public void testGatherStatistics_meter() throws Exception {
289         final MultipartType type = MultipartType.OFPMPMETER;
290         final Uint32 meterIdValue = Uint32.valueOf(19);
291
292         final MeterBandStatsBuilder meterBandStatsBld = new MeterBandStatsBuilder()
293                 .setByteBandCount(Uint64.valueOf(91))
294                 .setPacketBandCount(Uint64.valueOf(92));
295         final MeterStatsBuilder meterStatsBld = new MeterStatsBuilder()
296                 .setMeterId(new MeterId(meterIdValue))
297                 .setByteInCount(Uint64.valueOf(111))
298                 .setDurationSec(Uint32.valueOf(112))
299                 .setDurationNsec(Uint32.valueOf(113))
300                 .setFlowCount(Uint32.valueOf(114))
301                 .setPacketInCount(Uint64.valueOf(115))
302                 .setMeterBandStats(List.of(meterBandStatsBld.build()));
303         final MultipartReplyMeterBuilder mpReplyMeterBld = new MultipartReplyMeterBuilder();
304         mpReplyMeterBld.setMeterStats(List.of(meterStatsBld.build()));
305         final MultipartReplyMeterCaseBuilder mpReplyMeterCaseBld = new MultipartReplyMeterCaseBuilder();
306         mpReplyMeterCaseBld.setMultipartReplyMeter(mpReplyMeterBld.build());
307
308         final MultipartReply meterStatsUpdated = assembleMPReplyMessage(type, mpReplyMeterCaseBld.build());
309         final List<MultipartReply> statsData = List.of(meterStatsUpdated);
310
311         fireAndCheck(type, statsData);
312
313         final InstanceIdentifier<MeterStatistics> meterPath = dummyNodePath.augmentation(FlowCapableNode.class)
314                 .child(Meter.class, new MeterKey(new org.opendaylight.yang.gen.v1.urn
315                         .opendaylight.meter.types.rev130918.MeterId(meterIdValue)))
316                 .augmentation(NodeMeterStatistics.class)
317                 .child(MeterStatistics.class);
318         verify(deviceContext).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL),
319                 eq(meterPath), any(MeterStatistics.class));
320     }
321
322     @Test
323     public void testGatherStatistics_nodeConnector() throws Exception {
324         final MultipartType type = MultipartType.OFPMPPORTSTATS;
325
326         final PortStatsBuilder portStatsBld = new PortStatsBuilder()
327                 .setPortNo(Uint32.valueOf(11));
328         final MultipartReplyPortStatsBuilder mpReplyMeterBld = new MultipartReplyPortStatsBuilder();
329         mpReplyMeterBld.setPortStats(List.of(portStatsBld.build()));
330         final MultipartReplyPortStatsCaseBuilder mpReplyMeterCaseBld = new MultipartReplyPortStatsCaseBuilder();
331         mpReplyMeterCaseBld.setMultipartReplyPortStats(mpReplyMeterBld.build());
332
333         final MultipartReply meterStatsUpdated = assembleMPReplyMessage(type, mpReplyMeterCaseBld.build());
334         final List<MultipartReply> statsData = List.of(meterStatsUpdated);
335
336         fireAndCheck(type, statsData);
337
338         final InstanceIdentifier<FlowCapableNodeConnectorStatistics> portPath = dummyNodePath
339                 .child(NodeConnector.class,
340                         new NodeConnectorKey(new NodeConnectorId("openflow:" + DUMMY_NODE_ID_VALUE + ":11")))
341                 .augmentation(FlowCapableNodeConnectorStatisticsData.class)
342                 .child(FlowCapableNodeConnectorStatistics.class);
343         verify(deviceContext).writeToTransaction(
344                 eq(LogicalDatastoreType.OPERATIONAL),
345                 eq(portPath),
346                 any(FlowCapableNodeConnectorStatistics.class));
347     }
348
349     @Test
350     public void testGatherStatistics_table() throws Exception {
351         final MultipartType type = MultipartType.OFPMPTABLE;
352
353         final TableStatsBuilder tableStatsBld = new TableStatsBuilder()
354                 .setActiveCount(Uint32.valueOf(33))
355                 .setLookupCount(Uint64.valueOf(34))
356                 .setMatchedCount(Uint64.valueOf(35))
357                 .setTableId(Uint8.ZERO);
358         final MultipartReplyTableBuilder mpReplyTableBld = new MultipartReplyTableBuilder();
359         mpReplyTableBld.setTableStats(List.of(tableStatsBld.build()));
360         final MultipartReplyTableCaseBuilder mpReplyTableCaseBld = new MultipartReplyTableCaseBuilder();
361         mpReplyTableCaseBld.setMultipartReplyTable(mpReplyTableBld.build());
362
363         final MultipartReply meterStatsUpdated = assembleMPReplyMessage(type, mpReplyTableCaseBld.build());
364         final List<MultipartReply> statsData = List.of(meterStatsUpdated);
365
366         fireAndCheck(type, statsData);
367
368         final InstanceIdentifier<FlowTableStatistics> tablePath = dummyNodePath
369                 .augmentation(FlowCapableNode.class)
370                 .child(Table.class, new TableKey(Uint8.ZERO))
371                 .augmentation(FlowTableStatisticsData.class)
372                 .child(FlowTableStatistics.class);
373         verify(deviceContext).writeToTransaction(
374                 eq(LogicalDatastoreType.OPERATIONAL),
375                 eq(tablePath),
376                 any(FlowTableStatistics.class));
377     }
378
379     @Test
380     public void testGatherStatistics_queue() throws Exception {
381         final MultipartType type = MultipartType.OFPMPQUEUE;
382
383         final Uint32 queueIdValue = Uint32.valueOf(4);
384         final QueueStatsBuilder queueStatsBld = new QueueStatsBuilder()
385                 .setPortNo(Uint32.valueOf(11))
386                 .setTxBytes(Uint64.valueOf(44))
387                 .setTxErrors(Uint64.valueOf(45))
388                 .setTxPackets(Uint64.valueOf(46))
389                 .setDurationSec(Uint32.valueOf(47))
390                 .setDurationNsec(Uint32.valueOf(48))
391                 .setQueueId(queueIdValue);
392
393         final MultipartReplyQueueBuilder mpReplyQueueBld = new MultipartReplyQueueBuilder();
394         mpReplyQueueBld.setQueueStats(List.of(queueStatsBld.build()));
395         final MultipartReplyQueueCaseBuilder mpReplyQueueCaseBld = new MultipartReplyQueueCaseBuilder();
396         mpReplyQueueCaseBld.setMultipartReplyQueue(mpReplyQueueBld.build());
397
398         final MultipartReply meterStatsUpdated = assembleMPReplyMessage(type, mpReplyQueueCaseBld.build());
399         final List<MultipartReply> statsData = List.of(meterStatsUpdated);
400
401         fireAndCheck(type, statsData);
402
403         final KeyedInstanceIdentifier<Queue, QueueKey> queuePath = dummyNodePath
404                 .child(NodeConnector.class,
405                         new NodeConnectorKey(new NodeConnectorId("openflow:" + DUMMY_NODE_ID_VALUE + ":11")))
406                 .augmentation(FlowCapableNodeConnector.class)
407                 .child(Queue.class, new QueueKey(new QueueId(queueIdValue)));
408         verify(deviceContext).writeToTransaction(
409                 eq(LogicalDatastoreType.OPERATIONAL),
410                 eq(queuePath),
411                 any(Queue.class));
412     }
413
414     @Test
415     public void testGatherStatistics_flow() throws Exception {
416         final MultipartType type = MultipartType.OFPMPFLOW;
417
418         final InstanceIdentifier<FlowCapableNode> nodePath =
419                 deviceInfo.getNodeInstanceIdentifier().augmentation(FlowCapableNode.class);
420         final TableBuilder tableDataBld = new TableBuilder();
421         tableDataBld.setId(Uint8.ZERO);
422         final FlowCapableNodeBuilder flowNodeBuilder = new FlowCapableNodeBuilder();
423         flowNodeBuilder.setTable(BindingMap.of(tableDataBld.build()));
424         final Optional<FlowCapableNode> flowNodeOpt = Optional.of(flowNodeBuilder.build());
425         doReturn(FluentFutures.immediateFluentFuture(flowNodeOpt)).when(readTx)
426             .read(LogicalDatastoreType.OPERATIONAL, nodePath);
427         when(flowDescriptor.getFlowId()).thenReturn(flowId);
428
429         final org.opendaylight.yang.gen.v1.urn
430                 .opendaylight.openflow.oxm.rev150225.match.grouping.MatchBuilder matchBld =
431                 new org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.MatchBuilder()
432                         .setMatchEntry(List.of());
433         final FlowStatsBuilder flowStatsBld = new FlowStatsBuilder()
434                 .setByteCount(Uint64.valueOf(55))
435                 .setPacketCount(Uint64.valueOf(56))
436                 .setDurationSec(Uint32.valueOf(57))
437                 .setDurationNsec(Uint32.valueOf(58L))
438                 .setTableId(Uint8.ZERO)
439                 .setMatch(matchBld.build())
440                 .setFlags(new FlowModFlags(true, false, false, false, true));
441
442         final MultipartReplyFlowBuilder mpReplyFlowBld = new MultipartReplyFlowBuilder();
443         mpReplyFlowBld.setFlowStats(List.of(flowStatsBld.build()));
444         final MultipartReplyFlowCaseBuilder mpReplyFlowCaseBld = new MultipartReplyFlowCaseBuilder();
445         mpReplyFlowCaseBld.setMultipartReplyFlow(mpReplyFlowBld.build());
446
447         final MultipartReply flowStatsUpdated = assembleMPReplyMessage(type, mpReplyFlowCaseBld.build());
448         final List<MultipartReply> statsData = List.of(flowStatsUpdated);
449         fireAndCheck(type, statsData);
450
451         final FlowBuilder flowBld = new FlowBuilder()
452                 .setTableId(Uint8.ZERO)
453                 .setMatch(new MatchBuilder().build());
454         final KeyedInstanceIdentifier<Table, TableKey> tablePath = dummyNodePath.augmentation(FlowCapableNode.class)
455                 .child(Table.class, new TableKey(Uint8.ZERO));
456         final KeyedInstanceIdentifier<Flow, FlowKey> flowPath =  tablePath.child(Flow.class, new FlowKey(flowId));
457
458         verify(deviceContext, Mockito.never()).addDeleteToTxChain(eq(LogicalDatastoreType.OPERATIONAL),
459                 ArgumentMatchers.<InstanceIdentifier<?>>any());
460
461         final InOrder inOrder = Mockito.inOrder(deviceContext);
462         inOrder.verify(deviceContext).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL),
463                                                          any(),
464                                                          any());
465     }
466
467     @Test
468     public void testGatherStatistics_meterConfig() throws Exception {
469         final MultipartType type = MultipartType.OFPMPMETERCONFIG;
470         final Uint32 meterIdValue = Uint32.valueOf(55);
471
472         final MeterConfigBuilder meterConfigBld = new MeterConfigBuilder()
473                 .setMeterId(new MeterId(meterIdValue))
474                 .setFlags(new MeterFlags(false, true, false, true))
475                 .setBands(List.of());
476
477         final MultipartReplyMeterConfigBuilder mpReplyMeterConfigBld = new MultipartReplyMeterConfigBuilder();
478         mpReplyMeterConfigBld.setMeterConfig(List.of(meterConfigBld.build()));
479         final MultipartReplyMeterConfigCaseBuilder mpReplyMeterConfigCaseBld =
480                 new MultipartReplyMeterConfigCaseBuilder();
481         mpReplyMeterConfigCaseBld.setMultipartReplyMeterConfig(mpReplyMeterConfigBld.build());
482
483         final MultipartReply meterConfigUpdated = assembleMPReplyMessage(type, mpReplyMeterConfigCaseBld.build());
484         final List<MultipartReply> statsData = List.of(meterConfigUpdated);
485
486         fireAndCheck(type, statsData);
487
488         final org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId meterId =
489                 new org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId(meterIdValue);
490         final KeyedInstanceIdentifier<Meter, MeterKey> meterPath = dummyNodePath.augmentation(FlowCapableNode.class)
491                 .child(Meter.class, new MeterKey(meterId));
492         verify(deviceContext, Mockito.never()).addDeleteToTxChain(eq(LogicalDatastoreType.OPERATIONAL),
493                 ArgumentMatchers.<InstanceIdentifier<?>>any());
494         verify(deviceMeterRegistry).store(meterId);
495         verify(deviceContext).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL),
496                                                  eq(meterPath), any(Meter.class));
497     }
498
499     private void fireAndCheck(final MultipartType type, final List<MultipartReply> statsData)
500             throws InterruptedException, ExecutionException, TimeoutException {
501         when(statisticsService.getStatisticsOfType(any(EventIdentifier.class),eq(type)))
502                 .thenReturn(Futures.immediateFuture(RpcResultBuilder.success(statsData).build()));
503
504         final ListenableFuture<Boolean> gatherStatisticsResult = StatisticsGatheringUtils.gatherStatistics(
505             statisticsService,
506             deviceInfo,
507             type,
508             deviceContext,
509             deviceContext,
510             ConvertorManagerFactory.createDefaultManager(),
511             provider,
512             MoreExecutors.directExecutor());
513
514         Assert.assertTrue(gatherStatisticsResult.get(1, TimeUnit.SECONDS));
515         verify(deviceContext).submitTransaction();
516     }
517
518     private static MultipartReplyMessage assembleMPReplyMessage(final MultipartType type,
519                                                                 final MultipartReplyBody mpReplyGroupCaseBld) {
520         return new MultipartReplyMessageBuilder()
521                 .setMultipartReplyBody(mpReplyGroupCaseBld)
522                 .setType(type)
523                 .setFlags(new MultipartRequestFlags(false))
524                 .setXid(Uint32.valueOf(42))
525                 .build();
526     }
527
528     private static BucketStats createBucketStat(final long byteCount, final long packetCount) {
529         return new BucketStatsBuilder()
530                 .setByteCount(Uint64.valueOf(byteCount)).setPacketCount(Uint64.valueOf(packetCount)).build();
531     }
532
533     @Test
534     public void testDeleteAllKnownFlows() {
535         final InstanceIdentifier<FlowCapableNode> nodePath =
536                 deviceInfo.getNodeInstanceIdentifier().augmentation(FlowCapableNode.class);
537         final TableBuilder tableDataBld = new TableBuilder();
538         tableDataBld.setId(Uint8.ZERO);
539         final FlowCapableNodeBuilder flowNodeBuilder = new FlowCapableNodeBuilder();
540         flowNodeBuilder.setTable(BindingMap.of(tableDataBld.build()));
541         final Optional<FlowCapableNode> flowNodeOpt = Optional.of(flowNodeBuilder.build());
542         doReturn(FluentFutures.immediateFluentFuture(flowNodeOpt)).when(readTx)
543             .read(LogicalDatastoreType.OPERATIONAL, nodePath);
544         StatisticsGatheringUtils.deleteAllKnownFlows(deviceContext, deviceInfo.getNodeInstanceIdentifier()
545             .augmentation(FlowCapableNode.class), deviceFlowRegistry);
546
547         verify(deviceContext).isTransactionsEnabled();
548         verify(deviceContext).getReadTransaction();
549         verify(deviceContext).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
550     }
551 }