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