openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/util/FlowUtilTest.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.util;
  10
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertTrue;
  13
  14 import com.google.common.base.Function;
  15 import com.google.common.collect.Lists;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.regex.Matcher;
  19 import java.util.regex.Pattern;
  20 import org.apache.commons.lang3.tuple.Pair;
  21 import org.junit.Assert;
  22 import org.junit.Test;
  23 import org.mockito.Mockito;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowRef;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowOutputListGrouping;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.common.RpcError;
  40 import org.opendaylight.yangtools.yang.common.RpcResult;
  41 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  42
  43 public class FlowUtilTest {
  44
  45     public static final Pattern INDEX_PATTERN = Pattern.compile("^#UF\\$TABLE\\*1-([0-9]+)$");
  46     public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
  47     public static final FlowId DUMMY_FLOW_ID = new FlowId("dummyFlowId");
  48     public static final FlowId DUMMY_FLOW_ID_2 = new FlowId("dummyFlowId_2");
  49     public static final Short DUMMY_TABLE_ID = 1;
  50
  51     @Test
  52     public void createAlienFlowIdTest() {
  53         final String alienFlowId1 = FlowUtil.createAlienFlowId(DUMMY_TABLE_ID).getValue();
  54         final Integer index1 = parseIndex(alienFlowId1);
  55         final String alienFlowId2 = FlowUtil.createAlienFlowId(DUMMY_TABLE_ID).getValue();
  56         final Integer index2 = parseIndex(alienFlowId2);
  57
  58         assertNotNull("index1 parsing failed: " + alienFlowId1, index1);
  59         assertNotNull("index2 parsing failed: " + alienFlowId2, index2);
  60         assertTrue(index1 < index2);
  61     }
  62
  63     private static Integer parseIndex(String alienFlowIdValue) {
  64         final Matcher mach = INDEX_PATTERN.matcher(alienFlowIdValue);
  65         if (mach.find()) {
  66             return Integer.valueOf(mach.group(1));
  67         }
  68         return null;
  69     }
  70
  71     @Test
  72     public void testBuildFlowPath() throws Exception {
  73         final InstanceIdentifier<Node> nodePath = InstanceIdentifier
  74                 .create(Nodes.class)
  75                 .child(Node.class, new NodeKey(DUMMY_NODE_ID));
  76
  77         final FlowRef flowRef = FlowUtil.buildFlowPath(nodePath, DUMMY_TABLE_ID, DUMMY_FLOW_ID);
  78         final InstanceIdentifier<?> flowRefValue = flowRef.getValue();
  79         Assert.assertEquals(DUMMY_NODE_ID, flowRefValue.firstKeyOf(Node.class).getId());
  80         Assert.assertEquals(DUMMY_TABLE_ID, flowRefValue.firstKeyOf(Table.class).getId());
  81         Assert.assertEquals(DUMMY_FLOW_ID, flowRefValue.firstKeyOf(Flow.class).getId());
  82     }
  83
  84     @Test
  85     public void testCreateCumulatingFunction() throws Exception {
  86         final Function<List<RpcResult<String>>, RpcResult<List<BatchFailedFlowsOutput>>> function =
  87                 FlowUtil.createCumulatingFunction(Lists.newArrayList(createBatchFlowIdGrouping(DUMMY_FLOW_ID),
  88                         createBatchFlowIdGrouping(DUMMY_FLOW_ID_2)));
  89
  90         final RpcResult<List<BatchFailedFlowsOutput>> summary = function.apply(Lists.newArrayList(
  91                 RpcResultBuilder.success("a").build(),
  92                 RpcResultBuilder.<String>failed()
  93                         .withError(RpcError.ErrorType.APPLICATION, "action-failed reason")
  94                         .build()));
  95
  96         Assert.assertFalse(summary.isSuccessful());
  97         Assert.assertEquals(1, summary.getResult().size());
  98         Assert.assertEquals(1, summary.getErrors().size());
  99         Assert.assertEquals(DUMMY_FLOW_ID_2, summary.getResult().get(0).getFlowId());
 100         Assert.assertEquals(1, summary.getResult().get(0).getBatchOrder().intValue());
 101     }
 102
 103     protected BatchFlowIdGrouping createBatchFlowIdGrouping(final FlowId flowId) {
 104         final BatchFlowIdGrouping mock = Mockito.mock(BatchFlowIdGrouping.class);
 105         Mockito.when(mock.getFlowId()).thenReturn(flowId);
 106         return mock;
 107     }
 108
 109     @Test
 110     public void testFLOW_ADD_TRANSFORM__failure() throws Exception {
 111         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
 112         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
 113     }
 114
 115     @Test
 116     public void testFLOW_ADD_TRANSFORM__success() throws Exception {
 117         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
 118         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
 119     }
 120
 121     @Test
 122     public void testFLOW_REMOVE_TRANSFORM__failure() throws Exception {
 123         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
 124         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
 125     }
 126
 127     @Test
 128     public void testFLOW_REMOVE_TRANSFORM__success() throws Exception {
 129         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
 130         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
 131     }
 132
 133     @Test
 134     public void testFLOW_UPDATE_TRANSFORM__failure() throws Exception {
 135         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
 136         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
 137     }
 138
 139     @Test
 140     public void testFLOW_UPDATE_TRANSFORM__success() throws Exception {
 141         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
 142         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
 143     }
 144
 145     private <T extends BatchFlowOutputListGrouping> void checkBatchSuccessOutcomeTransformation(final RpcResult<T> output) {
 146         Assert.assertTrue(output.isSuccessful());
 147         Assert.assertEquals(0, output.getResult().getBatchFailedFlowsOutput().size());
 148         Assert.assertEquals(0, output.getErrors().size());
 149     }
 150
 151     private RpcResult<List<BatchFailedFlowsOutput>> createEmptyBatchOutcome() {
 152         return RpcResultBuilder
 153                 .<List<BatchFailedFlowsOutput>>success(Collections.<BatchFailedFlowsOutput>emptyList())
 154                 .build();
 155     }
 156
 157     private RpcResult<List<BatchFailedFlowsOutput>> createBatchOutcomeWithError() {
 158         return RpcResultBuilder.<List<BatchFailedFlowsOutput>>failed()
 159                 .withError(RpcError.ErrorType.APPLICATION, "ut-flowAddFail")
 160                 .withResult(Collections.singletonList(new BatchFailedFlowsOutputBuilder()
 161                         .setFlowId(DUMMY_FLOW_ID)
 162                         .build()))
 163                 .build();
 164     }
 165
 166     private <T extends BatchFlowOutputListGrouping> void checkBatchErrorOutcomeTransformation(final RpcResult<T> output) {
 167         Assert.assertFalse(output.isSuccessful());
 168         Assert.assertEquals(1, output.getResult().getBatchFailedFlowsOutput().size());
 169         Assert.assertEquals(DUMMY_FLOW_ID, output.getResult().getBatchFailedFlowsOutput().get(0).getFlowId());
 170
 171         Assert.assertEquals(1, output.getErrors().size());
 172     }
 173
 174     @Test
 175     public void testCreateComposingFunction_success_success() throws Exception {
 176         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
 177                 FlowUtil.createComposingFunction();
 178
 179         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
 180         final RpcResult<Void> barrierOutput = RpcResultBuilder.<Void>success().build();
 181         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
 182         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 183
 184         Assert.assertTrue(composite.isSuccessful());
 185         Assert.assertEquals(0, composite.getErrors().size());
 186         Assert.assertEquals(0, composite.getResult().getBatchFailedFlowsOutput().size());
 187     }
 188
 189     @Test
 190     public void testCreateComposingFunction_failure_success() throws Exception {
 191         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
 192                 FlowUtil.createComposingFunction();
 193
 194         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
 195         final RpcResult<Void> barrierOutput = RpcResultBuilder.<Void>success().build();
 196         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
 197         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 198
 199         Assert.assertFalse(composite.isSuccessful());
 200         Assert.assertEquals(1, composite.getErrors().size());
 201         Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
 202     }
 203
 204     @Test
 205     public void testCreateComposingFunction_success_failure() throws Exception {
 206         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
 207                 FlowUtil.createComposingFunction();
 208
 209         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
 210         final RpcResult<Void> barrierOutput = createBarrierFailureOutcome();
 211         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
 212         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 213
 214         Assert.assertFalse(composite.isSuccessful());
 215         Assert.assertEquals(1, composite.getErrors().size());
 216         Assert.assertEquals(0, composite.getResult().getBatchFailedFlowsOutput().size());
 217     }
 218
 219     @Test
 220     public void testCreateComposingFunction_failure_failure() throws Exception {
 221         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>>, RpcResult<AddFlowsBatchOutput>> compositeFunction =
 222                 FlowUtil.createComposingFunction();
 223
 224         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
 225         final RpcResult<Void> barrierOutput = createBarrierFailureOutcome();
 226         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<Void>> input = Pair.of(addFlowBatchOutput, barrierOutput);
 227         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 228
 229         Assert.assertFalse(composite.isSuccessful());
 230         Assert.assertEquals(2, composite.getErrors().size());
 231         Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
 232     }
 233
 234     private RpcResult<Void> createBarrierFailureOutcome() {
 235         return RpcResultBuilder.<Void>failed()
 236                 .withError(RpcError.ErrorType.APPLICATION, "ut-barrier-error")
 237                 .build();
 238     }
 239
 240     private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchSuccessOutput() {
 241         return RpcResultBuilder
 242                 .success(new AddFlowsBatchOutputBuilder()
 243                         .setBatchFailedFlowsOutput(Collections.<BatchFailedFlowsOutput>emptyList())
 244                         .build())
 245                 .build();
 246     }
 247
 248     private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchFailureOutcome() {
 249         final RpcResult<List<BatchFailedFlowsOutput>> batchOutcomeWithError = createBatchOutcomeWithError();
 250         return RpcResultBuilder.<AddFlowsBatchOutput>failed()
 251                 .withResult(new AddFlowsBatchOutputBuilder()
 252                         .setBatchFailedFlowsOutput(batchOutcomeWithError.getResult())
 253                         .build())
 254                 .withRpcErrors(batchOutcomeWithError.getErrors())
 255                 .build();
 256     }
 257 }