applications/forwardingrules-sync/src/test/java/org/opendaylight/openflowplugin/applications/frsync/util/ReconcileUtilTest.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.applications.frsync.util;
  10
  11 import com.google.common.base.Splitter;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import com.google.common.util.concurrent.SettableFuture;
  15 import java.util.ArrayList;
  16 import java.util.Arrays;
  17 import java.util.Collections;
  18 import java.util.HashMap;
  19 import java.util.HashSet;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.Set;
  23 import org.junit.Assert;
  24 import org.junit.Rule;
  25 import org.junit.Test;
  26 import org.junit.rules.ExpectedException;
  27 import org.junit.runner.RunWith;
  28 import org.mockito.ArgumentCaptor;
  29 import org.mockito.Captor;
  30 import org.mockito.Matchers;
  31 import org.mockito.Mock;
  32 import org.mockito.Mockito;
  33 import org.mockito.runners.MockitoJUnitRunner;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCase;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.group.action._case.GroupAction;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.group.action._case.GroupActionBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.FlowCapableTransactionService;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.Buckets;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.BucketsBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.common.RpcResult;
  55 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  56
  57 /**
  58  * Test for {@link ReconcileUtil}.
  59  */
  60 @RunWith(MockitoJUnitRunner.class)
  61 public class ReconcileUtilTest {
  62
  63     private static final NodeId NODE_ID = new NodeId("unit-node-id");
  64     private final InstanceIdentifier<Node> NODE_IDENT = InstanceIdentifier.create(Nodes.class)
  65             .child(Node.class, new NodeKey(NODE_ID));
  66     private static final Splitter COMMA_SPLITTER = Splitter.on(",");
  67
  68     @Rule
  69     public ExpectedException thrown = ExpectedException.none();
  70     @Mock
  71     private FlowCapableTransactionService flowCapableService;
  72     @Captor
  73     private ArgumentCaptor<SendBarrierInput> barrierInputCaptor;
  74
  75     @Test
  76     public void testChainBarrierFlush() throws Exception {
  77         SettableFuture<RpcResult<Void>> testRabbit = SettableFuture.create();
  78         final ListenableFuture<RpcResult<Void>> vehicle =
  79                 Futures.transform(testRabbit, ReconcileUtil.chainBarrierFlush(NODE_IDENT, flowCapableService));
  80         Mockito.when(flowCapableService.sendBarrier(barrierInputCaptor.capture()))
  81                 .thenReturn(RpcResultBuilder.<Void>success().buildFuture());
  82
  83         Mockito.verify(flowCapableService, Mockito.never()).sendBarrier(Matchers.<SendBarrierInput>any());
  84         Assert.assertFalse(vehicle.isDone());
  85
  86         testRabbit.set(RpcResultBuilder.<Void>success().build());
  87         Mockito.verify(flowCapableService).sendBarrier(Matchers.<SendBarrierInput>any());
  88         Assert.assertTrue(vehicle.isDone());
  89         Assert.assertTrue(vehicle.get().isSuccessful());
  90     }
  91
  92     /**
  93      * add one missing group
  94      *
  95      * @throws Exception
  96      */
  97     @Test
  98     public void testResolveAndDivideGroupDiffs1() throws Exception {
  99         final Map<Long, Group> installedGroups = new HashMap<>();
 100         installedGroups.put(1L, createGroup(1L));
 101         installedGroups.put(2L, createGroup(2L));
 102         installedGroups.put(3L, createGroup(3L));
 103
 104         final List<Group> pendingGroups = new ArrayList<>();
 105         pendingGroups.add(createGroup(2L));
 106         pendingGroups.add(createGroup(3L));
 107         pendingGroups.add(createGroup(4L));
 108
 109         final List<ItemSyncBox<Group>> plan = ReconcileUtil.resolveAndDivideGroupDiffs(
 110                 NODE_ID, installedGroups, pendingGroups);
 111
 112         Assert.assertEquals(1, plan.size());
 113
 114         Assert.assertEquals(1, plan.get(0).getItemsToPush().size());
 115         Assert.assertEquals(4L, plan.get(0).getItemsToPush().iterator().next().getKey().getGroupId().getValue().longValue());
 116         Assert.assertEquals(0, plan.get(0).getItemsToUpdate().size());
 117     }
 118
 119     /**
 120      * add 3 groups with dependencies - 3 steps involved
 121      *
 122      * @throws Exception
 123      */
 124     @Test
 125     public void testResolveAndDivideGroupDiffs2() throws Exception {
 126         final Map<Long, Group> installedGroups = new HashMap<>();
 127         installedGroups.put(1L, createGroup(1L));
 128
 129         final List<Group> pendingGroups = new ArrayList<>();
 130         pendingGroups.add(createGroup(2L));
 131         pendingGroups.add(createGroupWithPreconditions(3L, 2L, 4L));
 132         pendingGroups.add(createGroupWithPreconditions(4L, 2L));
 133
 134         final List<ItemSyncBox<Group>> plan = ReconcileUtil.resolveAndDivideGroupDiffs(
 135                 NODE_ID, installedGroups, pendingGroups);
 136
 137         Assert.assertEquals(3, plan.size());
 138
 139         Assert.assertEquals(1, plan.get(0).getItemsToPush().size());
 140         Assert.assertEquals(2L, plan.get(0).getItemsToPush().iterator().next().getKey().getGroupId().getValue().longValue());
 141         Assert.assertEquals(0, plan.get(0).getItemsToUpdate().size());
 142
 143         Assert.assertEquals(1, plan.get(1).getItemsToPush().size());
 144         Assert.assertEquals(4L, plan.get(1).getItemsToPush().iterator().next().getKey().getGroupId().getValue().longValue());
 145         Assert.assertEquals(0, plan.get(1).getItemsToUpdate().size());
 146
 147         Assert.assertEquals(1, plan.get(2).getItemsToPush().size());
 148         Assert.assertEquals(3L, plan.get(2).getItemsToPush().iterator().next().getKey().getGroupId().getValue().longValue());
 149         Assert.assertEquals(0, plan.get(2).getItemsToUpdate().size());
 150     }
 151
 152     /**
 153      * no actions taken - installed and pending groups are the same
 154      *
 155      * @throws Exception
 156      */
 157     @Test
 158     public void testResolveAndDivideGroupDiffs3() throws Exception {
 159         final Map<Long, Group> installedGroups = new HashMap<>();
 160         installedGroups.put(1L, createGroup(1L));
 161         installedGroups.put(2L, createGroupWithPreconditions(2L, 1L));
 162
 163         final List<Group> pendingGroups = new ArrayList<>();
 164         pendingGroups.add(createGroup(1L));
 165         pendingGroups.add(createGroupWithPreconditions(2L, 1L));
 166
 167         final List<ItemSyncBox<Group>> plan = ReconcileUtil.resolveAndDivideGroupDiffs(
 168                 NODE_ID, installedGroups, pendingGroups);
 169
 170         Assert.assertEquals(0, plan.size());
 171     }
 172
 173     /**
 174      * update 1 group
 175      *
 176      * @throws Exception
 177      */
 178     @Test
 179     public void testResolveAndDivideGroupDiffs4() throws Exception {
 180         final Map<Long, Group> installedGroups = new HashMap<>();
 181         installedGroups.put(1L, createGroup(1L));
 182         installedGroups.put(2L, createGroup(2L));
 183
 184         final List<Group> pendingGroups = new ArrayList<>();
 185         pendingGroups.add(createGroupWithPreconditions(1L, 2L));
 186         pendingGroups.add(createGroup(2L));
 187
 188         final List<ItemSyncBox<Group>> plan = ReconcileUtil.resolveAndDivideGroupDiffs(
 189                 NODE_ID, installedGroups, pendingGroups);
 190
 191         Assert.assertEquals(1, plan.size());
 192         Assert.assertEquals(0, plan.get(0).getItemsToPush().size());
 193         Assert.assertEquals(1, plan.get(0).getItemsToUpdate().size());
 194         final ItemSyncBox.ItemUpdateTuple<Group> firstItemUpdateTuple = plan.get(0).getItemsToUpdate().iterator().next();
 195         Assert.assertEquals(1L, firstItemUpdateTuple.getOriginal().getGroupId().getValue().longValue());
 196         Assert.assertEquals(1L, firstItemUpdateTuple.getUpdated().getGroupId().getValue().longValue());
 197     }
 198
 199     /**
 200      * no action taken - update 1 group will be ignored
 201      *
 202      * @throws Exception
 203      */
 204     @Test
 205     public void testResolveAndDivideGroupDiffs5() throws Exception {
 206         final Map<Long, Group> installedGroups = new HashMap<>();
 207         installedGroups.put(1L, createGroup(1L));
 208         installedGroups.put(2L, createGroup(2L));
 209
 210         final List<Group> pendingGroups = new ArrayList<>();
 211         pendingGroups.add(createGroupWithPreconditions(1L, 2L));
 212         pendingGroups.add(createGroup(2L));
 213
 214         final List<ItemSyncBox<Group>> plan = ReconcileUtil.resolveAndDivideGroupDiffs(
 215                 NODE_ID, installedGroups, pendingGroups, false);
 216
 217         Assert.assertEquals(0, plan.size());
 218     }
 219
 220     /**
 221      * should add 1 group but preconditions are not met
 222      *
 223      * @throws Exception
 224      */
 225     @Test
 226     public void testResolveAndDivideGroupDiffs_negative1() throws Exception {
 227         final Map<Long, Group> installedGroups = new HashMap<>();
 228         installedGroups.put(1L, createGroup(1L));
 229         installedGroups.put(2L, createGroup(2L));
 230
 231         final List<Group> pendingGroups = new ArrayList<>();
 232         pendingGroups.add(createGroupWithPreconditions(3L, 4L));
 233
 234         thrown.expect(IllegalStateException.class);
 235         final List<ItemSyncBox<Group>> plan = ReconcileUtil.resolveAndDivideGroupDiffs(
 236                 NODE_ID, installedGroups, pendingGroups);
 237     }
 238
 239     /**
 240      * should update 1 group but preconditions are not met
 241      *
 242      * @throws Exception
 243      */
 244     @Test
 245     public void testResolveAndDivideGroupDiffs_negative2() throws Exception {
 246         final Map<Long, Group> installedGroups = new HashMap<>();
 247         installedGroups.put(1L, createGroup(1L));
 248         installedGroups.put(2L, createGroup(2L));
 249
 250         final List<Group> pendingGroups = new ArrayList<>();
 251         pendingGroups.add(createGroupWithPreconditions(1L, 3L));
 252
 253         thrown.expect(IllegalStateException.class);
 254         final List<ItemSyncBox<Group>> plan = ReconcileUtil.resolveAndDivideGroupDiffs(
 255                 NODE_ID, installedGroups, pendingGroups);
 256     }
 257
 258     @Test
 259     public void testCheckGroupPrecondition() throws Exception {
 260         final Set<Long> installedGroups = new HashSet<>(Arrays.asList(new Long[]{1L, 2L}));
 261
 262         final Group pendingGroup1 = createGroupWithPreconditions(3L, 2L, 4L);
 263         Assert.assertFalse(ReconcileUtil.checkGroupPrecondition(installedGroups, pendingGroup1));
 264
 265         final Group pendingGroup2 = createGroupWithPreconditions(1L, 2L);
 266         Assert.assertTrue(ReconcileUtil.checkGroupPrecondition(installedGroups, pendingGroup2));
 267
 268         final Group pendingGroup3 = createGroupWithPreconditions(1L);
 269         Assert.assertTrue(ReconcileUtil.checkGroupPrecondition(installedGroups, pendingGroup3));
 270     }
 271
 272     private Group createGroupWithPreconditions(final long groupIdValue, final long... requiredId) {
 273         final List<Action> actionBag = new ArrayList<>();
 274         for (long groupIdPrecondition : requiredId) {
 275             final GroupAction groupAction = new GroupActionBuilder()
 276                     .setGroupId(groupIdPrecondition)
 277                     .build();
 278             final GroupActionCase groupActionCase = new GroupActionCaseBuilder()
 279                     .setGroupAction(groupAction)
 280                     .build();
 281             final Action action = new ActionBuilder()
 282                     .setAction(groupActionCase)
 283                     .build();
 284             actionBag.add(action);
 285         }
 286
 287         final Bucket bucket = new BucketBuilder()
 288                 .setAction(actionBag)
 289                 .build();
 290         final Buckets buckets = new BucketsBuilder()
 291                 .setBucket(Collections.singletonList(bucket))
 292                 .build();
 293
 294         return new GroupBuilder()
 295                 .setGroupId(new GroupId(groupIdValue))
 296                 .setBuckets(buckets)
 297                 .build();
 298     }
 299
 300     private Group createGroup(final long groupIdValue) {
 301         final Buckets buckets = new BucketsBuilder()
 302                 .setBucket(Collections.<Bucket>emptyList())
 303                 .build();
 304         return new GroupBuilder()
 305                 .setGroupId(new GroupId(groupIdValue))
 306                 .setBuckets(buckets)
 307                 .build();
 308     }
 309
 310     /**
 311      * covers {@link ReconcileUtil#countTotalUpdated(Iterable)} too
 312      *
 313      * @throws Exception
 314      */
 315     @Test
 316     public void testCountTotalAdds() throws Exception {
 317         List<ItemSyncBox<String>> syncPlan = new ArrayList<>();
 318         ItemSyncBox<String> syncBox1 = createSyncBox("a,b", "x,y,z");
 319         syncPlan.add(syncBox1);
 320         syncPlan.add(syncBox1);
 321         Assert.assertEquals(4, ReconcileUtil.countTotalPushed(syncPlan));
 322         Assert.assertEquals(6, ReconcileUtil.countTotalUpdated(syncPlan));
 323     }
 324
 325     private ItemSyncBox<String> createSyncBox(final String pushes, final String updates) {
 326         ItemSyncBox<String> syncBox1 = new ItemSyncBox<>();
 327         syncBox1.getItemsToPush().addAll(COMMA_SPLITTER.splitToList(pushes));
 328         for (String orig : COMMA_SPLITTER.splitToList(updates)) {
 329             syncBox1.getItemsToUpdate().add(new ItemSyncBox.ItemUpdateTuple<>(orig, orig + "_updated"));
 330         }
 331         return syncBox1;
 332     }
 333 }