applications/forwardingrules-sync/src/test/java/org/opendaylight/openflowplugin/applications/frsync/impl/strategy/SyncPlanPushStrategyFlatBatchImplTest.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.impl.strategy;
  10
  11 import com.google.common.collect.Lists;
  12 import com.google.common.collect.Range;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import java.util.ArrayList;
  15 import java.util.HashMap;
  16 import java.util.List;
  17 import java.util.Map;
  18 import org.junit.Assert;
  19 import org.junit.Before;
  20 import org.junit.Test;
  21 import org.junit.runner.RunWith;
  22 import org.mockito.ArgumentCaptor;
  23 import org.mockito.Captor;
  24 import org.mockito.Matchers;
  25 import org.mockito.Mock;
  26 import org.mockito.Mockito;
  27 import org.mockito.runners.MockitoJUnitRunner;
  28 import org.opendaylight.openflowplugin.applications.frsync.impl.TableForwarder;
  29 import org.opendaylight.openflowplugin.applications.frsync.util.ItemSyncBox;
  30 import org.opendaylight.openflowplugin.applications.frsync.util.SyncCrudCounters;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchInput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.SalFlatBatchService;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.Batch;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.BatchBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchAddFlowCase;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchAddFlowCaseBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchAddGroupCase;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchAddGroupCaseBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchAddMeterCase;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchAddMeterCaseBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchRemoveFlowCase;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchRemoveFlowCaseBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchRemoveGroupCase;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchRemoveGroupCaseBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchRemoveMeterCase;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchRemoveMeterCaseBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchUpdateFlowCase;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchUpdateFlowCaseBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchUpdateGroupCase;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchUpdateGroupCaseBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchUpdateMeterCase;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.FlatBatchUpdateMeterCaseBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  64 import org.opendaylight.yangtools.yang.common.RpcResult;
  65 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  66
  67 /**
  68  * Test for {@link SyncPlanPushStrategyFlatBatchImpl}.
  69  */
  70 @RunWith(MockitoJUnitRunner.class)
  71 public class SyncPlanPushStrategyFlatBatchImplTest {
  72
  73     private static final NodeId NODE_ID = new NodeId("ut-node-id");
  74     private static final InstanceIdentifier<FlowCapableNode> NODE_IDENT = InstanceIdentifier.create(Nodes.class)
  75             .child(Node.class, new NodeKey(NODE_ID))
  76             .augmentation(FlowCapableNode.class);
  77     @Mock
  78     private SalFlatBatchService flatBatchService;
  79     @Mock
  80     private TableForwarder tableForwarder;
  81     @Captor
  82     private ArgumentCaptor<ProcessFlatBatchInput> processFlatBatchInputCpt;
  83
  84     private List<ItemSyncBox<Group>> groupsToAddOrUpdate;
  85     private List<ItemSyncBox<Group>> groupsToRemove;
  86     private ItemSyncBox<Meter> metersToAddOrUpdate;
  87     private ItemSyncBox<Meter> metersToRemove;
  88     private Map<TableKey, ItemSyncBox<Flow>> flowsToAddOrUpdate;
  89     private Map<TableKey, ItemSyncBox<Flow>> flowsToRemove;
  90     private List<Batch> batchBag;
  91
  92     private SyncPlanPushStrategyFlatBatchImpl syncPlanPushStrategy;
  93
  94     public SyncPlanPushStrategyFlatBatchImplTest() {
  95         groupsToAddOrUpdate = Lists.newArrayList(DiffInputFactory.createGroupSyncBox(1, 2, 3),
  96                 DiffInputFactory.createGroupSyncBoxWithUpdates(4, 5, 6));
  97         groupsToRemove = Lists.newArrayList(DiffInputFactory.createGroupSyncBox(1, 2, 3),
  98                 DiffInputFactory.createGroupSyncBox(4, 5, 6));
  99
 100         metersToAddOrUpdate = DiffInputFactory.createMeterSyncBoxWithUpdates(1, 2, 3);
 101         metersToRemove = DiffInputFactory.createMeterSyncBox(1, 2, 3);
 102
 103         flowsToAddOrUpdate = new HashMap<>();
 104         flowsToAddOrUpdate.put(new TableKey((short) 0), DiffInputFactory.createFlowSyncBox("1", "2", "3"));
 105         flowsToAddOrUpdate.put(new TableKey((short) 1), DiffInputFactory.createFlowSyncBoxWithUpdates("4", "5", "6"));
 106         flowsToRemove = new HashMap<>();
 107         flowsToRemove.put(new TableKey((short) 0), DiffInputFactory.createFlowSyncBox("1", "2", "3"));
 108         flowsToRemove.put(new TableKey((short) 1), DiffInputFactory.createFlowSyncBox("4", "5", "6"));
 109     }
 110
 111
 112     @Before
 113     public void setUp() throws Exception {
 114         syncPlanPushStrategy = new SyncPlanPushStrategyFlatBatchImpl();
 115         syncPlanPushStrategy.setFlatBatchService(flatBatchService);
 116         syncPlanPushStrategy.setTableForwarder(tableForwarder);
 117
 118         batchBag = new ArrayList<>();
 119     }
 120
 121     @Test
 122     public void testExecuteSyncStrategy() throws Exception {
 123         final SynchronizationDiffInput diffInput = new SynchronizationDiffInput(NODE_IDENT,
 124                 groupsToAddOrUpdate, metersToAddOrUpdate, flowsToAddOrUpdate, flowsToRemove, metersToRemove, groupsToRemove);
 125
 126         Mockito.when(flatBatchService.processFlatBatch(Matchers.<ProcessFlatBatchInput>any()))
 127                 .thenReturn(RpcResultBuilder.success(new ProcessFlatBatchOutputBuilder().build()).buildFuture());
 128
 129         final SyncCrudCounters counters = new SyncCrudCounters();
 130         final ListenableFuture<RpcResult<Void>> rpcResult = syncPlanPushStrategy.executeSyncStrategy(
 131                 RpcResultBuilder.<Void>success().buildFuture(), diffInput, counters);
 132
 133         Mockito.verify(flatBatchService).processFlatBatch(processFlatBatchInputCpt.capture());
 134
 135         final ProcessFlatBatchInput processFlatBatchInput = processFlatBatchInputCpt.getValue();
 136         Assert.assertFalse(processFlatBatchInput.isExitOnFirstError());
 137         Assert.assertEquals(13, processFlatBatchInput.getBatch().size());
 138
 139         Assert.assertTrue(rpcResult.isDone());
 140         Assert.assertTrue(rpcResult.get().isSuccessful());
 141
 142         Assert.assertEquals(6, counters.getFlowCrudCounts().getAdded());
 143         Assert.assertEquals(3, counters.getFlowCrudCounts().getUpdated());
 144         Assert.assertEquals(6, counters.getFlowCrudCounts().getRemoved());
 145
 146         Assert.assertEquals(6, counters.getGroupCrudCounts().getAdded());
 147         Assert.assertEquals(3, counters.getGroupCrudCounts().getUpdated());
 148         Assert.assertEquals(6, counters.getGroupCrudCounts().getRemoved());
 149
 150         Assert.assertEquals(3, counters.getMeterCrudCounts().getAdded());
 151         Assert.assertEquals(3, counters.getMeterCrudCounts().getUpdated());
 152         Assert.assertEquals(3, counters.getMeterCrudCounts().getRemoved());
 153     }
 154
 155     @Test
 156     public void testAssembleRemoveFlows() throws Exception {
 157         final int lastOrder = SyncPlanPushStrategyFlatBatchImpl.assembleRemoveFlows(batchBag, 0, flowsToRemove);
 158
 159         Assert.assertEquals(6, lastOrder);
 160         Assert.assertEquals(2, batchBag.size());
 161         Assert.assertEquals(FlatBatchRemoveFlowCase.class, batchBag.get(0).getBatchChoice().getImplementedInterface());
 162         Assert.assertEquals(3, ((FlatBatchRemoveFlowCase) batchBag.get(0).getBatchChoice())
 163                 .getFlatBatchRemoveFlow().size());
 164         Assert.assertEquals(FlatBatchRemoveFlowCase.class, batchBag.get(1).getBatchChoice().getImplementedInterface());
 165         Assert.assertEquals(3, ((FlatBatchRemoveFlowCase) batchBag.get(1).getBatchChoice())
 166                 .getFlatBatchRemoveFlow().size());
 167     }
 168
 169     @Test
 170     public void testAssembleAddOrUpdateGroups() throws Exception {
 171         final int lastOrder = SyncPlanPushStrategyFlatBatchImpl.assembleAddOrUpdateGroups(batchBag, 0, groupsToAddOrUpdate);
 172
 173         Assert.assertEquals(9, lastOrder);
 174         Assert.assertEquals(3, batchBag.size());
 175         Assert.assertEquals(FlatBatchAddGroupCase.class, batchBag.get(0).getBatchChoice().getImplementedInterface());
 176         Assert.assertEquals(3, ((FlatBatchAddGroupCase) batchBag.get(0).getBatchChoice())
 177                 .getFlatBatchAddGroup().size());
 178         Assert.assertEquals(FlatBatchAddGroupCase.class, batchBag.get(1).getBatchChoice().getImplementedInterface());
 179         Assert.assertEquals(3, ((FlatBatchAddGroupCase) batchBag.get(1).getBatchChoice())
 180                 .getFlatBatchAddGroup().size());
 181         Assert.assertEquals(FlatBatchUpdateGroupCase.class, batchBag.get(2).getBatchChoice().getImplementedInterface());
 182         Assert.assertEquals(3, ((FlatBatchUpdateGroupCase) batchBag.get(2).getBatchChoice())
 183                 .getFlatBatchUpdateGroup().size());
 184     }
 185
 186     @Test
 187     public void testAssembleRemoveGroups() throws Exception {
 188         final int lastOrder = SyncPlanPushStrategyFlatBatchImpl.assembleRemoveGroups(batchBag, 0, groupsToRemove);
 189
 190         Assert.assertEquals(6, lastOrder);
 191         Assert.assertEquals(2, batchBag.size());
 192         Assert.assertEquals(FlatBatchRemoveGroupCase.class, batchBag.get(0).getBatchChoice().getImplementedInterface());
 193         Assert.assertEquals(3, ((FlatBatchRemoveGroupCase) batchBag.get(0).getBatchChoice())
 194                 .getFlatBatchRemoveGroup().size());
 195         Assert.assertEquals(FlatBatchRemoveGroupCase.class, batchBag.get(1).getBatchChoice().getImplementedInterface());
 196         Assert.assertEquals(3, ((FlatBatchRemoveGroupCase) batchBag.get(1).getBatchChoice())
 197                 .getFlatBatchRemoveGroup().size());
 198     }
 199
 200     @Test
 201     public void testAssembleAddOrUpdateMeters() throws Exception {
 202         final int lastOrder = SyncPlanPushStrategyFlatBatchImpl.assembleAddOrUpdateMeters(batchBag, 0, metersToAddOrUpdate);
 203
 204         Assert.assertEquals(6, lastOrder);
 205         Assert.assertEquals(2, batchBag.size());
 206         Assert.assertEquals(FlatBatchAddMeterCase.class, batchBag.get(0).getBatchChoice().getImplementedInterface());
 207         Assert.assertEquals(3, ((FlatBatchAddMeterCase) batchBag.get(0).getBatchChoice())
 208                 .getFlatBatchAddMeter().size());
 209         Assert.assertEquals(FlatBatchUpdateMeterCase.class, batchBag.get(1).getBatchChoice().getImplementedInterface());
 210         Assert.assertEquals(3, ((FlatBatchUpdateMeterCase) batchBag.get(1).getBatchChoice())
 211                 .getFlatBatchUpdateMeter().size());
 212     }
 213
 214     @Test
 215     public void testAssembleRemoveMeters() throws Exception {
 216         final int lastOrder = SyncPlanPushStrategyFlatBatchImpl.assembleRemoveMeters(batchBag, 0, metersToRemove);
 217
 218         Assert.assertEquals(3, lastOrder);
 219         Assert.assertEquals(1, batchBag.size());
 220         Assert.assertEquals(FlatBatchRemoveMeterCase.class, batchBag.get(0).getBatchChoice().getImplementedInterface());
 221         Assert.assertEquals(3, ((FlatBatchRemoveMeterCase) batchBag.get(0).getBatchChoice())
 222                 .getFlatBatchRemoveMeter().size());
 223     }
 224
 225     @Test
 226     public void testAssembleAddOrUpdateFlows() throws Exception {
 227         final int lastOrder = SyncPlanPushStrategyFlatBatchImpl.assembleAddOrUpdateFlows(batchBag, 0, flowsToAddOrUpdate);
 228
 229         Assert.assertEquals(9, lastOrder);
 230         Assert.assertEquals(3, batchBag.size());
 231         Assert.assertEquals(FlatBatchAddFlowCase.class, batchBag.get(0).getBatchChoice().getImplementedInterface());
 232         Assert.assertEquals(3, ((FlatBatchAddFlowCase) batchBag.get(0).getBatchChoice())
 233                 .getFlatBatchAddFlow().size());
 234         Assert.assertEquals(FlatBatchUpdateFlowCase.class, batchBag.get(1).getBatchChoice().getImplementedInterface());
 235         Assert.assertEquals(3, ((FlatBatchUpdateFlowCase) batchBag.get(1).getBatchChoice())
 236                 .getFlatBatchUpdateFlow().size());
 237         Assert.assertEquals(FlatBatchAddFlowCase.class, batchBag.get(2).getBatchChoice().getImplementedInterface());
 238         Assert.assertEquals(3, ((FlatBatchAddFlowCase) batchBag.get(2).getBatchChoice())
 239                 .getFlatBatchAddFlow().size());
 240     }
 241
 242     @Test
 243     public void testDecrementCounters() throws Exception {
 244         final SyncCrudCounters counters = new SyncCrudCounters();
 245         counters.getFlowCrudCounts().setAdded(100);
 246         counters.getFlowCrudCounts().setUpdated(100);
 247         counters.getFlowCrudCounts().setRemoved(100);
 248
 249         counters.getGroupCrudCounts().setAdded(100);
 250         counters.getGroupCrudCounts().setUpdated(100);
 251         counters.getGroupCrudCounts().setRemoved(100);
 252
 253         counters.getMeterCrudCounts().setAdded(100);
 254         counters.getMeterCrudCounts().setUpdated(100);
 255         counters.getMeterCrudCounts().setRemoved(100);
 256
 257         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchAddFlowCaseBuilder().build(), counters);
 258         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchUpdateFlowCaseBuilder().build(), counters);
 259         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchRemoveFlowCaseBuilder().build(), counters);
 260
 261         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchAddGroupCaseBuilder().build(), counters);
 262         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchUpdateGroupCaseBuilder().build(), counters);
 263         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchRemoveGroupCaseBuilder().build(), counters);
 264
 265         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchAddMeterCaseBuilder().build(), counters);
 266         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchUpdateMeterCaseBuilder().build(), counters);
 267         SyncPlanPushStrategyFlatBatchImpl.decrementCounters(new FlatBatchRemoveMeterCaseBuilder().build(), counters);
 268
 269         Assert.assertEquals(99, counters.getFlowCrudCounts().getAdded());
 270         Assert.assertEquals(99, counters.getFlowCrudCounts().getUpdated());
 271         Assert.assertEquals(99, counters.getFlowCrudCounts().getRemoved());
 272
 273         Assert.assertEquals(99, counters.getGroupCrudCounts().getAdded());
 274         Assert.assertEquals(99, counters.getGroupCrudCounts().getUpdated());
 275         Assert.assertEquals(99, counters.getGroupCrudCounts().getRemoved());
 276
 277         Assert.assertEquals(99, counters.getMeterCrudCounts().getAdded());
 278         Assert.assertEquals(99, counters.getMeterCrudCounts().getUpdated());
 279         Assert.assertEquals(99, counters.getMeterCrudCounts().getRemoved());
 280     }
 281
 282     @Test
 283     public void testMapBachesToRanges() throws Exception {
 284         final List<Batch> inputBatchBag = Lists.newArrayList(
 285                 new BatchBuilder().setBatchOrder(0).build(),
 286                 new BatchBuilder().setBatchOrder(5).build(),
 287                 new BatchBuilder().setBatchOrder(9).build(),
 288                 new BatchBuilder().setBatchOrder(15).build()
 289         );
 290         final Map<Range<Integer>, Batch> rangeBatchMap = SyncPlanPushStrategyFlatBatchImpl.mapBatchesToRanges(inputBatchBag, 42);
 291
 292         Assert.assertEquals(4, rangeBatchMap.size());
 293         int idx = 0;
 294         final int[] lower = new int[]{0, 5, 9, 15};
 295         final int[] upper = new int[]{4, 8, 14, 41};
 296         for (Map.Entry<Range<Integer>, Batch> rangeBatchEntry : rangeBatchMap.entrySet()) {
 297             Assert.assertEquals(lower[idx], rangeBatchEntry.getKey().lowerEndpoint().intValue());
 298             Assert.assertEquals(upper[idx], rangeBatchEntry.getKey().upperEndpoint().intValue());
 299             Assert.assertSame(inputBatchBag.get(idx), rangeBatchEntry.getValue());
 300             idx++;
 301         }
 302     }
 303 }