opendaylight/md-sal/sal-binding-broker/src/test/java/org/opendaylight/controller/sal/binding/test/compat/MultipleAugmentationPutsTest.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.sal.binding.test.compat;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertNull;
  13
  14 import java.util.ArrayList;
  15 import java.util.Collections;
  16 import java.util.List;
  17 import java.util.Map;
  18
  19 import org.junit.Assert;
  20 import org.junit.Test;
  21 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  22 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
  23 import org.opendaylight.controller.sal.binding.api.data.DataChangeListener;
  24 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  25 import org.opendaylight.controller.sal.binding.test.AbstractDataServiceTest;
  26 import org.opendaylight.controller.sal.binding.test.AugmentationVerifier;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeComplexUsesAugment;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeComplexUsesAugmentBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeLeafOnlyAugment;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.TreeLeafOnlyAugmentBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ContainerWithUsesBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ListViaUses;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ListViaUsesBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.augment.rev140709.complex.from.grouping.ListViaUsesKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListKey;
  39 import org.opendaylight.yangtools.yang.binding.Augmentation;
  40 import org.opendaylight.yangtools.yang.binding.DataObject;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.common.QName;
  43 import org.opendaylight.yangtools.yang.common.RpcResult;
  44 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  45
  46 @Deprecated
  47 public class MultipleAugmentationPutsTest extends AbstractDataServiceTest implements DataChangeListener {
  48
  49     private static final QName NODE_ID_QNAME = QName.create(TopLevelList.QNAME, "name");
  50     private static final String NODE_ID = "openflow:1";
  51
  52     private static final TopLevelListKey NODE_KEY = new TopLevelListKey(NODE_ID);
  53
  54     private static final Map<QName, Object> NODE_KEY_BI = Collections.<QName, Object> singletonMap(NODE_ID_QNAME,
  55             NODE_ID);
  56
  57     private static final InstanceIdentifier<Top> NODES_INSTANCE_ID_BA = InstanceIdentifier.builder(Top.class) //
  58             .toInstance();
  59
  60     private static final InstanceIdentifier<TopLevelList> NODE_INSTANCE_ID_BA =
  61             NODES_INSTANCE_ID_BA.child(TopLevelList.class, NODE_KEY);
  62
  63     private static final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier NODE_INSTANCE_ID_BI = //
  64     org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.builder() //
  65             .node(Top.QNAME) //
  66             .nodeWithKey(TopLevelList.QNAME, NODE_KEY_BI) //
  67             .toInstance();
  68     private DataChangeEvent<InstanceIdentifier<?>, DataObject> receivedChangeEvent;
  69
  70     /**
  71      * Test for Bug 148
  72      *
  73      * @throws Exception
  74      */
  75     @Test()
  76     public void testAugmentSerialization() throws Exception {
  77
  78         baDataService.registerDataChangeListener(NODES_INSTANCE_ID_BA, this);
  79
  80         TopLevelList flowCapableNode = createTestNode(TreeLeafOnlyAugment.class, createTreeLeafOnlyAugmentation());
  81         commitNodeAndVerifyTransaction(flowCapableNode);
  82
  83         assertNotNull(receivedChangeEvent);
  84         verifyNode((Top) receivedChangeEvent.getUpdatedOperationalSubtree(), flowCapableNode);
  85
  86         Top nodes = checkForNodes();
  87         verifyNode(nodes, flowCapableNode).assertHasAugmentation(TreeLeafOnlyAugment.class);
  88         assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
  89         TopLevelList meterStatsNode = createTestNode(TreeComplexUsesAugment.class, createTreeComplexUsesAugment());
  90         commitNodeAndVerifyTransaction(meterStatsNode);
  91
  92         assertNotNull(receivedChangeEvent);
  93         verifyNode((Top) receivedChangeEvent.getUpdatedOperationalSubtree(), meterStatsNode);
  94
  95         assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
  96
  97         TopLevelList mergedNode = (TopLevelList) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
  98
  99         AugmentationVerifier.from(mergedNode) //
 100                 .assertHasAugmentation(TreeLeafOnlyAugment.class) //
 101                 .assertHasAugmentation(TreeComplexUsesAugment.class);
 102
 103         assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
 104
 105         TopLevelList meterStatsNodeWithDuration = createTestNode(TreeComplexUsesAugment.class, createTreeComplexUsesAugment(5));
 106         commitNodeAndVerifyTransaction(meterStatsNodeWithDuration);
 107
 108
 109         TopLevelList nodeWithUpdatedList = (TopLevelList) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
 110         AugmentationVerifier.from(nodeWithUpdatedList) //
 111                 .assertHasAugmentation(TreeLeafOnlyAugment.class) //
 112                 .assertHasAugmentation(TreeComplexUsesAugment.class);
 113
 114         List<ListViaUses> meterStats = nodeWithUpdatedList.getAugmentation(TreeComplexUsesAugment.class).getListViaUses();
 115         assertNotNull(meterStats);
 116         Assert.assertFalse(meterStats.isEmpty());
 117         assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
 118         testNodeRemove();
 119     }
 120
 121     private static <T extends Augmentation<TopLevelList>> TopLevelList createTestNode(final Class<T> augmentationClass, final T augmentation) {
 122         TopLevelListBuilder nodeBuilder = new TopLevelListBuilder();
 123         nodeBuilder.setKey(NODE_KEY);
 124         nodeBuilder.setName(NODE_KEY.getName());
 125         nodeBuilder.addAugmentation(augmentationClass, augmentation);
 126         return nodeBuilder.build();
 127     }
 128
 129     private DataModificationTransaction commitNodeAndVerifyTransaction(final TopLevelList original) throws Exception {
 130         DataModificationTransaction transaction = baDataService.beginTransaction();
 131         transaction.putOperationalData(NODE_INSTANCE_ID_BA, original);
 132         RpcResult<TransactionStatus> result = transaction.commit().get();
 133         assertEquals(TransactionStatus.COMMITED, result.getResult());
 134         return transaction;
 135     }
 136
 137     private void testNodeRemove() throws Exception {
 138         DataModificationTransaction transaction = baDataService.beginTransaction();
 139         transaction.removeOperationalData(NODE_INSTANCE_ID_BA);
 140         RpcResult<TransactionStatus> result = transaction.commit().get();
 141         assertEquals(TransactionStatus.COMMITED, result.getResult());
 142
 143         TopLevelList node = (TopLevelList) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
 144         assertNull(node);
 145     }
 146
 147     private static AugmentationVerifier<TopLevelList> verifyNode(final Top nodes, final TopLevelList original) {
 148         assertNotNull(nodes);
 149         assertNotNull(nodes.getTopLevelList());
 150         assertEquals(1, nodes.getTopLevelList().size());
 151         TopLevelList readedNode = nodes.getTopLevelList().get(0);
 152         assertEquals(original.getName(), readedNode.getName());
 153         assertEquals(original.getKey(), readedNode.getKey());
 154         return new AugmentationVerifier<>(readedNode);
 155     }
 156
 157     private void assertBindingIndependentVersion(final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier nodeId) {
 158         CompositeNode node = biDataService.readOperationalData(nodeId);
 159         assertNotNull(node);
 160     }
 161
 162     private Top checkForNodes() {
 163         return (Top) baDataService.readOperationalData(NODES_INSTANCE_ID_BA);
 164     }
 165
 166     private static TreeComplexUsesAugment createTreeComplexUsesAugment() {
 167         return createTreeComplexUsesAugment(10);
 168     }
 169
 170     private static TreeComplexUsesAugment createTreeComplexUsesAugment(final int count) {
 171         TreeComplexUsesAugmentBuilder tcuaBld = new TreeComplexUsesAugmentBuilder();
 172         ContainerWithUsesBuilder cwuBld = new ContainerWithUsesBuilder();
 173         cwuBld.setLeafFromGrouping("lfg1");
 174
 175         List<ListViaUses> lvuBag = new ArrayList<>(count);
 176         for (int i = 0; i <= count; i++) {
 177             ListViaUsesBuilder statistic = new ListViaUsesBuilder();
 178             String name = String.valueOf(i);
 179             statistic.setKey(new ListViaUsesKey(name));
 180             statistic.setName(name);
 181             lvuBag.add(statistic.build());
 182         }
 183         tcuaBld.setContainerWithUses(cwuBld.build());
 184         tcuaBld.setListViaUses(lvuBag);
 185         return tcuaBld.build();
 186     }
 187
 188     private static TreeLeafOnlyAugment createTreeLeafOnlyAugmentation() {
 189         TreeLeafOnlyAugmentBuilder fnub = new TreeLeafOnlyAugmentBuilder();
 190         fnub.setSimpleValue("meVerySimpleIs");
 191         TreeLeafOnlyAugment fnu = fnub.build();
 192         return fnu;
 193     }
 194
 195     @Override
 196     public void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 197         receivedChangeEvent = change;
 198     }
 199
 200 }