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 com.google.common.base.Function;
  12 import com.google.common.collect.Lists;
  13 import java.util.Collections;
  14 import java.util.List;
  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.inventory.rev130819.NodeId;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.common.RpcError;
  36 import org.opendaylight.yangtools.yang.common.RpcResult;
  37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  38
  39 public class FlowUtilTest {
  40     public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
  41     public static final FlowId DUMMY_FLOW_ID = new FlowId("dummyFlowId");
  42     public static final FlowId DUMMY_FLOW_ID_2 = new FlowId("dummyFlowId_2");
  43     public static final Short DUMMY_TABLE_ID = 1;
  44
  45     @Test
  46     public void testBuildFlowPath() throws Exception {
  47         final InstanceIdentifier<Node> nodePath = InstanceIdentifier
  48                 .create(Nodes.class)
  49                 .child(Node.class, new NodeKey(DUMMY_NODE_ID));
  50
  51         final FlowRef flowRef = FlowUtil.buildFlowPath(nodePath, DUMMY_TABLE_ID, DUMMY_FLOW_ID);
  52         final InstanceIdentifier<?> flowRefValue = flowRef.getValue();
  53         Assert.assertEquals(DUMMY_NODE_ID, flowRefValue.firstKeyOf(Node.class).getId());
  54         Assert.assertEquals(DUMMY_TABLE_ID, flowRefValue.firstKeyOf(Table.class).getId());
  55         Assert.assertEquals(DUMMY_FLOW_ID, flowRefValue.firstKeyOf(Flow.class).getId());
  56     }
  57
  58     @Test
  59     public void testCreateCumulatingFunction() throws Exception {
  60         final Function<List<RpcResult<String>>, RpcResult<List<BatchFailedFlowsOutput>>> function =
  61                 FlowUtil.createCumulatingFunction(Lists.newArrayList(createBatchFlowIdGrouping(DUMMY_FLOW_ID),
  62                         createBatchFlowIdGrouping(DUMMY_FLOW_ID_2)));
  63
  64         final RpcResult<List<BatchFailedFlowsOutput>> summary = function.apply(Lists.newArrayList(
  65                 RpcResultBuilder.success("a").build(),
  66                 RpcResultBuilder.<String>failed()
  67                         .withError(RpcError.ErrorType.APPLICATION, "action-failed reason")
  68                         .build()));
  69
  70         Assert.assertFalse(summary.isSuccessful());
  71         Assert.assertEquals(1, summary.getResult().size());
  72         Assert.assertEquals(1, summary.getErrors().size());
  73         Assert.assertEquals(DUMMY_FLOW_ID_2, summary.getResult().get(0).getFlowId());
  74         Assert.assertEquals(1, summary.getResult().get(0).getBatchOrder().intValue());
  75     }
  76
  77     protected BatchFlowIdGrouping createBatchFlowIdGrouping(final FlowId flowId) {
  78         final BatchFlowIdGrouping mock = Mockito.mock(BatchFlowIdGrouping.class);
  79         Mockito.when(mock.getFlowId()).thenReturn(flowId);
  80         return mock;
  81     }
  82
  83     @Test
  84     public void testFlowAddTransformFailure() throws Exception {
  85         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
  86         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
  87     }
  88
  89     @Test
  90     public void testFlowAddTransformSuccess() throws Exception {
  91         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
  92         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_ADD_TRANSFORM.apply(input));
  93     }
  94
  95     @Test
  96     public void testFlowRemoveTransformFailure() throws Exception {
  97         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
  98         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
  99     }
 100
 101     @Test
 102     public void testFlowRemoveTransformSuccess() throws Exception {
 103         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
 104         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_REMOVE_TRANSFORM.apply(input));
 105     }
 106
 107     @Test
 108     public void testFlowUpdateTransformFailure() throws Exception {
 109         final RpcResult<List<BatchFailedFlowsOutput>> input = createBatchOutcomeWithError();
 110         checkBatchErrorOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
 111     }
 112
 113     @Test
 114     public void testFlowUpdateTransformSuccess() throws Exception {
 115         final RpcResult<List<BatchFailedFlowsOutput>> input = createEmptyBatchOutcome();
 116         checkBatchSuccessOutcomeTransformation(FlowUtil.FLOW_UPDATE_TRANSFORM.apply(input));
 117     }
 118
 119     private <T extends BatchFlowOutputListGrouping> void checkBatchSuccessOutcomeTransformation(
 120             final RpcResult<T> output) {
 121         Assert.assertTrue(output.isSuccessful());
 122         Assert.assertEquals(0, output.getResult().getBatchFailedFlowsOutput().size());
 123         Assert.assertEquals(0, output.getErrors().size());
 124     }
 125
 126     private RpcResult<List<BatchFailedFlowsOutput>> createEmptyBatchOutcome() {
 127         return RpcResultBuilder
 128                 .success(Collections.<BatchFailedFlowsOutput>emptyList())
 129                 .build();
 130     }
 131
 132     private RpcResult<List<BatchFailedFlowsOutput>> createBatchOutcomeWithError() {
 133         return RpcResultBuilder.<List<BatchFailedFlowsOutput>>failed()
 134                 .withError(RpcError.ErrorType.APPLICATION, "ut-flowAddFail")
 135                 .withResult(Collections.singletonList(new BatchFailedFlowsOutputBuilder()
 136                         .setFlowId(DUMMY_FLOW_ID)
 137                         .build()))
 138                 .build();
 139     }
 140
 141     private <T extends BatchFlowOutputListGrouping> void checkBatchErrorOutcomeTransformation(
 142             final RpcResult<T> output) {
 143         Assert.assertFalse(output.isSuccessful());
 144         Assert.assertEquals(1, output.getResult().getBatchFailedFlowsOutput().size());
 145         Assert.assertEquals(DUMMY_FLOW_ID, output.getResult().getBatchFailedFlowsOutput().get(0).getFlowId());
 146
 147         Assert.assertEquals(1, output.getErrors().size());
 148     }
 149
 150     @Test
 151     public void testCreateComposingFunction_success_success() throws Exception {
 152         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 153                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 154
 155         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
 156         final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
 157         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 158                 = Pair.of(addFlowBatchOutput, barrierOutput);
 159         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 160
 161         Assert.assertTrue(composite.isSuccessful());
 162         Assert.assertEquals(0, composite.getErrors().size());
 163         Assert.assertEquals(0, composite.getResult().getBatchFailedFlowsOutput().size());
 164     }
 165
 166     @Test
 167     public void testCreateComposingFunction_failure_success() throws Exception {
 168         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 169                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 170
 171         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
 172         final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
 173         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 174                 = Pair.of(addFlowBatchOutput, barrierOutput);
 175         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 176
 177         Assert.assertFalse(composite.isSuccessful());
 178         Assert.assertEquals(1, composite.getErrors().size());
 179         Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
 180     }
 181
 182     @Test
 183     public void testCreateComposingFunction_success_failure() throws Exception {
 184         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 185                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 186
 187         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchSuccessOutput();
 188         final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
 189         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 190                 = Pair.of(addFlowBatchOutput, barrierOutput);
 191         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 192
 193         Assert.assertFalse(composite.isSuccessful());
 194         Assert.assertEquals(1, composite.getErrors().size());
 195         Assert.assertEquals(0, composite.getResult().getBatchFailedFlowsOutput().size());
 196     }
 197
 198     @Test
 199     public void testCreateComposingFunction_failure_failure() throws Exception {
 200         final Function<Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>>,
 201                 RpcResult<AddFlowsBatchOutput>> compositeFunction = FlowUtil.createComposingFunction();
 202
 203         final RpcResult<AddFlowsBatchOutput> addFlowBatchOutput = createAddFlowsBatchFailureOutcome();
 204         final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
 205         final Pair<RpcResult<AddFlowsBatchOutput>, RpcResult<SendBarrierOutput>> input
 206                 = Pair.of(addFlowBatchOutput, barrierOutput);
 207         final RpcResult<AddFlowsBatchOutput> composite = compositeFunction.apply(input);
 208
 209         Assert.assertFalse(composite.isSuccessful());
 210         Assert.assertEquals(2, composite.getErrors().size());
 211         Assert.assertEquals(1, composite.getResult().getBatchFailedFlowsOutput().size());
 212     }
 213
 214     private RpcResult<SendBarrierOutput> createBarrierFailureOutcome() {
 215         return RpcResultBuilder.<SendBarrierOutput>failed()
 216                 .withError(RpcError.ErrorType.APPLICATION, "ut-barrier-error")
 217                 .build();
 218     }
 219
 220     private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchSuccessOutput() {
 221         return RpcResultBuilder
 222                 .success(new AddFlowsBatchOutputBuilder()
 223                         .setBatchFailedFlowsOutput(Collections.emptyList())
 224                         .build())
 225                 .build();
 226     }
 227
 228     private RpcResult<AddFlowsBatchOutput> createAddFlowsBatchFailureOutcome() {
 229         final RpcResult<List<BatchFailedFlowsOutput>> batchOutcomeWithError = createBatchOutcomeWithError();
 230         return RpcResultBuilder.<AddFlowsBatchOutput>failed()
 231                 .withResult(new AddFlowsBatchOutputBuilder()
 232                         .setBatchFailedFlowsOutput(batchOutcomeWithError.getResult())
 233                         .build())
 234                 .withRpcErrors(batchOutcomeWithError.getErrors())
 235                 .build();
 236     }
 237 }