2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.openflowplugin.impl.util;
11 import com.google.common.collect.Lists;
12 import java.util.Collections;
13 import java.util.List;
15 import java.util.function.Function;
16 import org.apache.commons.lang3.tuple.Pair;
17 import org.junit.Assert;
18 import org.junit.Test;
19 import org.mockito.Mockito;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierOutput;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowRef;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutput;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutputBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowOutputListGrouping;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutput;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputKey;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
37 import org.opendaylight.yangtools.yang.common.RpcError;
38 import org.opendaylight.yangtools.yang.common.RpcResult;
39 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
40 import org.opendaylight.yangtools.yang.common.Uint8;
42 public class FlowUtilTest {
43 public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
44 public static final FlowId DUMMY_FLOW_ID = new FlowId("dummyFlowId");
45 public static final FlowId DUMMY_FLOW_ID_2 = new FlowId("dummyFlowId_2");
46 public static final Uint8 DUMMY_TABLE_ID = Uint8.ONE;
49 public void testBuildFlowPath() {
50 final InstanceIdentifier<Node> nodePath = InstanceIdentifier
52 .child(Node.class, new NodeKey(DUMMY_NODE_ID));
54 final FlowRef flowRef = FlowUtil.buildFlowPath(nodePath, DUMMY_TABLE_ID, DUMMY_FLOW_ID);
55 final InstanceIdentifier<?> flowRefValue = flowRef.getValue();
56 Assert.assertEquals(DUMMY_NODE_ID, flowRefValue.firstKeyOf(Node.class).getId());
57 Assert.assertEquals(DUMMY_TABLE_ID, flowRefValue.firstKeyOf(Table.class).getId());
58 Assert.assertEquals(DUMMY_FLOW_ID, flowRefValue.firstKeyOf(Flow.class).getId());
62 public void testCreateCumulatingFunction() {
63 final Function<List<RpcResult<String>>, RpcResult<List<BatchFailedFlowsOutput>>> function =
64 FlowUtil.createCumulatingFunction(Lists.newArrayList(createBatchFlowIdGrouping(DUMMY_FLOW_ID),
65 createBatchFlowIdGrouping(DUMMY_FLOW_ID_2)));
67 final RpcResult<List<BatchFailedFlowsOutput>> summary = function.apply(Lists.newArrayList(
68 RpcResultBuilder.success("a").build(),
69 RpcResultBuilder.<String>failed()
70 .withError(RpcError.ErrorType.APPLICATION, "action-failed reason")
73 Assert.assertFalse(summary.isSuccessful());
74 Assert.assertEquals(1, summary.getResult().size());
75 Assert.assertEquals(1, summary.getErrors().size());
76 Assert.assertEquals(DUMMY_FLOW_ID_2, summary.getResult().get(0).getFlowId());
77 Assert.assertEquals(1, summary.getResult().get(0).getBatchOrder().intValue());
80 protected BatchFlowIdGrouping createBatchFlowIdGrouping(final FlowId flowId) {
81 final BatchFlowIdGrouping mock = Mockito.mock(BatchFlowIdGrouping.class);
82 Mockito.when(mock.getFlowId()).thenReturn(flowId);
87 public void testFlowAddTransformFailure() {
88 final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
89 checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
93 public void testFlowAddTransformSuccess() {
94 final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
95 checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
99 public void testFlowRemoveTransformFailure() {
100 final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
101 checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
105 public void testFlowRemoveTransformSuccess() {
106 final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
107 checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
111 public void testFlowUpdateTransformFailure() {
112 final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
113 checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
117 public void testFlowUpdateTransformSuccess() {
118 final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
119 checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
122 private <T extends BatchFlowOutputListGrouping> void checkBatchSuccessOutcomeTransformation(
123 final RpcResult<T> output) {
124 Assert.assertTrue(output.isSuccessful());
125 Map<BatchFailedFlowsOutputKey, BatchFailedFlowsOutput> failedFlows
126 = output.getResult().nonnullBatchFailedFlowsOutput();
127 Assert.assertEquals(0, failedFlows.size());
128 Assert.assertEquals(0, output.getErrors().size());
131 private static RpcResult<List<BatchFailedFlowsOutput>> createEmptyBatchOutcome() {
132 return RpcResultBuilder
133 .success(Collections.<BatchFailedFlowsOutput>emptyList())
137 private static RpcResult<List<BatchFailedFlowsOutput>> createBatchOutcomeWithError() {
138 return RpcResultBuilder.<List<BatchFailedFlowsOutput>>failed()
139 .withError(RpcError.ErrorType.APPLICATION, "ut-flowAddFail")
140 .withResult(Collections.singletonList(new BatchFailedFlowsOutputBuilder()
141 .setFlowId(DUMMY_FLOW_ID)
146 private static <T extends BatchFlowOutputListGrouping> void checkBatchErrorOutcomeTransformation(
147 final RpcResult<T> output) {
148 Assert.assertFalse(output.isSuccessful());
149 Assert.assertEquals(1, output.getResult().nonnullBatchFailedFlowsOutput().size());
150 Assert.assertEquals(DUMMY_FLOW_ID,
151 output.getResult().nonnullBatchFailedFlowsOutput().values().iterator().next().getFlowId());
153 Assert.assertEquals(1, output.getErrors().size());
157 public void testCreateComposingFunction_success_success() {
158 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
159 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
161 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
162 final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
163 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
164 = Pair.of(addFlowBatchOutput, barrierOutput);
165 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
167 Assert.assertTrue(composite.isSuccessful());
168 Assert.assertEquals(0, composite.getErrors().size());
169 Map<BatchFailedFlowsOutputKey, BatchFailedFlowsOutput> failedFlows
170 = composite.getResult().nonnullBatchFailedFlowsOutput();
171 Assert.assertEquals(0, failedFlows.size());
175 public void testCreateComposingFunction_failure_success() {
176 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
177 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
179 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
180 final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
181 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
182 = Pair.of(addFlowBatchOutput, barrierOutput);
183 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
185 Assert.assertFalse(composite.isSuccessful());
186 Assert.assertEquals(1, composite.getErrors().size());
187 Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
191 public void testCreateComposingFunction_success_failure() {
192 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
193 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
195 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
196 final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
197 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
198 = Pair.of(addFlowBatchOutput, barrierOutput);
199 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
201 Assert.assertFalse(composite.isSuccessful());
202 Assert.assertEquals(1, composite.getErrors().size());
203 Map<BatchFailedFlowsOutputKey, BatchFailedFlowsOutput> failedFlows
204 = composite.getResult().nonnullBatchFailedFlowsOutput();
205 Assert.assertEquals(0, failedFlows.size());
209 public void testCreateComposingFunction_failure_failure() {
210 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
211 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
213 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
214 final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
215 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
216 = Pair.of(addFlowBatchOutput, barrierOutput);
217 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
219 Assert.assertFalse(composite.isSuccessful());
220 Assert.assertEquals(2, composite.getErrors().size());
221 Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
224 private RpcResult<SendBarrierOutput> createBarrierFailureOutcome() {
225 return RpcResultBuilder.<SendBarrierOutput>failed()
226 .withError(RpcError.ErrorType.APPLICATION, "ut-barrier-error")
230 private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchSuccessOutput() {
231 return RpcResultBuilder
232 .success(new AddFlowsBatchOutputBuilder()
233 .setBatchFailedFlowsOutput(Collections.emptyList())
238 private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchFailureOutcome() {
239 final RpcResult<List<BatchFailedFlowsOutput>> batchOutcomeWithError = createBatchOutcomeWithError();
240 return RpcResultBuilder.<AddFlowsBatchOutput>failed()
241 .withResult(new AddFlowsBatchOutputBuilder()
242 .setBatchFailedFlowsOutput(batchOutcomeWithError.getResult())
244 .withRpcErrors(batchOutcomeWithError.getErrors())