opendaylight/md-sal/sal-binding-dom-it/src/test/java/org/opendaylight/controller/sal/binding/test/bugfix/DOMCodecBug03Test.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.bugfix;
   9 import static org.junit.Assert.assertEquals;
  10 import static org.junit.Assert.assertFalse;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertNull;
  13
  14 import java.util.Collections;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.concurrent.TimeUnit;
  18
  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.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SupportedActions;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SupportedActionsBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.actions.ActionType;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.actions.ActionTypeBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  41 import org.opendaylight.yangtools.yang.binding.DataObject;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.common.QName;
  44 import org.opendaylight.yangtools.yang.common.RpcResult;
  45 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  46
  47 import com.google.common.util.concurrent.SettableFuture;
  48
  49 public class DOMCodecBug03Test extends AbstractDataServiceTest implements DataChangeListener {
  50
  51     private static final QName NODE_ID_QNAME = QName.create(Node.QNAME, "id");
  52     private static final String NODE_ID = "openflow:1";
  53
  54     private static final NodeKey NODE_KEY = new NodeKey(new NodeId(NODE_ID));
  55
  56     private static final Map<QName, Object> NODE_KEY_BI = Collections.<QName, Object> singletonMap(NODE_ID_QNAME,
  57             NODE_ID);
  58
  59     private static final InstanceIdentifier<Nodes> NODES_INSTANCE_ID_BA = InstanceIdentifier.builder(Nodes.class) //
  60             .toInstance();
  61
  62
  63     private static final InstanceIdentifier<Node> NODE_INSTANCE_ID_BA = NODES_INSTANCE_ID_BA.child(Node.class, NODE_KEY);
  64
  65
  66     private static final InstanceIdentifier<SupportedActions> SUPPORTED_ACTIONS_INSTANCE_ID_BA = //
  67             NODES_INSTANCE_ID_BA.builder() //
  68             .child(Node.class, NODE_KEY) //
  69             .augmentation(FlowCapableNode.class) //
  70             .child(SupportedActions.class)
  71             .toInstance();
  72
  73
  74     private static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier NODE_INSTANCE_ID_BI = //
  75     org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.builder() //
  76             .node(Nodes.QNAME) //
  77             .nodeWithKey(Node.QNAME, NODE_KEY_BI) //
  78             .toInstance();
  79     private static final QName SUPPORTED_ACTIONS_QNAME = QName.create(FlowCapableNode.QNAME, SupportedActions.QNAME.getLocalName());
  80
  81
  82     private static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier SUPPORTED_ACTIONS_INSTANCE_ID_BI = //
  83             org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.builder() //
  84                     .node(Nodes.QNAME) //
  85                     .nodeWithKey(Node.QNAME, NODE_KEY_BI) //
  86                     .node(SUPPORTED_ACTIONS_QNAME) //
  87                     .toInstance();
  88
  89     private final SettableFuture<DataChangeEvent<InstanceIdentifier<?>, DataObject>> receivedChangeEvent = SettableFuture.create();
  90
  91
  92
  93     /**
  94      * Test for Bug 148
  95      *
  96      * @throws Exception
  97      */
  98     @Test
  99     public void testAugmentSerialization() throws Exception {
 100
 101
 102         baDataService.registerDataChangeListener(NODES_INSTANCE_ID_BA, this);
 103
 104         NodeBuilder nodeBuilder = new NodeBuilder();
 105         nodeBuilder.setId(new NodeId(NODE_ID));
 106         nodeBuilder.setKey(NODE_KEY);
 107         DataModificationTransaction transaction = baDataService.beginTransaction();
 108
 109
 110         FlowCapableNodeBuilder fnub = new FlowCapableNodeBuilder();
 111         fnub.setHardware("Hardware Foo");
 112         fnub.setManufacturer("Manufacturer Foo");
 113         fnub.setSerialNumber("Serial Foo");
 114         fnub.setDescription("Description Foo");
 115         fnub.setSoftware("JUnit emulated");
 116         FlowCapableNode fnu = fnub.build();
 117         nodeBuilder.addAugmentation(FlowCapableNode.class, fnu);
 118         Node original = nodeBuilder.build();
 119         transaction.putOperationalData(NODE_INSTANCE_ID_BA, original);
 120
 121         RpcResult<TransactionStatus> result = transaction.commit().get();
 122         assertEquals(TransactionStatus.COMMITED, result.getResult());
 123
 124         DataChangeEvent<InstanceIdentifier<?>, DataObject> potential = receivedChangeEvent.get(1000,TimeUnit.MILLISECONDS);
 125         assertNotNull(potential);
 126
 127         verifyNodes((Nodes) potential.getUpdatedOperationalSubtree(),original);
 128         assertBindingIndependentVersion(NODE_INSTANCE_ID_BI);
 129         Nodes nodes = checkForNodes();
 130         verifyNodes(nodes,original);
 131
 132         testAddingNodeConnector();
 133         testNodeRemove();
 134
 135     }
 136
 137     @Test
 138     public void testAugmentNestedSerialization() throws Exception {
 139         DataModificationTransaction transaction = baDataService.beginTransaction();
 140
 141         SupportedActionsBuilder actions = new SupportedActionsBuilder();
 142         ActionTypeBuilder action = new ActionTypeBuilder();
 143         action.setAction("foo-action");
 144         action.setSupportState(SupportType.Native);
 145         List<ActionType> actionTypes = Collections.singletonList(action.build());
 146         actions.setActionType(actionTypes );
 147
 148         transaction.putOperationalData(SUPPORTED_ACTIONS_INSTANCE_ID_BA, actions.build());
 149         RpcResult<TransactionStatus> putResult = transaction.commit().get();
 150         assertNotNull(putResult);
 151         assertEquals(TransactionStatus.COMMITED, putResult.getResult());
 152         SupportedActions readedTable = (SupportedActions) baDataService.readOperationalData(SUPPORTED_ACTIONS_INSTANCE_ID_BA);
 153         assertNotNull(readedTable);
 154
 155         CompositeNode biSupportedActions = biDataService.readOperationalData(SUPPORTED_ACTIONS_INSTANCE_ID_BI);
 156         assertNotNull(biSupportedActions);
 157
 158     }
 159
 160     private void testAddingNodeConnector() throws Exception {
 161
 162         NodeConnectorId ncId = new NodeConnectorId("openflow:1:bar");
 163         NodeConnectorKey nodeKey = new NodeConnectorKey(ncId );
 164         InstanceIdentifier<NodeConnector> ncInstanceId = NODE_INSTANCE_ID_BA.child(NodeConnector.class, nodeKey);
 165         NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder();
 166         ncBuilder.setId(ncId);
 167         ncBuilder.setKey(nodeKey);
 168         NodeConnector connector = ncBuilder.build();
 169         DataModificationTransaction transaction = baDataService.beginTransaction();
 170         transaction.putOperationalData(ncInstanceId, connector);
 171         RpcResult<TransactionStatus> result = transaction.commit().get();
 172         assertEquals(TransactionStatus.COMMITED, result.getResult());
 173         Node node = (Node) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
 174         assertNotNull(node);
 175         assertNotNull(node.getNodeConnector());
 176         assertFalse(node.getNodeConnector().isEmpty());
 177         NodeConnector readedNc = node.getNodeConnector().get(0);
 178         assertNotNull(readedNc);
 179     }
 180
 181     private void testNodeRemove() throws Exception {
 182         DataModificationTransaction transaction = baDataService.beginTransaction();
 183         transaction.removeOperationalData(NODE_INSTANCE_ID_BA);
 184         RpcResult<TransactionStatus> result = transaction.commit().get();
 185         assertEquals(TransactionStatus.COMMITED, result.getResult());
 186
 187         Node node = (Node) baDataService.readOperationalData(NODE_INSTANCE_ID_BA);
 188         assertNull(node);
 189     }
 190
 191     private void verifyNodes(final Nodes nodes,final Node original) {
 192         assertNotNull(nodes);
 193         assertNotNull(nodes.getNode());
 194         assertEquals(1, nodes.getNode().size());
 195         Node readedNode = nodes.getNode().get(0);
 196         assertEquals(original.getId(), readedNode.getId());
 197         assertEquals(original.getKey(), readedNode.getKey());
 198
 199         FlowCapableNode fnu = original.getAugmentation(FlowCapableNode.class);
 200         FlowCapableNode readedAugment = readedNode.getAugmentation(FlowCapableNode.class);
 201         assertNotNull(fnu);
 202         assertEquals(fnu.getDescription(), readedAugment.getDescription());
 203         assertEquals(fnu.getSerialNumber(), readedAugment.getSerialNumber());
 204
 205     }
 206
 207     private void assertBindingIndependentVersion(
 208             final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier nodeId) {
 209         CompositeNode node = biDataService.readOperationalData(nodeId);
 210         assertNotNull(node);
 211     }
 212
 213     private Nodes checkForNodes() {
 214         return (Nodes) baDataService.readOperationalData(NODES_INSTANCE_ID_BA);
 215     }
 216
 217     @Override
 218     public void onDataChanged(final DataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 219         receivedChangeEvent.set(change);
 220     }
 221
 222 }