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