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