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.math.BigInteger;
  15 import java.util.ArrayList;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.Map;
  19 import org.junit.Test;
  20 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  21 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
  22 import org.opendaylight.controller.sal.binding.api.data.DataChangeListener;
  23 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  24 import org.opendaylight.controller.sal.binding.test.AbstractDataServiceTest;
  25 import org.opendaylight.controller.sal.binding.test.AugmentationVerifier;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.Counter32;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.Counter64;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterStatistics;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterStatisticsBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.nodes.node.meter.MeterStatisticsBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.DurationBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.reply.MeterStats;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.reply.MeterStatsBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.reply.MeterStatsKey;
  43 import org.opendaylight.yangtools.yang.binding.Augmentation;
  44 import org.opendaylight.yangtools.yang.binding.DataObject;
  45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.common.QName;
  47 import org.opendaylight.yangtools.yang.common.RpcResult;
  48 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  49
  50 public class MultipleAugmentationPutsTest extends AbstractDataServiceTest implements DataChangeListener {
  51
  52     private static final QName NODE_ID_QNAME = QName.create(Node.QNAME, "id");
  53     private static final String NODE_ID = "openflow:1";
  54
  55     private static final NodeKey NODE_KEY = new NodeKey(new NodeId(NODE_ID));
  56
  57     private static final Map<QName, Object> NODE_KEY_BI = Collections.<QName, Object> singletonMap(NODE_ID_QNAME,
  58             NODE_ID);
  59
  60     private static final InstanceIdentifier<Nodes> NODES_INSTANCE_ID_BA = InstanceIdentifier.builder(Nodes.class) //
  61             .toInstance();
  62
  63     private static final InstanceIdentifier<Node> NODE_INSTANCE_ID_BA =
  64             NODES_INSTANCE_ID_BA.child(Node.class, NODE_KEY);
  65
  66     private static final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier NODE_INSTANCE_ID_BI = //
  67     org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.builder() //
  68             .node(Nodes.QNAME) //
  69             .nodeWithKey(Node.QNAME, NODE_KEY_BI) //
  70             .toInstance();
  71     private DataChangeEvent<InstanceIdentifier<?>, DataObject> receivedChangeEvent;
  72
  73     /**
  74      * Test for Bug 148
  75      *
  76      * @throws Exception
  77      */
  78     @Test()
  79     public void testAugmentSerialization() throws Exception {
  80
  81         baDataService.registerDataChangeListener(NODES_INSTANCE_ID_BA, this);
  82
  83         Node flowCapableNode = createTestNode(FlowCapableNode.class, flowCapableNodeAugmentation());
  84         commitNodeAndVerifyTransaction(flowCapableNode);
  85
  86         assertNotNull(receivedChangeEvent);
  87         verifyNode((Nodes) receivedChangeEvent.getUpdatedOperationalSubtree(), flowCapableNode);
  88
  89         Nodes nodes = checkForNodes();
  90         verifyNode(nodes, flowCapableNode).assertHasAugmentation(FlowCapableNode.class);
  91         assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
  92 //        Node meterStatsNode = createTestNode(NodeMeterStatistics.class, nodeMeterStatistics());
  93 //        commitNodeAndVerifyTransaction(meterStatsNode);
  94 //
  95 //        assertNotNull(receivedChangeEvent);
  96 //        verifyNode((Nodes) receivedChangeEvent.getUpdatedOperationalSubtree(), meterStatsNode);
  97 //
  98 //        assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
  99 //
 100 //        Node mergedNode = (Node) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
 101 //
 102 //        AugmentationVerifier.from(mergedNode) //
 103 //                .assertHasAugmentation(FlowCapableNode.class) //
 104 //                .assertHasAugmentation(NodeMeterStatistics.class);
 105 //
 106 //        assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
 107 //
 108 //        Node meterStatsNodeWithDuration = createTestNode(NodeMeterStatistics.class, nodeMeterStatistics(5, true));
 109 //        commitNodeAndVerifyTransaction(meterStatsNodeWithDuration);
 110 //
 111 //
 112 //        Node nodeWithUpdatedList = (Node) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
 113 //        AugmentationVerifier.from(nodeWithUpdatedList) //
 114 //                .assertHasAugmentation(FlowCapableNode.class) //
 115 //                .assertHasAugmentation(NodeMeterStatistics.class);
 116 //
 117 //        List<MeterStats> meterStats = nodeWithUpdatedList.getAugmentation(NodeMeterStatistics.class).getMeterStatistics().getMeterStats();
 118 //        assertNotNull(meterStats);
 119 //        assertFalse(meterStats.isEmpty());
 120 //        assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
 121         testNodeRemove();
 122     }
 123
 124     private <T extends Augmentation<Node>> Node createTestNode(final Class<T> augmentationClass, final T augmentation) {
 125         NodeBuilder nodeBuilder = new NodeBuilder();
 126         nodeBuilder.setId(new NodeId(NODE_ID));
 127         nodeBuilder.setKey(NODE_KEY);
 128         nodeBuilder.addAugmentation(augmentationClass, augmentation);
 129         return nodeBuilder.build();
 130     }
 131
 132     private DataModificationTransaction commitNodeAndVerifyTransaction(final Node original) throws Exception {
 133         DataModificationTransaction transaction = baDataService.beginTransaction();
 134         transaction.putOperationalData(NODE_INSTANCE_ID_BA, original);
 135         RpcResult<TransactionStatus> result = transaction.commit().get();
 136         assertEquals(TransactionStatus.COMMITED, result.getResult());
 137         return transaction;
 138     }
 139
 140     private void testNodeRemove() throws Exception {
 141         DataModificationTransaction transaction = baDataService.beginTransaction();
 142         transaction.removeOperationalData(NODE_INSTANCE_ID_BA);
 143         RpcResult<TransactionStatus> result = transaction.commit().get();
 144         assertEquals(TransactionStatus.COMMITED, result.getResult());
 145
 146         Node node = (Node) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
 147         assertNull(node);
 148     }
 149
 150     private AugmentationVerifier<Node> verifyNode(final Nodes nodes, final Node original) {
 151         assertNotNull(nodes);
 152         assertNotNull(nodes.getNode());
 153         assertEquals(1, nodes.getNode().size());
 154         Node readedNode = nodes.getNode().get(0);
 155         assertEquals(original.getId(), readedNode.getId());
 156         assertEquals(original.getKey(), readedNode.getKey());
 157         return new AugmentationVerifier<Node>(readedNode);
 158     }
 159
 160     private void assertBindingIndependentVersion(final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier nodeId) {
 161         CompositeNode node = biDataService.readOperationalData(nodeId);
 162         assertNotNull(node);
 163     }
 164
 165     private Nodes checkForNodes() {
 166         return (Nodes) baDataService.readOperationalData(NODES_INSTANCE_ID_BA);
 167     }
 168
 169     private NodeMeterStatistics nodeMeterStatistics() {
 170         return nodeMeterStatistics(10, false);
 171     }
 172
 173     private NodeMeterStatistics nodeMeterStatistics(final int count, final boolean setDuration) {
 174         NodeMeterStatisticsBuilder nmsb = new NodeMeterStatisticsBuilder();
 175         MeterStatisticsBuilder meterStats = new MeterStatisticsBuilder();
 176
 177         List<MeterStats> stats = new ArrayList<>(count);
 178         for (int i = 0; i <= count; i++) {
 179             MeterStatsBuilder statistic = new MeterStatsBuilder();
 180             statistic.setKey(new MeterStatsKey(new MeterId((long) i)));
 181             statistic.setByteInCount(new Counter64(BigInteger.valueOf(34590 + i)));
 182             statistic.setFlowCount(new Counter32(4569L + i));
 183
 184             if (setDuration) {
 185                 DurationBuilder duration = new DurationBuilder();
 186                 duration.setNanosecond(new Counter32(70L));
 187                 statistic.setDuration(duration.build());
 188             }
 189
 190             stats.add(statistic.build());
 191         }
 192        // meterStats.setMeterStats(stats);
 193         nmsb.setMeterStatistics(meterStats.build());
 194         return nmsb.build();
 195     }
 196
 197     private FlowCapableNode flowCapableNodeAugmentation() {
 198         FlowCapableNodeBuilder fnub = new FlowCapableNodeBuilder();
 199         fnub.setHardware("Hardware Foo");
 200         fnub.setManufacturer("Manufacturer Foo");
 201         fnub.setSerialNumber("Serial Foo");
 202         fnub.setDescription("Description Foo");
 203         fnub.setSoftware("JUnit emulated");
 204         FlowCapableNode fnu = fnub.build();
 205         return fnu;
 206     }
 207
 208     @Override
 209     public void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 210         receivedChangeEvent = change;
 211     }
 212
 213 }