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