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 package org.opendaylight.openflowplugin.impl.util;
   9
  10 import com.google.common.collect.Lists;
  11 import java.util.Collections;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.function.Function;
  15 import org.apache.commons.lang3.tuple.Pair;
  16 import org.junit.Assert;
  17 import org.junit.Test;
  18 import org.mockito.Mockito;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierOutput;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowRef;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutput;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.AddFlowsBatchOutputBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowOutputListGrouping;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.common.RpcError;
  37 import org.opendaylight.yangtools.yang.common.RpcResult;
  38 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  39 import org.opendaylight.yangtools.yang.common.Uint16;
  40 import org.opendaylight.yangtools.yang.common.Uint8;
  41
  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;
  47
  48     @Test
  49     public void testBuildFlowPath() {
  50         final InstanceIdentifier<Node> nodePath = InstanceIdentifier
  51                 .create(Nodes.class)
  52                 .child(Node.class, new NodeKey(DUMMY_NODE_ID));
  53
  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());
  59     }
  60
  61     @Test
  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)));
  66
  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")
  71                         .build()));
  72
  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());
  78     }
  79
  80     protected BatchFlowIdGrouping createBatchFlowIdGrouping(final FlowId flowId) {
  81         final BatchFlowIdGrouping mock = Mockito.mock(BatchFlowIdGrouping.class);
  82         Mockito.when(mock.getFlowId()).thenReturn(flowId);
  83         return mock;
  84     }
  85
  86     @Test
  87     public void testFlowAddTransformFailure() {
  88         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
  89         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
  90     }
  91
  92     @Test
  93     public void testFlowAddTransformSuccess() {
  94         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
  95         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
  96     }
  97
  98     @Test
  99     public void testFlowRemoveTransformFailure() {
 100         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
 101         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
 102     }
 103
 104     @Test
 105     public void testFlowRemoveTransformSuccess() {
 106         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
 107         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
 108     }
 109
 110     @Test
 111     public void testFlowUpdateTransformFailure() {
 112         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
 113         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
 114     }
 115
 116     @Test
 117     public void testFlowUpdateTransformSuccess() {
 118         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
 119         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
 120     }
 121
 122     private static <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());
 129     }
 130
 131     private static RpcResult<List<BatchFailedFlowsOutput>> createEmptyBatchOutcome() {
 132         return RpcResultBuilder
 133                 .success(Collections.<BatchFailedFlowsOutput>emptyList())
 134                 .build();
 135     }
 136
 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)
 142                         .setBatchOrder(Uint16.ZERO)
 143                         .build()))
 144                 .build();
 145     }
 146
 147     private static <T extends BatchFlowOutputListGrouping> void checkBatchErrorOutcomeTransformation(
 148             final RpcResult<T> output) {
 149         Assert.assertFalse(output.isSuccessful());
 150         Assert.assertEquals(1, output.getResult().nonnullBatchFailedFlowsOutput().size());
 151         Assert.assertEquals(DUMMY_FLOW_ID,
 152             output.getResult().nonnullBatchFailedFlowsOutput().values().iterator().next().getFlowId());
 153
 154         Assert.assertEquals(1, output.getErrors().size());
 155     }
 156
 157     @Test
 158     public void testCreateComposingFunction_success_success() {
 159         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 160                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 161
 162         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
 163         final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
 164         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 165                 = Pair.of(addFlowBatchOutput, barrierOutput);
 166         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 167
 168         Assert.assertTrue(composite.isSuccessful());
 169         Assert.assertEquals(0, composite.getErrors().size());
 170         Map<BatchFailedFlowsOutputKey, BatchFailedFlowsOutput> failedFlows
 171                 = composite.getResult().nonnullBatchFailedFlowsOutput();
 172         Assert.assertEquals(0, failedFlows.size());
 173     }
 174
 175     @Test
 176     public void testCreateComposingFunction_failure_success() {
 177         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 178                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 179
 180         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
 181         final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
 182         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 183                 = Pair.of(addFlowBatchOutput, barrierOutput);
 184         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 185
 186         Assert.assertFalse(composite.isSuccessful());
 187         Assert.assertEquals(1, composite.getErrors().size());
 188         Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
 189     }
 190
 191     @Test
 192     public void testCreateComposingFunction_success_failure() {
 193         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 194                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 195
 196         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
 197         final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
 198         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 199                 = Pair.of(addFlowBatchOutput, barrierOutput);
 200         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 201
 202         Assert.assertFalse(composite.isSuccessful());
 203         Assert.assertEquals(1, composite.getErrors().size());
 204         Map<BatchFailedFlowsOutputKey, BatchFailedFlowsOutput> failedFlows
 205                 = composite.getResult().nonnullBatchFailedFlowsOutput();
 206         Assert.assertEquals(0, failedFlows.size());
 207     }
 208
 209     @Test
 210     public void testCreateComposingFunction_failure_failure() {
 211         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 212                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 213
 214         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
 215         final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
 216         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 217                 = Pair.of(addFlowBatchOutput, barrierOutput);
 218         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 219
 220         Assert.assertFalse(composite.isSuccessful());
 221         Assert.assertEquals(2, composite.getErrors().size());
 222         Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
 223     }
 224
 225     private static RpcResult<SendBarrierOutput> createBarrierFailureOutcome() {
 226         return RpcResultBuilder.<SendBarrierOutput>failed()
 227                 .withError(RpcError.ErrorType.APPLICATION, "ut-barrier-error")
 228                 .build();
 229     }
 230
 231     private static RpcResult<AddFlowsBatchOutput> createAddFlowsBatchSuccessOutput() {
 232         return RpcResultBuilder
 233                 .success(new AddFlowsBatchOutputBuilder()
 234                         .setBatchFailedFlowsOutput(Collections.emptyMap())
 235                         .build())
 236                 .build();
 237     }
 238
 239     private static RpcResult<AddFlowsBatchOutput> createAddFlowsBatchFailureOutcome() {
 240         final RpcResult<List<BatchFailedFlowsOutput>> batchOutcomeWithError = createBatchOutcomeWithError();
 241         return RpcResultBuilder.<AddFlowsBatchOutput>failed()
 242                 .withResult(new AddFlowsBatchOutputBuilder()
 243                         .setBatchFailedFlowsOutput(batchOutcomeWithError.getResult())
 244                         .build())
 245                 .withRpcErrors(batchOutcomeWithError.getErrors())
 246                 .build();
 247     }
 248 }