opendaylight/md-sal/sal-binding-dom-it/src/test/java/org/opendaylight/controller/md/sal/binding/data/WildcardedDataChangeListenerTest.java

   1 /*
   2  * Copyright (c) 2014 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.controller.md.sal.binding.data;
   9
  10 import static org.junit.Assert.assertFalse;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertTrue;
  13 import com.google.common.util.concurrent.SettableFuture;
  14 import java.util.Collections;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.TimeUnit;
  17 import java.util.concurrent.TimeoutException;
  18 import org.junit.Test;
  19 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
  20 import org.opendaylight.controller.sal.binding.api.data.DataChangeListener;
  21 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  22 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  23 import org.opendaylight.controller.sal.binding.test.AbstractDataServiceTest;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeComplexUsesAugment;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeComplexUsesAugmentBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ContainerWithUses;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ContainerWithUsesBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ListViaUses;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ListViaUsesBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ListViaUsesKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListKey;
  34 import org.opendaylight.yangtools.yang.binding.DataObject;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36
  37 /**
  38  * FIXME: THis test should be moved to compat test-suite
  39  */
  40 public class WildcardedDataChangeListenerTest extends AbstractDataServiceTest {
  41
  42     private static final TopLevelListKey TOP_LEVEL_LIST_0_KEY = new TopLevelListKey("test:0");
  43     private static final TopLevelListKey TOP_LEVEL_LIST_1_KEY = new TopLevelListKey("test:1");
  44
  45     protected static final InstanceIdentifier<ListViaUses> DEEP_WILDCARDED_PATH = InstanceIdentifier
  46             .builder(Top.class)
  47             .child(TopLevelList.class) //
  48             .augmentation(TreeComplexUsesAugment.class) //
  49             .child(ListViaUses.class) //
  50             .build();
  51
  52     private static final InstanceIdentifier<TreeComplexUsesAugment> NODE_0_TCU_PATH = InstanceIdentifier
  53             .builder(Top.class)
  54             .child(TopLevelList.class, TOP_LEVEL_LIST_0_KEY) //
  55             .augmentation(TreeComplexUsesAugment.class) //
  56             .build();
  57
  58     private static final InstanceIdentifier<TreeComplexUsesAugment> NODE_1_TCU_PATH = InstanceIdentifier
  59             .builder(Top.class)
  60             .child(TopLevelList.class, TOP_LEVEL_LIST_1_KEY) //
  61             .augmentation(TreeComplexUsesAugment.class) //
  62             .build();
  63
  64
  65     private static final ListViaUsesKey LIST_VIA_USES_KEY = new ListViaUsesKey("test");
  66
  67     private static final InstanceIdentifier<ListViaUses> NODE_0_LVU_PATH = NODE_0_TCU_PATH.child(ListViaUses.class, LIST_VIA_USES_KEY);
  68
  69     private static final InstanceIdentifier<ListViaUses> NODE_1_LVU_PATH = NODE_1_TCU_PATH.child(ListViaUses.class, LIST_VIA_USES_KEY);
  70
  71     private static final InstanceIdentifier<ContainerWithUses> NODE_0_CWU_PATH =
  72             NODE_0_TCU_PATH.child(ContainerWithUses.class);
  73
  74     private static final ContainerWithUses CWU= new ContainerWithUsesBuilder()//
  75             .setLeafFromGrouping("some container value") //
  76             .build();
  77
  78     private static final ListViaUses LVU = new ListViaUsesBuilder() //
  79             .setKey(LIST_VIA_USES_KEY) //
  80             .setName("john")
  81             .build();
  82
  83     @Test
  84     public void testSeparateWrites() throws InterruptedException, TimeoutException, ExecutionException {
  85
  86         DataProviderService dataBroker = testContext.getBindingDataBroker();
  87
  88         final SettableFuture<DataChangeEvent<InstanceIdentifier<?>, DataObject>> eventFuture = SettableFuture.create();
  89         dataBroker.registerDataChangeListener(DEEP_WILDCARDED_PATH, new DataChangeListener() {
  90             @Override
  91             public void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> dataChangeEvent) {
  92                 eventFuture.set(dataChangeEvent);
  93             }
  94         });
  95
  96         DataModificationTransaction transaction = dataBroker.beginTransaction();
  97         transaction.putOperationalData(NODE_0_CWU_PATH, CWU);
  98         transaction.putOperationalData(NODE_0_LVU_PATH, LVU);
  99         transaction.putOperationalData(NODE_1_LVU_PATH, LVU);
 100         transaction.commit().get();
 101
 102         DataChangeEvent<InstanceIdentifier<?>, DataObject> event = eventFuture.get(1000, TimeUnit.MILLISECONDS);
 103
 104         validateEvent(event);
 105     }
 106
 107     @Test
 108     public void testWriteByReplace() throws InterruptedException, TimeoutException, ExecutionException {
 109
 110         DataProviderService dataBroker = testContext.getBindingDataBroker();
 111
 112         final SettableFuture<DataChangeEvent<InstanceIdentifier<?>, DataObject>> eventFuture = SettableFuture.create();
 113         dataBroker.registerDataChangeListener(DEEP_WILDCARDED_PATH, new DataChangeListener() {
 114             @Override
 115             public void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> dataChangeEvent) {
 116                 eventFuture.set(dataChangeEvent);
 117             }
 118         });
 119
 120         DataModificationTransaction cwuTx = dataBroker.beginTransaction();
 121         cwuTx.putOperationalData(NODE_0_CWU_PATH, CWU);
 122         cwuTx.commit().get();
 123
 124         assertFalse(eventFuture.isDone());
 125
 126         DataModificationTransaction lvuTx = dataBroker.beginTransaction();
 127
 128         TreeComplexUsesAugment tcua = new TreeComplexUsesAugmentBuilder()
 129                 .setListViaUses(Collections.singletonList(LVU)).build();
 130
 131         lvuTx.putOperationalData(NODE_0_TCU_PATH, tcua);
 132         lvuTx.putOperationalData(NODE_1_LVU_PATH, LVU);
 133         lvuTx.commit().get();
 134
 135         validateEvent(eventFuture.get(1000, TimeUnit.MILLISECONDS));
 136     }
 137
 138     @Test
 139     public void testNoChangeOnReplaceWithSameValue() throws InterruptedException, TimeoutException, ExecutionException {
 140
 141         DataProviderService dataBroker = testContext.getBindingDataBroker();
 142
 143         // We wrote initial state NODE_0_FLOW
 144         DataModificationTransaction transaction = dataBroker.beginTransaction();
 145         transaction.putOperationalData(NODE_0_LVU_PATH, LVU);
 146         transaction.commit().get();
 147
 148         // We registered DataChangeListener
 149         final SettableFuture<DataChangeEvent<InstanceIdentifier<?>, DataObject>> eventFuture = SettableFuture.create();
 150         dataBroker.registerDataChangeListener(DEEP_WILDCARDED_PATH, new DataChangeListener() {
 151
 152             @Override
 153             public void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> dataChangeEvent) {
 154                 eventFuture.set(dataChangeEvent);
 155             }
 156         });
 157         assertFalse(eventFuture.isDone());
 158
 159         DataModificationTransaction secondTx = dataBroker.beginTransaction();
 160         secondTx.putOperationalData(NODE_0_LVU_PATH, LVU);
 161         secondTx.putOperationalData(NODE_1_LVU_PATH, LVU);
 162         secondTx.commit().get();
 163
 164         DataChangeEvent<InstanceIdentifier<?>, DataObject> event = (eventFuture.get(1000, TimeUnit.MILLISECONDS));
 165         assertNotNull(event);
 166         // Data change should contains NODE_1 Flow - which was added
 167         assertTrue(event.getCreatedOperationalData().containsKey(NODE_1_LVU_PATH));
 168         // Data change must not containe NODE_0 Flow which was replaced with same value.
 169         assertFalse(event.getUpdatedOperationalData().containsKey(NODE_0_LVU_PATH));
 170     }
 171
 172     private static void validateEvent(final DataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
 173         assertNotNull(event);
 174         assertTrue(event.getCreatedOperationalData().containsKey(NODE_1_LVU_PATH));
 175         assertTrue(event.getCreatedOperationalData().containsKey(NODE_0_LVU_PATH));
 176         assertFalse(event.getCreatedOperationalData().containsKey(NODE_0_CWU_PATH));
 177     }
 178
 179 }