2 * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
9 package org.opendaylight.ovsdb.hwvtepsouthbound;
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.Delete;
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.operations.Update;
33 import org.opendaylight.ovsdb.lib.operations.Where;
34 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
35 import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentationBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalSwitchAttributes;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitchesKey;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacs;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacs;
45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
49 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
53 import org.opendaylight.yangtools.yang.binding.DataObject;
54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
55 import org.powermock.api.mockito.PowerMockito;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
59 import java.io.InputStream;
60 import java.net.InetAddress;
61 import java.util.List;
63 import static org.mockito.Matchers.any;
64 import static org.mockito.Matchers.anyString;
65 import static org.mockito.Mockito.doReturn;
66 import static org.mockito.Mockito.mock;
67 import static org.mockito.Mockito.when;
68 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.CONFIGURATION;
69 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL;
70 import static org.powermock.api.support.membermodification.MemberMatcher.field;
71 import static org.powermock.api.support.membermodification.MemberModifier.suppress;
73 public class DataChangeListenerTestBase extends AbstractDataBrokerTest {
75 static Logger LOG = LoggerFactory.getLogger(DataChangeListenerTestBase.class);
77 static DataBroker dataBroker;
79 EntityOwnershipService entityOwnershipService;
80 OvsdbClient ovsdbClient;
81 DatabaseSchema dbSchema;
82 ListenableFuture<DatabaseSchema> listenableDbSchema = mock(ListenableFuture.class);
83 TransactionInvoker transactionInvoker;
84 OvsdbConnectionInfo connectionInfo;
85 Operations operations;
86 HwvtepDataChangeListener hwvtepDataChangeListener;
87 HwvtepConnectionManager hwvtepConnectionManager;
88 HwvtepConnectionInstance connectionInstance;
90 ArgumentCaptor<TypedBaseTable> insertOpCapture;
91 ArgumentCaptor<List> transactCaptor;
94 InstanceIdentifier<Node> nodeIid;
95 InstanceIdentifier<LogicalSwitches> ls0Iid;
96 InstanceIdentifier<LogicalSwitches> ls1Iid;
99 public void setupTest() throws Exception {
101 * Use the same databroker across tests ,otherwise the following exception is thrown
102 * Caused by: java.lang.RuntimeException: org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.
103 * topology.rev131021.node.attributes.SupportingNode$StreamWriter: frozen class (cannot edit)
105 if (dataBroker == null) {
106 dataBroker = super.getDataBroker();
108 entityOwnershipService = mock(EntityOwnershipService.class);
109 nodeUuid = java.util.UUID.randomUUID().toString();
110 nodeIid = createInstanceIdentifier(nodeUuid);
111 ls0Iid = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
112 child(LogicalSwitches.class, new LogicalSwitchesKey(new HwvtepNodeName("ls0")));
113 ls1Iid = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
114 child(LogicalSwitches.class, new LogicalSwitchesKey(new HwvtepNodeName("ls1")));
116 mockConnectionInstance();
117 mockConnectionManager();
120 addNode(OPERATIONAL);
121 addNode(CONFIGURATION);
122 hwvtepDataChangeListener = new HwvtepDataChangeListener(dataBroker, hwvtepConnectionManager);
126 public void tearDown() throws Exception {
127 hwvtepDataChangeListener.close();
128 deleteNode(OPERATIONAL);
129 deleteNode(CONFIGURATION);
133 try (InputStream resourceAsStream = DataChangeListenerTestBase.class.getResourceAsStream("hwvtep_schema.json")) {
134 ObjectMapper mapper = new ObjectMapper();
135 JsonNode jsonNode = mapper.readTree(resourceAsStream);
136 dbSchema = DatabaseSchema.fromJson(HwvtepSchemaConstants.HARDWARE_VTEP,
137 jsonNode.get("result"));
138 listenableDbSchema = mock(ListenableFuture.class);
139 when(listenableDbSchema.get()).thenReturn(dbSchema);
140 } catch (Exception e) {
141 LOG.error("Failed to load schema", e);
145 private void mockConnectionManager() throws IllegalAccessException {
146 hwvtepConnectionManager = PowerMockito.mock(HwvtepConnectionManager.class, Mockito.CALLS_REAL_METHODS);
147 field(HwvtepConnectionManager.class, "db").set(hwvtepConnectionManager, dataBroker);
148 field(HwvtepConnectionManager.class, "txInvoker").set(hwvtepConnectionManager, transactionInvoker);
149 field(HwvtepConnectionManager.class, "entityOwnershipService").set(hwvtepConnectionManager, entityOwnershipService);
150 suppress(PowerMockito.method(HwvtepConnectionManager.class, "getConnectionInstance", HwvtepPhysicalSwitchAttributes.class));
151 suppress(PowerMockito.method(HwvtepConnectionManager.class, "getConnectionInstanceFromNodeIid",
152 InstanceIdentifier.class));
153 when(hwvtepConnectionManager.getConnectionInstance(Mockito.any(HwvtepPhysicalSwitchAttributes.class))).
154 thenReturn(connectionInstance);
155 when(hwvtepConnectionManager.getConnectionInstance(Mockito.any(Node.class))).
156 thenReturn(connectionInstance);
157 when(hwvtepConnectionManager.getConnectionInstanceFromNodeIid(Mockito.any(InstanceIdentifier.class)))
158 .thenReturn(connectionInstance);
161 void mockConnectionInstance() throws IllegalAccessException {
162 connectionInfo = mock(OvsdbConnectionInfo.class);
163 ovsdbClient = mock(OvsdbClient.class);
164 transactionInvoker = new TransactionInvokerImpl(dataBroker);
166 connectionInstance = PowerMockito.mock(HwvtepConnectionInstance.class, Mockito.CALLS_REAL_METHODS);
167 field(HwvtepConnectionInstance.class, "instanceIdentifier").set(connectionInstance, nodeIid);
168 field(HwvtepConnectionInstance.class, "txInvoker").set(connectionInstance, transactionInvoker);
169 field(HwvtepConnectionInstance.class, "deviceInfo").set(connectionInstance, new HwvtepDeviceInfo(connectionInstance));
170 field(HwvtepConnectionInstance.class, "client").set(connectionInstance, ovsdbClient);
171 when(connectionInstance.getConnectionInfo()).thenReturn(connectionInfo);
172 when(connectionInstance.getConnectionInfo().getRemoteAddress()).thenReturn(mock(InetAddress.class));
173 when(connectionInstance.getInstanceIdentifier()).thenReturn(nodeIid);
174 doReturn(listenableDbSchema).when(connectionInstance).getSchema(anyString());
175 when(connectionInstance.getDataBroker()).thenReturn(dataBroker);
176 when(connectionInstance.getInstanceIdentifier()).thenReturn(nodeIid);
177 connectionInstance.createTransactInvokers();
180 void mockOperations() {
185 * resets the captures so that we can validate the captors of the immediate next execution
187 void resetOperations() {
188 insertOpCapture = ArgumentCaptor.forClass(TypedBaseTable.class);
189 Update update = mock(Update.class);
190 Insert insert = mock(Insert.class);
191 Delete delete = mock(Delete.class);
192 Where where = mock(Where.class);
193 when(delete.where(any())).thenReturn(where);
194 when(insert.withId(any(String.class))).thenReturn(insert);
195 Operations.op = PowerMockito.mock(Operations.class);
196 when(Operations.op.insert(insertOpCapture.capture())).thenReturn(insert);
197 when(Operations.op.update(insertOpCapture.capture())).thenReturn(update);
198 when(update.where(any())).thenReturn(where);
199 when(Operations.op.delete(any())).thenReturn(delete);
200 ListenableFuture<List<OperationResult>> ft = mock(ListenableFuture.class);
201 transactCaptor = ArgumentCaptor.forClass(List.class);
202 when(ovsdbClient.transact(any(DatabaseSchema.class), transactCaptor.capture())).thenReturn(ft);
205 void addNode(LogicalDatastoreType logicalDatastoreType) throws Exception {
206 NodeBuilder nodeBuilder = prepareNode(nodeIid);
207 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
208 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
209 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
210 transaction.put(logicalDatastoreType, nodeIid, nodeBuilder.build(), WriteTransaction.CREATE_MISSING_PARENTS);
211 transaction.submit();
214 void deleteNode(LogicalDatastoreType logicalDatastoreType) {
215 ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
216 tx.delete(logicalDatastoreType, nodeIid);
220 Node addData(LogicalDatastoreType logicalDatastoreType, Class<? extends DataObject> dataObject,
222 NodeBuilder nodeBuilder = prepareNode(nodeIid);
223 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
224 if (LogicalSwitches.class == dataObject) {
225 TestBuilders.addLogicalSwitches(builder, data);
227 if (TerminationPoint.class == dataObject) {
228 TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
230 if (RemoteUcastMacs.class == dataObject) {
231 TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
233 if (RemoteMcastMacs.class == dataObject) {
234 TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
236 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
237 return mergeNode(logicalDatastoreType, nodeIid, nodeBuilder);
240 void deleteData(LogicalDatastoreType logicalDatastoreType, Class<? extends DataObject> dataObject,
242 NodeBuilder nodeBuilder = prepareNode(nodeIid);
243 ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
244 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
245 if (LogicalSwitches.class == dataObject) {
246 List<LogicalSwitches> logicalSwitches = TestBuilders.addLogicalSwitches(builder, data);
248 for (LogicalSwitches ls : logicalSwitches) {
249 InstanceIdentifier<LogicalSwitches> key = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
250 child(LogicalSwitches.class, ls.getKey());
251 tx.delete(logicalDatastoreType, key);
254 if (TerminationPoint.class == dataObject) {
255 TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
257 if (RemoteUcastMacs.class == dataObject) {
258 List<RemoteUcastMacs> macs = TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
259 for (RemoteUcastMacs mac : macs) {
260 InstanceIdentifier<RemoteUcastMacs> key = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
261 child(RemoteUcastMacs.class, mac.getKey());
262 tx.delete(logicalDatastoreType, key);
265 if (RemoteMcastMacs.class == dataObject) {
266 List<RemoteMcastMacs> macs = TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
267 for (RemoteMcastMacs mac : macs) {
268 InstanceIdentifier<RemoteMcastMacs> key = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
269 child(RemoteMcastMacs.class, mac.getKey());
270 tx.delete(logicalDatastoreType, key);
276 NodeBuilder prepareNode(InstanceIdentifier<Node> iid) {
277 NodeBuilder nodeBuilder = new NodeBuilder();
278 nodeBuilder.setNodeId(iid.firstKeyOf(Node.class).getNodeId());
282 Node mergeNode(LogicalDatastoreType datastoreType, InstanceIdentifier<Node> id, NodeBuilder nodeBuilder) {
283 Node node = nodeBuilder.build();
284 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
285 transaction.merge(datastoreType, id, node, WriteTransaction.CREATE_MISSING_PARENTS);
286 transaction.submit();
290 public InstanceIdentifier<Node> createInstanceIdentifier(String nodeIdString) {
291 NodeId nodeId = new NodeId(new Uri(nodeIdString));
292 NodeKey nodeKey = new NodeKey(nodeId);
293 TopologyKey topoKey = new TopologyKey(HwvtepSouthboundConstants.HWVTEP_TOPOLOGY_ID);
294 return InstanceIdentifier.builder(NetworkTopology.class)
295 .child(Topology.class, topoKey)
296 .child(Node.class, nodeKey)