3 * * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
5 * * This program and the accompanying materials are made available under the
6 * * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * * and is available at http://www.eclipse.org/legal/epl-v10.html
12 package org.opendaylight.openflowplugin.impl.util;
14 import static org.junit.Assert.assertNotNull;
15 import static org.junit.Assert.assertTrue;
17 import com.google.common.base.Function;
18 import com.google.common.collect.Lists;
19 import java.util.Collections;
20 import java.util.List;
21 import java.util.regex.Matcher;
22 import java.util.regex.Pattern;
23 import org.apache.commons.lang3.tuple.Pair;
24 import org.junit.Assert;
25 import org.junit.Test;
26 import org.mockito.Mockito;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowRef;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutputBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowOutputListGrouping;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutput;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
42 import org.opendaylight.yangtools.yang.common.RpcError;
43 import org.opendaylight.yangtools.yang.common.RpcResult;
44 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
46 public class FlowUtilTest {
48 public static final Pattern INDEX_PATTERN = Pattern.compile("^#UF\\$TABLE\\*1-([0-9]+)$");
49 public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
50 public static final FlowId DUMMY_FLOW_ID = new FlowId("dummyFlowId");
51 public static final FlowId DUMMY_FLOW_ID_2 = new FlowId("dummyFlowId_2");
52 public static final Short DUMMY_TABLE_ID = 1;
55 public void createAlienFlowIdTest() {
56 final String alienFlowId1 = FlowUtil.createAlienFlowId(DUMMY_TABLE_ID).getValue();
57 final Integer index1 = parseIndex(alienFlowId1);
58 final String alienFlowId2 = FlowUtil.createAlienFlowId(DUMMY_TABLE_ID).getValue();
59 final Integer index2 = parseIndex(alienFlowId2);
61 assertNotNull("index1 parsing failed: " + alienFlowId1, index1);
62 assertNotNull("index2 parsing failed: " + alienFlowId2, index2);
63 assertTrue(index1 < index2);
66 private static Integer parseIndex(String alienFlowIdValue) {
67 final Matcher mach = INDEX_PATTERN.matcher(alienFlowIdValue);
69 return Integer.valueOf(mach.group(1));
75 public void testBuildFlowPath() throws Exception {
76 final InstanceIdentifier<Node> nodePath = InstanceIdentifier
78 .child(Node.class, new NodeKey(DUMMY_NODE_ID));
80 final FlowRef flowRef = FlowUtil.buildFlowPath(nodePath, DUMMY_TABLE_ID, DUMMY_FLOW_ID);
81 final InstanceIdentifier<?> flowRefValue = flowRef.getValue();
82 Assert.assertEquals(DUMMY_NODE_ID, flowRefValue.firstKeyOf(Node.class).getId());
83 Assert.assertEquals(DUMMY_TABLE_ID, flowRefValue.firstKeyOf(Table.class).getId());
84 Assert.assertEquals(DUMMY_FLOW_ID, flowRefValue.firstKeyOf(Flow.class).getId());
88 public void testCreateCumulatingFunction() throws Exception {
89 final Function<List<RpcResult<String>>, RpcResult<List<BatchFailedFlowsOutput>>> function =
90 FlowUtil.createCumulatingFunction(Lists.newArrayList(createBatchFlowIdGrouping(DUMMY_FLOW_ID),
91 createBatchFlowIdGrouping(DUMMY_FLOW_ID_2)));
93 final RpcResult<List<BatchFailedFlowsOutput>> summary = function.apply(Lists.newArrayList(
94 RpcResultBuilder.success("a").build(),
95 RpcResultBuilder.<String>failed()
96 .withError(RpcError.ErrorType.APPLICATION, "action-failed reason")
99 Assert.assertFalse(summary.isSuccessful());
100 Assert.assertEquals(1, summary.getResult().size());
101 Assert.assertEquals(1, summary.getErrors().size());
102 Assert.assertEquals(DUMMY_FLOW_ID_2, summary.getResult().get(0).getFlowId());
103 Assert.assertEquals(1, summary.getResult().get(0).getBatchOrder().intValue());
106 protected BatchFlowIdGrouping createBatchFlowIdGrouping(final FlowId flowId) {
107 final BatchFlowIdGrouping mock = Mockito.mock(BatchFlowIdGrouping.class);
108 Mockito.when(mock.getFlowId()).thenReturn(flowId);
113 public void testFLOW_ADD_TRANSFORM__failure() throws Exception {
114 final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
115 checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
119 public void testFLOW_ADD_TRANSFORM__success() throws Exception {
120 final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
121 checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
125 public void testFLOW_REMOVE_TRANSFORM__failure() throws Exception {
126 final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
127 checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
131 public void testFLOW_REMOVE_TRANSFORM__success() throws Exception {
132 final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
133 checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
137 public void testFLOW_UPDATE_TRANSFORM__failure() throws Exception {
138 final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
139 checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
143 public void testFLOW_UPDATE_TRANSFORM__success() throws Exception {
144 final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
145 checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
148 private <T extends BatchFlowOutputListGrouping> void checkBatchSuccessOutcomeTransformation(final RpcResult<T> output) {
149 Assert.assertTrue(output.isSuccessful());
150 Assert.assertEquals(0, output.getResult().getBatchFailedFlowsOutput().size());
151 Assert.assertEquals(0, output.getErrors().size());
154 private RpcResult<List<BatchFailedFlowsOutput>> createEmptyBatchOutcome() {
155 return RpcResultBuilder
156 .<List<BatchFailedFlowsOutput>>success(Collections.<BatchFailedFlowsOutput>emptyList())
160 private RpcResult<List<BatchFailedFlowsOutput>> createBatchOutcomeWithError() {
161 return RpcResultBuilder.<List<BatchFailedFlowsOutput>>failed()
162 .withError(RpcError.ErrorType.APPLICATION, "ut-flowAddFail")
163 .withResult(Collections.singletonList(new BatchFailedFlowsOutputBuilder()
164 .setFlowId(DUMMY_FLOW_ID)
169 private <T extends BatchFlowOutputListGrouping> void checkBatchErrorOutcomeTransformation(final RpcResult<T> output) {
170 Assert.assertFalse(output.isSuccessful());
171 Assert.assertEquals(1, output.getResult().getBatchFailedFlowsOutput().size());
172 Assert.assertEquals(DUMMY_FLOW_ID, output.getResult().getBatchFailedFlowsOutput().get(0).getFlowId());
174 Assert.assertEquals(1, output.getErrors().size());
178 public void testCreateComposingFunction_success_success() throws Exception {
179 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
180 FlowUtil.createComposingFunction();
182 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
183 final RpcResult<Void> barrierOutput = RpcResultBuilder.<Void>success().build();
184 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
185 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
187 Assert.assertTrue(composite.isSuccessful());
188 Assert.assertEquals(0, composite.getErrors().size());
189 Assert.assertEquals(0, composite.getResult().getBatchFailedFlowsOutput().size());
193 public void testCreateComposingFunction_failure_success() throws Exception {
194 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
195 FlowUtil.createComposingFunction();
197 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
198 final RpcResult<Void> barrierOutput = RpcResultBuilder.<Void>success().build();
199 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
200 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
202 Assert.assertFalse(composite.isSuccessful());
203 Assert.assertEquals(1, composite.getErrors().size());
204 Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
208 public void testCreateComposingFunction_success_failure() throws Exception {
209 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
210 FlowUtil.createComposingFunction();
212 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
213 final RpcResult<Void> barrierOutput = createBarrierFailureOutcome();
214 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
215 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
217 Assert.assertFalse(composite.isSuccessful());
218 Assert.assertEquals(1, composite.getErrors().size());
219 Assert.assertEquals(0, composite.getResult().getBatchFailedFlowsOutput().size());
223 public void testCreateComposingFunction_failure_failure() throws Exception {
224 final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
225 FlowUtil.createComposingFunction();
227 final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
228 final RpcResult<Void> barrierOutput = createBarrierFailureOutcome();
229 final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
230 final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
232 Assert.assertFalse(composite.isSuccessful());
233 Assert.assertEquals(2, composite.getErrors().size());
234 Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
237 private RpcResult<Void> createBarrierFailureOutcome() {
238 return RpcResultBuilder.<Void>failed()
239 .withError(RpcError.ErrorType.APPLICATION, "ut-barrier-error")
243 private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchSuccessOutput() {
244 return RpcResultBuilder
245 .success(new AddFlowsBatchOutputBuilder()
246 .setBatchFailedFlowsOutput(Collections.<BatchFailedFlowsOutput>emptyList())
251 private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchFailureOutcome() {
252 final RpcResult<List<BatchFailedFlowsOutput>> batchOutcomeWithError = createBatchOutcomeWithError();
253 return RpcResultBuilder.<AddFlowsBatchOutput>failed()
254 .withResult(new AddFlowsBatchOutputBuilder()
255 .setBatchFailedFlowsOutput(batchOutcomeWithError.getResult())
257 .withRpcErrors(batchOutcomeWithError.getErrors())