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