hwvtepsouthbound/hwvtepsouthbound-impl/src/test/java/org/opendaylight/ovsdb/hwvtepsouthbound/DataChangeListenerTestBase.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. 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
   9 package org.opendaylight.ovsdb.hwvtepsouthbound;
  10
  11 import com.fasterxml.jackson.databind.JsonNode;
  12 import com.fasterxml.jackson.databind.ObjectMapper;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import org.junit.After;
  15 import org.junit.Before;
  16 import org.mockito.ArgumentCaptor;
  17 import org.mockito.Mockito;
  18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  19 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  21 import org.opendaylight.controller.md.sal.binding.test.AbstractDataBrokerTest;
  22 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  24 import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvoker;
  25 import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvokerImpl;
  26 import org.opendaylight.ovsdb.lib.OvsdbClient;
  27 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
  28 import org.opendaylight.ovsdb.lib.operations.Comment;
  29 import org.opendaylight.ovsdb.lib.operations.Insert;
  30 import org.opendaylight.ovsdb.lib.operations.OperationResult;
  31 import org.opendaylight.ovsdb.lib.operations.Operations;
  32 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
  33 import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentationBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalSwitchAttributes;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacs;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacs;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  49 import org.opendaylight.yangtools.yang.binding.DataObject;
  50 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  51 import org.powermock.api.mockito.PowerMockito;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 import java.io.InputStream;
  56 import java.net.InetAddress;
  57 import java.util.List;
  58
  59 import static org.mockito.Matchers.any;
  60 import static org.mockito.Matchers.anyString;
  61 import static org.mockito.Mockito.doReturn;
  62 import static org.mockito.Mockito.mock;
  63 import static org.mockito.Mockito.when;
  64 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.CONFIGURATION;
  65 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL;
  66 import static org.powermock.api.support.membermodification.MemberMatcher.field;
  67 import static org.powermock.api.support.membermodification.MemberModifier.suppress;
  68
  69 public class DataChangeListenerTestBase extends AbstractDataBrokerTest {
  70
  71     static Logger LOG = LoggerFactory.getLogger(DataChangeListenerTestBase.class);
  72
  73     static DataBroker dataBroker;
  74
  75     EntityOwnershipService entityOwnershipService;
  76     OvsdbClient ovsdbClient;
  77     DatabaseSchema dbSchema;
  78     ListenableFuture<DatabaseSchema> listenableDbSchema = mock(ListenableFuture.class);
  79     TransactionInvoker transactionInvoker;
  80     OvsdbConnectionInfo connectionInfo;
  81     Operations operations;
  82     HwvtepDataChangeListener hwvtepDataChangeListener;
  83     HwvtepConnectionManager hwvtepConnectionManager;
  84     HwvtepConnectionInstance connectionInstance;
  85
  86     ArgumentCaptor<TypedBaseTable> insertOpCapture;
  87     ArgumentCaptor<List> transactCaptor;
  88
  89     String nodeUuid;
  90     InstanceIdentifier<Node> nodeIid;
  91
  92     @Before
  93     public void setupTest() throws Exception {
  94         /**
  95          *  Use the same databroker across tests ,otherwise the following exception is thrown
  96          *  Caused by: java.lang.RuntimeException: org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.
  97          *  topology.rev131021.node.attributes.SupportingNode$StreamWriter: frozen class (cannot edit)
  98          */
  99         if (dataBroker == null) {
 100             dataBroker = super.getDataBroker();
 101         }
 102         entityOwnershipService = mock(EntityOwnershipService.class);
 103         nodeUuid = java.util.UUID.randomUUID().toString();
 104         nodeIid = createInstanceIdentifier(nodeUuid);
 105         loadSchema();
 106         mockConnectionInstance();
 107         mockConnectionManager();
 108         mockOperations();
 109
 110         addNode(OPERATIONAL);
 111         addNode(CONFIGURATION);
 112         hwvtepDataChangeListener = new HwvtepDataChangeListener(dataBroker, hwvtepConnectionManager);
 113     }
 114
 115     @After
 116     public void tearDown() throws Exception {
 117         hwvtepDataChangeListener.close();
 118         deleteNode(OPERATIONAL);
 119         deleteNode(CONFIGURATION);
 120     }
 121
 122     void loadSchema() {
 123         try (InputStream resourceAsStream = DataChangeListenerTestBase.class.getResourceAsStream("hwvtep_schema.json")) {
 124             ObjectMapper mapper = new ObjectMapper();
 125             JsonNode jsonNode = mapper.readTree(resourceAsStream);
 126             dbSchema = DatabaseSchema.fromJson(HwvtepSchemaConstants.HARDWARE_VTEP,
 127                     jsonNode.get("result"));
 128             listenableDbSchema = mock(ListenableFuture.class);
 129             when(listenableDbSchema.get()).thenReturn(dbSchema);
 130         } catch (Exception e) {
 131             LOG.error("Failed to load schema", e);
 132         }
 133     }
 134
 135     private void mockConnectionManager() throws IllegalAccessException {
 136         hwvtepConnectionManager = PowerMockito.mock(HwvtepConnectionManager.class, Mockito.CALLS_REAL_METHODS);
 137         field(HwvtepConnectionManager.class, "db").set(hwvtepConnectionManager, dataBroker);
 138         field(HwvtepConnectionManager.class, "txInvoker").set(hwvtepConnectionManager, transactionInvoker);
 139         field(HwvtepConnectionManager.class, "entityOwnershipService").set(hwvtepConnectionManager, entityOwnershipService);
 140         suppress(PowerMockito.method(HwvtepConnectionManager.class, "getConnectionInstance", HwvtepPhysicalSwitchAttributes.class));
 141         when(hwvtepConnectionManager.getConnectionInstance(Mockito.any(HwvtepPhysicalSwitchAttributes.class))).
 142                 thenReturn(connectionInstance);
 143         when(hwvtepConnectionManager.getConnectionInstance(Mockito.any(Node.class))).
 144                 thenReturn(connectionInstance);
 145     }
 146
 147     void mockConnectionInstance() throws IllegalAccessException {
 148         connectionInfo = mock(OvsdbConnectionInfo.class);
 149         ovsdbClient = mock(OvsdbClient.class);
 150         transactionInvoker =  new TransactionInvokerImpl(dataBroker);
 151         connectionInstance = PowerMockito.mock(HwvtepConnectionInstance.class, Mockito.CALLS_REAL_METHODS);
 152         field(HwvtepConnectionInstance.class, "instanceIdentifier").set(connectionInstance, nodeIid);
 153         field(HwvtepConnectionInstance.class, "txInvoker").set(connectionInstance, transactionInvoker);
 154         field(HwvtepConnectionInstance.class, "deviceInfo").set(connectionInstance, new HwvtepDeviceInfo(connectionInstance));
 155         field(HwvtepConnectionInstance.class, "client").set(connectionInstance, ovsdbClient);
 156         when(connectionInstance.getConnectionInfo()).thenReturn(connectionInfo);
 157         when(connectionInstance.getConnectionInfo().getRemoteAddress()).thenReturn(mock(InetAddress.class));
 158         when(connectionInstance.getInstanceIdentifier()).thenReturn(nodeIid);
 159         doReturn(listenableDbSchema).when(connectionInstance).getSchema(anyString());
 160         when(connectionInstance.getDataBroker()).thenReturn(dataBroker);
 161         when(connectionInstance.getInstanceIdentifier()).thenReturn(nodeIid);
 162         connectionInstance.createTransactInvokers();
 163     }
 164
 165     void mockOperations() {
 166         resetOperations();
 167     }
 168
 169     /**
 170      * resets the captures so that we can validate the captors of the immediate next execution
 171      */
 172     void resetOperations() {
 173         insertOpCapture = ArgumentCaptor.forClass(TypedBaseTable.class);
 174         Insert insert = mock(Insert.class);
 175         when(insert.withId(any(String.class))).thenReturn(insert);
 176         Operations.op = PowerMockito.mock(Operations.class);
 177         when(Operations.op.comment(any(String.class))).thenReturn(mock(Comment.class));
 178         when(Operations.op.insert(insertOpCapture.capture())).thenReturn(insert);
 179
 180         ListenableFuture<List<OperationResult>> ft = mock(ListenableFuture.class);
 181         transactCaptor = ArgumentCaptor.forClass(List.class);
 182         when(ovsdbClient.transact(any(DatabaseSchema.class), transactCaptor.capture())).thenReturn(ft);
 183     }
 184
 185     void addNode(LogicalDatastoreType logicalDatastoreType) throws Exception {
 186         NodeBuilder nodeBuilder = prepareNode(nodeIid);
 187         HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
 188         nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
 189         WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 190         transaction.put(logicalDatastoreType, nodeIid, nodeBuilder.build(), WriteTransaction.CREATE_MISSING_PARENTS);
 191         transaction.submit();
 192     }
 193
 194     void deleteNode(LogicalDatastoreType logicalDatastoreType) {
 195         ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
 196         tx.delete(logicalDatastoreType, nodeIid);
 197         tx.submit();
 198     }
 199
 200     void addData(LogicalDatastoreType logicalDatastoreType, Class<? extends DataObject> dataObject,
 201                  String[]... data) {
 202         NodeBuilder nodeBuilder = prepareNode(nodeIid);
 203         HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
 204         if (LogicalSwitches.class == dataObject) {
 205             TestBuilders.addLogicalSwitches(builder, data);
 206         }
 207         if (TerminationPoint.class == dataObject) {
 208             TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
 209         }
 210         if (RemoteUcastMacs.class == dataObject) {
 211             TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
 212         }
 213         if (RemoteMcastMacs.class == dataObject) {
 214             TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
 215         }
 216         nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
 217         mergeNode(logicalDatastoreType, nodeIid, nodeBuilder);
 218     }
 219
 220     NodeBuilder prepareNode(InstanceIdentifier<Node> iid) {
 221         NodeBuilder nodeBuilder = new NodeBuilder();
 222         nodeBuilder.setNodeId(iid.firstKeyOf(Node.class).getNodeId());
 223         return nodeBuilder;
 224     }
 225
 226     Node mergeNode(LogicalDatastoreType datastoreType, InstanceIdentifier<Node> id, NodeBuilder nodeBuilder) {
 227         Node node = nodeBuilder.build();
 228         WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 229         transaction.merge(datastoreType, id, node, WriteTransaction.CREATE_MISSING_PARENTS);
 230         transaction.submit();
 231         return node;
 232     }
 233
 234     public InstanceIdentifier<Node> createInstanceIdentifier(String nodeIdString) {
 235         NodeId nodeId = new NodeId(new Uri(nodeIdString));
 236         NodeKey nodeKey = new NodeKey(nodeId);
 237         TopologyKey topoKey = new TopologyKey(HwvtepSouthboundConstants.HWVTEP_TOPOLOGY_ID);
 238         return InstanceIdentifier.builder(NetworkTopology.class)
 239                 .child(Topology.class, topoKey)
 240                 .child(Node.class, nodeKey)
 241                 .build();
 242     }
 243 }