2 * Copyright (c) 2017 Pantheon Technologies s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.openflowplugin.impl.services.sal;
11 import java.util.Iterator;
12 import java.util.List;
13 import java.util.concurrent.Future;
14 import org.junit.After;
15 import org.junit.Assert;
16 import org.junit.Before;
17 import org.junit.Test;
18 import org.junit.runner.RunWith;
19 import org.mockito.ArgumentCaptor;
20 import org.mockito.ArgumentMatchers;
21 import org.mockito.Captor;
22 import org.mockito.InOrder;
23 import org.mockito.Mock;
24 import org.mockito.Mockito;
25 import org.mockito.junit.MockitoJUnitRunner;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutputBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInput;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowOutput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowOutputBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInput;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutput;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutputBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.FlowCapableTransactionService;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierOutput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchInput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchInputBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutput;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.RemoveFlowsBatchInput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.RemoveFlowsBatchInputBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.RemoveFlowsBatchOutput;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.UpdateFlowsBatchInput;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.UpdateFlowsBatchInputBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.UpdateFlowsBatchOutput;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.add.flows.batch.input.BatchAddFlows;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.add.flows.batch.input.BatchAddFlowsBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.input.update.grouping.OriginalBatchedFlowBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.input.update.grouping.UpdatedBatchedFlowBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutput;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.remove.flows.batch.input.BatchRemoveFlows;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.remove.flows.batch.input.BatchRemoveFlowsBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.update.flows.batch.input.BatchUpdateFlows;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.update.flows.batch.input.BatchUpdateFlowsBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
64 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
65 import org.opendaylight.yangtools.yang.common.ErrorType;
66 import org.opendaylight.yangtools.yang.common.RpcResult;
67 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
68 import org.opendaylight.yangtools.yang.common.Uint16;
69 import org.opendaylight.yangtools.yang.common.Uint8;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
74 * Test for {@link org.opendaylight.openflowplugin.impl.services.sal.SalFlowsBatchServiceImpl}.
76 @RunWith(MockitoJUnitRunner.class)
77 public class SalFlowsBatchServiceImplTest {
79 private static final Logger LOG = LoggerFactory.getLogger(SalFlowsBatchServiceImplTest.class);
81 public static final NodeId NODE_ID = new NodeId("ut-dummy-node");
82 public static final NodeKey NODE_KEY = new NodeKey(NODE_ID);
83 public static final NodeRef NODE_REF =
84 new NodeRef(InstanceIdentifier.create(Nodes.class).child(Node.class, NODE_KEY));
87 private SalFlowService salFlowService;
89 private FlowCapableTransactionService transactionService;
91 private ArgumentCaptor<RemoveFlowInput> removeFlowInputCpt;
93 private ArgumentCaptor<UpdateFlowInput> updateFlowInputCpt;
95 private ArgumentCaptor<AddFlowInput> addFlowInputCpt;
97 private SalFlowsBatchServiceImpl salFlowsBatchService;
98 public static final String FLOW_ID_VALUE_1 = "ut-dummy-flow1";
99 public static final String FLOW_ID_VALUE_2 = "ut-dummy-flow2";
102 public void setUp() {
103 salFlowsBatchService = new SalFlowsBatchServiceImpl(salFlowService, transactionService);
105 Mockito.when(transactionService.sendBarrier(ArgumentMatchers.any()))
106 .thenReturn(RpcResultBuilder.<SendBarrierOutput>success().buildFuture());
110 public void tearDown() {
111 Mockito.verifyNoMoreInteractions(salFlowService, transactionService);
115 public void testRemoveFlowsBatch_success() throws Exception {
116 Mockito.when(salFlowService.removeFlow(ArgumentMatchers.any()))
117 .thenReturn(RpcResultBuilder.success(new RemoveFlowOutputBuilder().build())
120 final String flow1IdValue = "ut-dummy-flow1";
121 final String flow2IdValue = "ut-dummy-flow2";
122 final BatchRemoveFlows batchFlow1 = createEmptyBatchRemoveFlow(flow1IdValue, 42);
123 final BatchRemoveFlows batchFlow2 = createEmptyBatchRemoveFlow(flow2IdValue, 43);
125 final RemoveFlowsBatchInput input = new RemoveFlowsBatchInputBuilder()
127 .setBarrierAfter(true)
128 .setBatchRemoveFlows(BindingMap.ordered(batchFlow1, batchFlow2))
131 final Future<RpcResult<RemoveFlowsBatchOutput>> resultFuture = salFlowsBatchService.removeFlowsBatch(input);
133 Assert.assertTrue(resultFuture.isDone());
134 final RpcResult<RemoveFlowsBatchOutput> rpcResult = resultFuture.get();
135 Assert.assertTrue(rpcResult.isSuccessful());
136 final RemoveFlowsBatchOutput result = rpcResult.getResult();
137 Assert.assertEquals(0, result.nonnullBatchFailedFlowsOutput().size());
139 final InOrder inOrder = Mockito.inOrder(salFlowService, transactionService);
141 inOrder.verify(salFlowService, Mockito.times(2)).removeFlow(removeFlowInputCpt.capture());
142 final List<RemoveFlowInput> allValues = removeFlowInputCpt.getAllValues();
143 Assert.assertEquals(2, allValues.size());
144 Assert.assertEquals(42, allValues.get(0).getPriority().longValue());
145 Assert.assertEquals(43, allValues.get(1).getPriority().longValue());
147 inOrder.verify(transactionService).sendBarrier(ArgumentMatchers.any());
151 public void testRemoveFlowsBatch_failed() throws Exception {
152 Mockito.when(salFlowService.removeFlow(ArgumentMatchers.any()))
153 .thenReturn(RpcResultBuilder.<RemoveFlowOutput>failed()
154 .withError(ErrorType.APPLICATION, "flow-remove-fail-1")
157 final BatchRemoveFlows batchFlow1 = createEmptyBatchRemoveFlow(FLOW_ID_VALUE_1, 42);
158 final BatchRemoveFlows batchFlow2 = createEmptyBatchRemoveFlow(FLOW_ID_VALUE_2, 43);
160 final RemoveFlowsBatchInput input = new RemoveFlowsBatchInputBuilder()
162 .setBarrierAfter(true)
163 .setBatchRemoveFlows(BindingMap.ordered(batchFlow1, batchFlow2))
166 final Future<RpcResult<RemoveFlowsBatchOutput>> resultFuture = salFlowsBatchService.removeFlowsBatch(input);
168 Assert.assertTrue(resultFuture.isDone());
169 final RpcResult<RemoveFlowsBatchOutput> rpcResult = resultFuture.get();
170 Assert.assertFalse(rpcResult.isSuccessful());
171 final RemoveFlowsBatchOutput result = rpcResult.getResult();
172 Iterator<BatchFailedFlowsOutput> iterator = result.nonnullBatchFailedFlowsOutput().values().iterator();
173 Assert.assertEquals(2, result.nonnullBatchFailedFlowsOutput().size());
174 Assert.assertEquals(FLOW_ID_VALUE_1, iterator.next().getFlowId().getValue());
175 Assert.assertEquals(FLOW_ID_VALUE_2, iterator.next().getFlowId().getValue());
177 final InOrder inOrder = Mockito.inOrder(salFlowService, transactionService);
179 inOrder.verify(salFlowService, Mockito.times(2)).removeFlow(removeFlowInputCpt.capture());
180 final List<RemoveFlowInput> allValues = removeFlowInputCpt.getAllValues();
181 Assert.assertEquals(2, allValues.size());
182 Assert.assertEquals(42, allValues.get(0).getPriority().longValue());
183 Assert.assertEquals(43, allValues.get(1).getPriority().longValue());
185 inOrder.verify(transactionService).sendBarrier(ArgumentMatchers.any());
188 private static BatchAddFlows createEmptyBatchAddFlow(final String flowIdValue, final int priority) {
189 return new BatchAddFlowsBuilder()
190 .setFlowId(new FlowId(flowIdValue))
191 .setPriority(Uint16.valueOf(priority))
192 .setMatch(new MatchBuilder().build())
193 .setTableId(Uint8.ZERO)
197 private static BatchRemoveFlows createEmptyBatchRemoveFlow(final String flowIdValue, final int priority) {
198 return new BatchRemoveFlowsBuilder()
199 .setFlowId(new FlowId(flowIdValue))
200 .setPriority(Uint16.valueOf(priority))
201 .setMatch(new MatchBuilder().build())
202 .setTableId(Uint8.ZERO)
206 private static BatchUpdateFlows createEmptyBatchUpdateFlow(final String flowIdValue, final int priority) {
207 final BatchAddFlows emptyOriginalFlow = createEmptyBatchAddFlow(flowIdValue, priority);
208 final BatchAddFlows emptyUpdatedFlow = createEmptyBatchAddFlow(flowIdValue, priority + 1);
209 return new BatchUpdateFlowsBuilder()
210 .setFlowId(new FlowId(flowIdValue))
211 .setOriginalBatchedFlow(new OriginalBatchedFlowBuilder(emptyOriginalFlow).build())
212 .setUpdatedBatchedFlow(new UpdatedBatchedFlowBuilder(emptyUpdatedFlow).build())
217 public void testAddFlowsBatch_success() throws Exception {
218 Mockito.when(salFlowService.addFlow(ArgumentMatchers.any()))
219 .thenReturn(RpcResultBuilder.success(new AddFlowOutputBuilder().build()).buildFuture());
221 final AddFlowsBatchInput input = new AddFlowsBatchInputBuilder()
223 .setBarrierAfter(true)
224 .setBatchAddFlows(BindingMap.ordered(
225 createEmptyBatchAddFlow("ut-dummy-flow1", 42),
226 createEmptyBatchAddFlow("ut-dummy-flow2", 43)))
229 final Future<RpcResult<AddFlowsBatchOutput>> resultFuture = salFlowsBatchService.addFlowsBatch(input);
231 Assert.assertTrue(resultFuture.isDone());
232 Assert.assertTrue(resultFuture.get().isSuccessful());
234 final InOrder inOrder = Mockito.inOrder(salFlowService, transactionService);
236 inOrder.verify(salFlowService, Mockito.times(2)).addFlow(addFlowInputCpt.capture());
237 final List<AddFlowInput> allValues = addFlowInputCpt.getAllValues();
238 Assert.assertEquals(2, allValues.size());
239 Assert.assertEquals(42, allValues.get(0).getPriority().longValue());
240 Assert.assertEquals(43, allValues.get(1).getPriority().longValue());
242 inOrder.verify(transactionService).sendBarrier(ArgumentMatchers.any());
246 public void testAddFlowsBatch_failed() throws Exception {
247 Mockito.when(salFlowService.addFlow(ArgumentMatchers.any()))
248 .thenReturn(RpcResultBuilder
249 .<AddFlowOutput>failed().withError(ErrorType.APPLICATION, "ut-groupAddError")
252 final AddFlowsBatchInput input = new AddFlowsBatchInputBuilder()
254 .setBarrierAfter(true)
255 .setBatchAddFlows(BindingMap.ordered(
256 createEmptyBatchAddFlow(FLOW_ID_VALUE_1, 42),
257 createEmptyBatchAddFlow(FLOW_ID_VALUE_2, 43)))
260 final Future<RpcResult<AddFlowsBatchOutput>> resultFuture = salFlowsBatchService.addFlowsBatch(input);
261 Iterator<BatchFailedFlowsOutput> iterator = resultFuture.get().getResult().nonnullBatchFailedFlowsOutput()
262 .values().iterator();
264 Assert.assertTrue(resultFuture.isDone());
265 Assert.assertFalse(resultFuture.get().isSuccessful());
266 Assert.assertEquals(2, resultFuture.get().getResult().nonnullBatchFailedFlowsOutput().size());
267 Assert.assertEquals(FLOW_ID_VALUE_1, iterator.next().getFlowId().getValue());
268 Assert.assertEquals(FLOW_ID_VALUE_2, iterator.next().getFlowId().getValue());
269 Assert.assertEquals(2, resultFuture.get().getErrors().size());
271 final InOrder inOrder = Mockito.inOrder(salFlowService, transactionService);
273 inOrder.verify(salFlowService, Mockito.times(2)).addFlow(addFlowInputCpt.capture());
274 final List<AddFlowInput> allValues = addFlowInputCpt.getAllValues();
275 Assert.assertEquals(2, allValues.size());
276 Assert.assertEquals(42, allValues.get(0).getPriority().longValue());
277 Assert.assertEquals(43, allValues.get(1).getPriority().longValue());
279 inOrder.verify(transactionService).sendBarrier(ArgumentMatchers.any());
283 public void testUpdateFlowsBatch_success() throws Exception {
284 Mockito.when(salFlowService.updateFlow(ArgumentMatchers.any()))
285 .thenReturn(RpcResultBuilder.success(new UpdateFlowOutputBuilder().build()).buildFuture());
287 final UpdateFlowsBatchInput input = new UpdateFlowsBatchInputBuilder()
289 .setBarrierAfter(true)
290 .setBatchUpdateFlows(BindingMap.ordered(
291 createEmptyBatchUpdateFlow(FLOW_ID_VALUE_1, 42),
292 createEmptyBatchUpdateFlow(FLOW_ID_VALUE_2, 44)))
295 final Future<RpcResult<UpdateFlowsBatchOutput>> resultFuture = salFlowsBatchService.updateFlowsBatch(input);
297 Assert.assertTrue(resultFuture.isDone());
298 Assert.assertTrue(resultFuture.get().isSuccessful());
300 final InOrder inOrder = Mockito.inOrder(salFlowService, transactionService);
302 inOrder.verify(salFlowService, Mockito.times(2)).updateFlow(updateFlowInputCpt.capture());
303 final List<UpdateFlowInput> allValues = updateFlowInputCpt.getAllValues();
304 Assert.assertEquals(2, allValues.size());
305 Assert.assertEquals(42, allValues.get(0).getOriginalFlow().getPriority().longValue());
306 Assert.assertEquals(43, allValues.get(0).getUpdatedFlow().getPriority().longValue());
307 Assert.assertEquals(44, allValues.get(1).getOriginalFlow().getPriority().longValue());
308 Assert.assertEquals(45, allValues.get(1).getUpdatedFlow().getPriority().longValue());
310 inOrder.verify(transactionService).sendBarrier(ArgumentMatchers.any());
314 public void testUpdateFlowsBatch_failure() throws Exception {
315 Mockito.when(salFlowService.updateFlow(ArgumentMatchers.any()))
316 .thenReturn(RpcResultBuilder.<UpdateFlowOutput>failed()
317 .withError(ErrorType.APPLICATION, "ut-flowUpdateError")
320 final UpdateFlowsBatchInput input = new UpdateFlowsBatchInputBuilder()
322 .setBarrierAfter(true)
323 .setBatchUpdateFlows(BindingMap.ordered(
324 createEmptyBatchUpdateFlow(FLOW_ID_VALUE_1, 42),
325 createEmptyBatchUpdateFlow(FLOW_ID_VALUE_2, 44)))
328 final Future<RpcResult<UpdateFlowsBatchOutput>> resultFuture = salFlowsBatchService.updateFlowsBatch(input);
329 Iterator<BatchFailedFlowsOutput> iterator = resultFuture.get().getResult().nonnullBatchFailedFlowsOutput()
330 .values().iterator();
332 Assert.assertTrue(resultFuture.isDone());
333 Assert.assertFalse(resultFuture.get().isSuccessful());
334 Assert.assertFalse(resultFuture.get().isSuccessful());
335 Assert.assertEquals(2, resultFuture.get().getResult().nonnullBatchFailedFlowsOutput().size());
336 Assert.assertEquals(FLOW_ID_VALUE_1, iterator.next().getFlowId().getValue());
337 Assert.assertEquals(FLOW_ID_VALUE_2, iterator.next().getFlowId().getValue());
338 Assert.assertEquals(2, resultFuture.get().getErrors().size());
340 final InOrder inOrder = Mockito.inOrder(salFlowService, transactionService);
341 inOrder.verify(salFlowService, Mockito.times(2)).updateFlow(updateFlowInputCpt.capture());
342 final List<UpdateFlowInput> allValues = updateFlowInputCpt.getAllValues();
343 Assert.assertEquals(2, allValues.size());
344 Assert.assertEquals(42, allValues.get(0).getOriginalFlow().getPriority().longValue());
345 Assert.assertEquals(43, allValues.get(0).getUpdatedFlow().getPriority().longValue());
346 Assert.assertEquals(44, allValues.get(1).getOriginalFlow().getPriority().longValue());
347 Assert.assertEquals(45, allValues.get(1).getUpdatedFlow().getPriority().longValue());
349 inOrder.verify(transactionService).sendBarrier(ArgumentMatchers.any());