openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/util/MeterUtilTest.java

   1 /*
   2  * Copyright (c) 2016 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 java.util.Map;
  16 import org.apache.commons.lang3.tuple.Pair;
  17 import org.junit.Assert;
  18 import org.junit.Test;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierOutput;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterRef;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.AddMetersBatchOutput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.AddMetersBatchOutputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.BatchMeterOutputListGrouping;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.batch.meter.output.list.grouping.BatchFailedMetersOutput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.batch.meter.output.list.grouping.BatchFailedMetersOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.batch.meter.output.list.grouping.BatchFailedMetersOutputKey;
  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 /**
  40  * Test for {@link MeterUtil}.
  41  */
  42 public class MeterUtilTest {
  43
  44     public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
  45     private static final MeterId DUMMY_METER_ID = new MeterId(42L);
  46     private static final MeterId DUMMY_METER_ID_2 = new MeterId(43L);
  47
  48     @Test
  49     public void testBuildGroupPath() {
  50         final InstanceIdentifier<Node> nodePath = InstanceIdentifier
  51                 .create(Nodes.class)
  52                 .child(Node.class, new NodeKey(DUMMY_NODE_ID));
  53
  54         final MeterRef meterRef = MeterUtil.buildMeterPath(nodePath, DUMMY_METER_ID);
  55         final InstanceIdentifier<?> meterRefValue = meterRef.getValue();
  56         Assert.assertEquals(DUMMY_NODE_ID, meterRefValue.firstKeyOf(Node.class).getId());
  57         Assert.assertEquals(DUMMY_METER_ID, meterRefValue.firstKeyOf(Meter.class).getMeterId());
  58     }
  59
  60     @Test
  61     public void testCreateCumulatingFunction() {
  62         final Function<List<RpcResult<String>>, RpcResult<List<BatchFailedMetersOutput>>> function =
  63                 MeterUtil.createCumulativeFunction(Lists.newArrayList(
  64                         createBatchMeter(DUMMY_METER_ID),
  65                         createBatchMeter(DUMMY_METER_ID_2)));
  66
  67         final RpcResult<List<BatchFailedMetersOutput>> output = function.apply(Lists.newArrayList(
  68                 RpcResultBuilder.success("a").build(),
  69                 RpcResultBuilder.<String>failed()
  70                         .withError(RpcError.ErrorType.APPLICATION, "ut-meter-error")
  71                         .build()));
  72
  73         Assert.assertFalse(output.isSuccessful());
  74         Assert.assertEquals(1, output.getResult().size());
  75         Assert.assertEquals(DUMMY_METER_ID_2, output.getResult().get(0).getMeterId());
  76         Assert.assertEquals(1, output.getResult().get(0).getBatchOrder().intValue());
  77     }
  78
  79     private org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter createBatchMeter(
  80             final MeterId meterId) {
  81         return new MeterBuilder()
  82                 .setMeterId(meterId)
  83                 .build();
  84     }
  85
  86     @Test
  87     public void testMeterAddTransformFailure() {
  88         final RpcResult<List<BatchFailedMetersOutput>> input = createBatchOutcomeWithError();
  89         checkBatchErrorOutcomeTransformation(MeterUtil.METER_ADD_TRANSFORM.apply(input));
  90     }
  91
  92     @Test
  93     public void testMeterAddTransformSuccess() {
  94         final RpcResult<List<BatchFailedMetersOutput>> input = createEmptyBatchOutcome();
  95         checkBatchSuccessOutcomeTransformation(MeterUtil.METER_ADD_TRANSFORM.apply(input));
  96     }
  97
  98     @Test
  99     public void testMeterRemoveTransformFailure() {
 100         final RpcResult<List<BatchFailedMetersOutput>> input = createBatchOutcomeWithError();
 101         checkBatchErrorOutcomeTransformation(MeterUtil.METER_REMOVE_TRANSFORM.apply(input));
 102     }
 103
 104     @Test
 105     public void testFlowRemoveTransformSuccess() {
 106         final RpcResult<List<BatchFailedMetersOutput>> input = createEmptyBatchOutcome();
 107         checkBatchSuccessOutcomeTransformation(MeterUtil.METER_REMOVE_TRANSFORM.apply(input));
 108     }
 109
 110     @Test
 111     public void testFlowUpdateTransformFailure() {
 112         final RpcResult<List<BatchFailedMetersOutput>> input = createBatchOutcomeWithError();
 113         checkBatchErrorOutcomeTransformation(MeterUtil.METER_UPDATE_TRANSFORM.apply(input));
 114     }
 115
 116     @Test
 117     public void testFlowUpdateTransformSuccess() {
 118         final RpcResult<List<BatchFailedMetersOutput>> input = createEmptyBatchOutcome();
 119         checkBatchSuccessOutcomeTransformation(MeterUtil.METER_UPDATE_TRANSFORM.apply(input));
 120     }
 121
 122     private static <T extends BatchMeterOutputListGrouping> void checkBatchSuccessOutcomeTransformation(
 123             final RpcResult<T> output) {
 124         Assert.assertTrue(output.isSuccessful());
 125         Assert.assertEquals(0, output.getResult().nonnullBatchFailedMetersOutput().size());
 126         Assert.assertEquals(0, output.getErrors().size());
 127     }
 128
 129     private static RpcResult<List<BatchFailedMetersOutput>> createEmptyBatchOutcome() {
 130         return RpcResultBuilder
 131                 .success(Collections.<BatchFailedMetersOutput>emptyList())
 132                 .build();
 133     }
 134
 135     private static RpcResult<List<BatchFailedMetersOutput>> createBatchOutcomeWithError() {
 136         return RpcResultBuilder.<List<BatchFailedMetersOutput>>failed()
 137                 .withError(RpcError.ErrorType.APPLICATION, "ut-flowAddFail")
 138                 .withResult(Collections.singletonList(new BatchFailedMetersOutputBuilder()
 139                         .setMeterId(DUMMY_METER_ID)
 140                         .build()))
 141                 .build();
 142     }
 143
 144     private static <T extends BatchMeterOutputListGrouping> void checkBatchErrorOutcomeTransformation(
 145             final RpcResult<T> output) {
 146         Assert.assertFalse(output.isSuccessful());
 147         Assert.assertEquals(1, output.getResult().nonnullBatchFailedMetersOutput().size());
 148         Assert.assertEquals(DUMMY_METER_ID,
 149             output.getResult().nonnullBatchFailedMetersOutput().values().iterator().next().getMeterId());
 150
 151         Assert.assertEquals(1, output.getErrors().size());
 152     }
 153
 154     @Test
 155     public void testCreateComposingFunction_success_success() {
 156         final Function<Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>>,
 157                 RpcResult<AddMetersBatchOutput>> compositeFunction = MeterUtil.createComposingFunction();
 158
 159         final RpcResult<AddMetersBatchOutput> addGroupBatchOutput = createAddMetersBatchSuccessOutput();
 160         final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
 161         final Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>> input =
 162                 Pair.of(addGroupBatchOutput, barrierOutput);
 163         final RpcResult<AddMetersBatchOutput> composite = compositeFunction.apply(input);
 164
 165         Assert.assertTrue(composite.isSuccessful());
 166         Assert.assertEquals(0, composite.getErrors().size());
 167         Map<BatchFailedMetersOutputKey, BatchFailedMetersOutput> failedMeters
 168                 = composite.getResult().nonnullBatchFailedMetersOutput();
 169         Assert.assertEquals(0, failedMeters.size());
 170     }
 171
 172     @Test
 173     public void testCreateComposingFunction_failure_success() {
 174         final Function<Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>>,
 175                 RpcResult<AddMetersBatchOutput>> compositeFunction = MeterUtil.createComposingFunction();
 176
 177         final RpcResult<AddMetersBatchOutput> addGroupBatchOutput = createAddMetersBatchFailureOutcome();
 178         final RpcResult<SendBarrierOutput> barrierOutput = RpcResultBuilder.<SendBarrierOutput>success().build();
 179         final Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>> input =
 180                 Pair.of(addGroupBatchOutput, barrierOutput);
 181         final RpcResult<AddMetersBatchOutput> composite = compositeFunction.apply(input);
 182
 183         Assert.assertFalse(composite.isSuccessful());
 184         Assert.assertEquals(1, composite.getErrors().size());
 185         Assert.assertEquals(1, composite.getResult().getBatchFailedMetersOutput().size());
 186     }
 187
 188     @Test
 189     public void testCreateComposingFunction_success_failure() {
 190         final Function<Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>>,
 191                 RpcResult<AddMetersBatchOutput>> compositeFunction = MeterUtil.createComposingFunction();
 192
 193         final RpcResult<AddMetersBatchOutput> addGroupBatchOutput = createAddMetersBatchSuccessOutput();
 194         final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
 195         final Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>> input =
 196                 Pair.of(addGroupBatchOutput, barrierOutput);
 197         final RpcResult<AddMetersBatchOutput> composite = compositeFunction.apply(input);
 198
 199         Assert.assertFalse(composite.isSuccessful());
 200         Assert.assertEquals(1, composite.getErrors().size());
 201         Map<BatchFailedMetersOutputKey, BatchFailedMetersOutput> failedMeters
 202                 = composite.getResult().nonnullBatchFailedMetersOutput();
 203         Assert.assertEquals(0, failedMeters.size());
 204     }
 205
 206     @Test
 207     public void testCreateComposingFunction_failure_failure() {
 208         final Function<Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>>,
 209                 RpcResult<AddMetersBatchOutput>> compositeFunction = MeterUtil.createComposingFunction();
 210
 211         final RpcResult<AddMetersBatchOutput> addGroupBatchOutput = createAddMetersBatchFailureOutcome();
 212         final RpcResult<SendBarrierOutput> barrierOutput = createBarrierFailureOutcome();
 213         final Pair<RpcResult<AddMetersBatchOutput>, RpcResult<SendBarrierOutput>> input =
 214                 Pair.of(addGroupBatchOutput, barrierOutput);
 215         final RpcResult<AddMetersBatchOutput> composite = compositeFunction.apply(input);
 216
 217         Assert.assertFalse(composite.isSuccessful());
 218         Assert.assertEquals(2, composite.getErrors().size());
 219         Assert.assertEquals(1, composite.getResult().getBatchFailedMetersOutput().size());
 220     }
 221
 222     private RpcResult<SendBarrierOutput> createBarrierFailureOutcome() {
 223         return RpcResultBuilder.<SendBarrierOutput>failed()
 224                 .withError(RpcError.ErrorType.APPLICATION, "ut-barrier-error")
 225                 .build();
 226     }
 227
 228     private RpcResult<AddMetersBatchOutput> createAddMetersBatchSuccessOutput() {
 229         return RpcResultBuilder
 230                 .success(new AddMetersBatchOutputBuilder()
 231                         .setBatchFailedMetersOutput(Collections.emptyMap())
 232                         .build())
 233                 .build();
 234     }
 235
 236     private RpcResult<AddMetersBatchOutput> createAddMetersBatchFailureOutcome() {
 237         final RpcResult<List<BatchFailedMetersOutput>> batchOutcomeWithError = createBatchOutcomeWithError();
 238         return RpcResultBuilder.<AddMetersBatchOutput>failed()
 239                 .withResult(new AddMetersBatchOutputBuilder()
 240                         .setBatchFailedMetersOutput(batchOutcomeWithError.getResult())
 241                         .build())
 242                 .withRpcErrors(batchOutcomeWithError.getErrors())
 243                 .build();
 244     }
 245 }