openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/util/GroupUtilTest.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.group.types.rev131018.GroupId;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupRef;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.AddGroupsBatchOutput;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.AddGroupsBatchOutputBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.BatchGroupOutputListGrouping;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.batch.group.output.list.grouping.BatchFailedGroupsOutput;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.batch.group.output.list.grouping.BatchFailedGroupsOutputBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  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 GroupUtil}.
  38  */
  39 public class GroupUtilTest {
  40
  41     public static final NodeId DUMMY_NODE_ID = new NodeId("dummyNodeId");
  42     private static final GroupId DUMMY_GROUP_ID = new GroupId(42L);
  43     private static final GroupId DUMMY_GROUP_ID_2 = new GroupId(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 GroupRef groupRef = GroupUtil.buildGroupPath(nodePath, DUMMY_GROUP_ID);
  52         final InstanceIdentifier<?> groupRefValue = groupRef.getValue();
  53         Assert.assertEquals(DUMMY_NODE_ID, groupRefValue.firstKeyOf(Node.class).getId());
  54         Assert.assertEquals(DUMMY_GROUP_ID, groupRefValue.firstKeyOf(Group.class).getGroupId());
  55     }
  56
  57     @Test
  58     public void testCreateCumulatingFunction() throws Exception {
  59         final Function<List<RpcResult<String>>, RpcResult<List<BatchFailedGroupsOutput>>> function =
  60                 GroupUtil.createCumulatingFunction(Lists.newArrayList(createBatchGroup(DUMMY_GROUP_ID),
  61                         createBatchGroup(DUMMY_GROUP_ID_2)));
  62
  63         final RpcResult<List<BatchFailedGroupsOutput>> summary = function.apply(Lists.newArrayList(
  64                 RpcResultBuilder.success("a").build(),
  65                 RpcResultBuilder.<String>failed()
  66                         .withError(RpcError.ErrorType.APPLICATION, "action-failed reason")
  67                         .build()));
  68
  69         Assert.assertFalse(summary.isSuccessful());
  70         Assert.assertEquals(1, summary.getResult().size());
  71         Assert.assertEquals(1, summary.getErrors().size());
  72         Assert.assertEquals(DUMMY_GROUP_ID_2, summary.getResult().get(0).getGroupId());
  73         Assert.assertEquals(1, summary.getResult().get(0).getBatchOrder().intValue());
  74     }
  75
  76     protected Group createBatchGroup(final GroupId groupId) {
  77         return new GroupBuilder().setGroupId(groupId).build();
  78     }
  79
  80     @Test
  81     public void testGROUP_ADD_TRANSFORM__failure() throws Exception {
  82         final RpcResult<List<BatchFailedGroupsOutput>> input = createBatchOutcomeWithError();
  83         checkBatchErrorOutcomeTransformation(GroupUtil.GROUP_ADD_TRANSFORM.apply(input));
  84     }
  85
  86     @Test
  87     public void testGROUP_ADD_TRANSFORM__success() throws Exception {
  88         final RpcResult<List<BatchFailedGroupsOutput>> input = createEmptyBatchOutcome();
  89         checkBatchSuccessOutcomeTransformation(GroupUtil.GROUP_ADD_TRANSFORM.apply(input));
  90     }
  91
  92     @Test
  93     public void testGROUP_REMOVE_TRANSFORM__failure() throws Exception {
  94         final RpcResult<List<BatchFailedGroupsOutput>> input = createBatchOutcomeWithError();
  95         checkBatchErrorOutcomeTransformation(GroupUtil.GROUP_REMOVE_TRANSFORM.apply(input));
  96     }
  97
  98     @Test
  99     public void testFLOW_REMOVE_TRANSFORM__success() throws Exception {
 100         final RpcResult<List<BatchFailedGroupsOutput>> input = createEmptyBatchOutcome();
 101         checkBatchSuccessOutcomeTransformation(GroupUtil.GROUP_REMOVE_TRANSFORM.apply(input));
 102     }
 103
 104     @Test
 105     public void testFLOW_UPDATE_TRANSFORM__failure() throws Exception {
 106         final RpcResult<List<BatchFailedGroupsOutput>> input = createBatchOutcomeWithError();
 107         checkBatchErrorOutcomeTransformation(GroupUtil.GROUP_UPDATE_TRANSFORM.apply(input));
 108     }
 109
 110     @Test
 111     public void testFLOW_UPDATE_TRANSFORM__success() throws Exception {
 112         final RpcResult<List<BatchFailedGroupsOutput>> input = createEmptyBatchOutcome();
 113         checkBatchSuccessOutcomeTransformation(GroupUtil.GROUP_UPDATE_TRANSFORM.apply(input));
 114     }
 115
 116     private <T extends BatchGroupOutputListGrouping> void checkBatchSuccessOutcomeTransformation(final RpcResult<T> output) {
 117         Assert.assertTrue(output.isSuccessful());
 118         Assert.assertEquals(0, output.getResult().getBatchFailedGroupsOutput().size());
 119         Assert.assertEquals(0, output.getErrors().size());
 120     }
 121
 122     private RpcResult<List<BatchFailedGroupsOutput>> createEmptyBatchOutcome() {
 123         return RpcResultBuilder
 124                 .<List<BatchFailedGroupsOutput>>success(Collections.<BatchFailedGroupsOutput>emptyList())
 125                 .build();
 126     }
 127
 128     private RpcResult<List<BatchFailedGroupsOutput>> createBatchOutcomeWithError() {
 129         return RpcResultBuilder.<List<BatchFailedGroupsOutput>>failed()
 130                 .withError(RpcError.ErrorType.APPLICATION, "ut-flowAddFail")
 131                 .withResult(Collections.singletonList(new BatchFailedGroupsOutputBuilder()
 132                         .setGroupId(DUMMY_GROUP_ID)
 133                         .build()))
 134                 .build();
 135     }
 136
 137     private <T extends BatchGroupOutputListGrouping> void checkBatchErrorOutcomeTransformation(final RpcResult<T> output) {
 138         Assert.assertFalse(output.isSuccessful());
 139         Assert.assertEquals(1, output.getResult().getBatchFailedGroupsOutput().size());
 140         Assert.assertEquals(DUMMY_GROUP_ID, output.getResult().getBatchFailedGroupsOutput().get(0).getGroupId());
 141
 142         Assert.assertEquals(1, output.getErrors().size());
 143     }
 144
 145     @Test
 146     public void testCreateComposingFunction_success_success() throws Exception {
 147         final Function<Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>>, RpcResult<AddGroupsBatchOutput>> compositeFunction =
 148                 GroupUtil.createComposingFunction();
 149
 150         final RpcResult<AddGroupsBatchOutput> addGroupBatchOutput = createAddGroupsBatchSuccessOutput();
 151         final RpcResult<Void> barrierOutput = RpcResultBuilder.<Void>success().build();
 152         final Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>> input = Pair.of(addGroupBatchOutput, barrierOutput);
 153         final RpcResult<AddGroupsBatchOutput> composite = compositeFunction.apply(input);
 154
 155         Assert.assertTrue(composite.isSuccessful());
 156         Assert.assertEquals(0, composite.getErrors().size());
 157         Assert.assertEquals(0, composite.getResult().getBatchFailedGroupsOutput().size());
 158     }
 159
 160     @Test
 161     public void testCreateComposingFunction_failure_success() throws Exception {
 162         final Function<Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>>, RpcResult<AddGroupsBatchOutput>> compositeFunction =
 163                 GroupUtil.createComposingFunction();
 164
 165         final RpcResult<AddGroupsBatchOutput> addGroupBatchOutput = createAddGroupsBatchFailureOutcome();
 166         final RpcResult<Void> barrierOutput = RpcResultBuilder.<Void>success().build();
 167         final Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>> input = Pair.of(addGroupBatchOutput, barrierOutput);
 168         final RpcResult<AddGroupsBatchOutput> composite = compositeFunction.apply(input);
 169
 170         Assert.assertFalse(composite.isSuccessful());
 171         Assert.assertEquals(1, composite.getErrors().size());
 172         Assert.assertEquals(1, composite.getResult().getBatchFailedGroupsOutput().size());
 173     }
 174
 175     @Test
 176     public void testCreateComposingFunction_success_failure() throws Exception {
 177         final Function<Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>>, RpcResult<AddGroupsBatchOutput>> compositeFunction =
 178                 GroupUtil.createComposingFunction();
 179
 180         final RpcResult<AddGroupsBatchOutput> addGroupBatchOutput = createAddGroupsBatchSuccessOutput();
 181         final RpcResult<Void> barrierOutput = createBarrierFailureOutcome();
 182         final Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>> input = Pair.of(addGroupBatchOutput, barrierOutput);
 183         final RpcResult<AddGroupsBatchOutput> composite = compositeFunction.apply(input);
 184
 185         Assert.assertFalse(composite.isSuccessful());
 186         Assert.assertEquals(1, composite.getErrors().size());
 187         Assert.assertEquals(0, composite.getResult().getBatchFailedGroupsOutput().size());
 188     }
 189
 190     @Test
 191     public void testCreateComposingFunction_failure_failure() throws Exception {
 192         final Function<Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>>, RpcResult<AddGroupsBatchOutput>> compositeFunction =
 193                 GroupUtil.createComposingFunction();
 194
 195         final RpcResult<AddGroupsBatchOutput> addGroupBatchOutput = createAddGroupsBatchFailureOutcome();
 196         final RpcResult<Void> barrierOutput = createBarrierFailureOutcome();
 197         final Pair<RpcResult<AddGroupsBatchOutput>, RpcResult<Void>> input = Pair.of(addGroupBatchOutput, barrierOutput);
 198         final RpcResult<AddGroupsBatchOutput> composite = compositeFunction.apply(input);
 199
 200         Assert.assertFalse(composite.isSuccessful());
 201         Assert.assertEquals(2, composite.getErrors().size());
 202         Assert.assertEquals(1, composite.getResult().getBatchFailedGroupsOutput().size());
 203     }
 204
 205     private RpcResult<Void> createBarrierFailureOutcome() {
 206         return RpcResultBuilder.<Void>failed()
 207                 .withError(RpcError.ErrorType.APPLICATION, "ut-barrier-error")
 208                 .build();
 209     }
 210
 211     private RpcResult<AddGroupsBatchOutput> createAddGroupsBatchSuccessOutput() {
 212         return RpcResultBuilder
 213                 .success(new AddGroupsBatchOutputBuilder()
 214                         .setBatchFailedGroupsOutput(Collections.<BatchFailedGroupsOutput>emptyList())
 215                         .build())
 216                 .build();
 217     }
 218
 219     private RpcResult<AddGroupsBatchOutput> createAddGroupsBatchFailureOutcome() {
 220         final RpcResult<List<BatchFailedGroupsOutput>> batchOutcomeWithError = createBatchOutcomeWithError();
 221         return RpcResultBuilder.<AddGroupsBatchOutput>failed()
 222                 .withResult(new AddGroupsBatchOutputBuilder()
 223                         .setBatchFailedGroupsOutput(batchOutcomeWithError.getResult())
 224                         .build())
 225                 .withRpcErrors(batchOutcomeWithError.getErrors())
 226                 .build();
 227     }
 228 }