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