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.apache.commons.lang3.reflect.FieldUtils;
15 import org.junit.After;
16 import org.junit.Before;
17 import org.mockito.ArgumentCaptor;
18 import org.mockito.Mockito;
19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
20 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
22 import org.opendaylight.controller.md.sal.binding.test.AbstractDataBrokerTest;
23 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvoker;
26 import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvokerImpl;
27 import org.opendaylight.ovsdb.lib.OvsdbClient;
28 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
29 import org.opendaylight.ovsdb.lib.operations.Delete;
30 import org.opendaylight.ovsdb.lib.operations.Insert;
31 import org.opendaylight.ovsdb.lib.operations.OperationResult;
32 import org.opendaylight.ovsdb.lib.operations.Operations;
33 import org.opendaylight.ovsdb.lib.operations.Update;
34 import org.opendaylight.ovsdb.lib.operations.Where;
35 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
36 import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentationBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalSwitchAttributes;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitchesKey;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacs;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacs;
46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
49 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
54 import org.opendaylight.yangtools.yang.binding.DataObject;
55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
56 import org.powermock.api.mockito.PowerMockito;
57 import org.slf4j.Logger;
58 import org.slf4j.LoggerFactory;
60 import java.io.InputStream;
61 import java.lang.reflect.Field;
62 import java.lang.reflect.Modifier;
63 import java.net.InetAddress;
64 import java.util.List;
66 import static org.mockito.Matchers.any;
67 import static org.mockito.Matchers.anyString;
68 import static org.mockito.Mockito.doReturn;
69 import static org.mockito.Mockito.mock;
70 import static org.mockito.Mockito.when;
71 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.CONFIGURATION;
72 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL;
73 import static org.powermock.api.support.membermodification.MemberMatcher.field;
74 import static org.powermock.api.support.membermodification.MemberModifier.suppress;
76 public class DataChangeListenerTestBase extends AbstractDataBrokerTest {
78 static Logger LOG = LoggerFactory.getLogger(DataChangeListenerTestBase.class);
80 static DataBroker dataBroker;
82 EntityOwnershipService entityOwnershipService;
83 OvsdbClient ovsdbClient;
84 DatabaseSchema dbSchema;
85 ListenableFuture<DatabaseSchema> listenableDbSchema = mock(ListenableFuture.class);
86 TransactionInvoker transactionInvoker;
87 OvsdbConnectionInfo connectionInfo;
88 Operations operations;
89 HwvtepDataChangeListener hwvtepDataChangeListener;
90 HwvtepConnectionManager hwvtepConnectionManager;
91 HwvtepConnectionInstance connectionInstance;
93 ArgumentCaptor<TypedBaseTable> insertOpCapture;
94 ArgumentCaptor<List> transactCaptor;
97 InstanceIdentifier<Node> nodeIid;
98 InstanceIdentifier<LogicalSwitches> ls0Iid;
99 InstanceIdentifier<LogicalSwitches> ls1Iid;
102 public void setupTest() throws Exception {
104 * Use the same databroker across tests ,otherwise the following exception is thrown
105 * Caused by: java.lang.RuntimeException: org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.
106 * topology.rev131021.node.attributes.SupportingNode$StreamWriter: frozen class (cannot edit)
108 if (dataBroker == null) {
109 dataBroker = super.getDataBroker();
111 entityOwnershipService = mock(EntityOwnershipService.class);
112 nodeUuid = java.util.UUID.randomUUID().toString();
113 nodeIid = createInstanceIdentifier(nodeUuid);
114 ls0Iid = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
115 child(LogicalSwitches.class, new LogicalSwitchesKey(new HwvtepNodeName("ls0")));
116 ls1Iid = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
117 child(LogicalSwitches.class, new LogicalSwitchesKey(new HwvtepNodeName("ls1")));
119 mockConnectionInstance();
120 mockConnectionManager();
123 addNode(OPERATIONAL);
124 addNode(CONFIGURATION);
125 hwvtepDataChangeListener = new HwvtepDataChangeListener(dataBroker, hwvtepConnectionManager);
129 public void tearDown() throws Exception {
130 hwvtepDataChangeListener.close();
131 deleteNode(OPERATIONAL);
132 deleteNode(CONFIGURATION);
135 void setFinalStatic(Class cls, String fieldName, Object newValue) throws Exception {
136 Field fields[] = FieldUtils.getAllFields(cls);
137 for (Field field : fields) {
138 if (fieldName.equals(field.getName())) {
139 field.setAccessible(true);
140 Field modifiersField = Field.class.getDeclaredField("modifiers");
141 modifiersField.setAccessible(true);
142 modifiersField.setInt(field, field.getModifiers() & ~Modifier.FINAL);
143 field.set(null, newValue);
150 try (InputStream resourceAsStream = DataChangeListenerTestBase.class.getResourceAsStream("hwvtep_schema.json")) {
151 ObjectMapper mapper = new ObjectMapper();
152 JsonNode jsonNode = mapper.readTree(resourceAsStream);
153 dbSchema = DatabaseSchema.fromJson(HwvtepSchemaConstants.HARDWARE_VTEP,
154 jsonNode.get("result"));
155 listenableDbSchema = mock(ListenableFuture.class);
156 when(listenableDbSchema.get()).thenReturn(dbSchema);
157 } catch (Exception e) {
158 LOG.error("Failed to load schema", e);
162 private void mockConnectionManager() throws IllegalAccessException {
163 hwvtepConnectionManager = PowerMockito.mock(HwvtepConnectionManager.class, Mockito.CALLS_REAL_METHODS);
164 field(HwvtepConnectionManager.class, "db").set(hwvtepConnectionManager, dataBroker);
165 field(HwvtepConnectionManager.class, "txInvoker").set(hwvtepConnectionManager, transactionInvoker);
166 field(HwvtepConnectionManager.class, "entityOwnershipService").set(hwvtepConnectionManager, entityOwnershipService);
167 suppress(PowerMockito.method(HwvtepConnectionManager.class, "getConnectionInstance", HwvtepPhysicalSwitchAttributes.class));
168 suppress(PowerMockito.method(HwvtepConnectionManager.class, "getConnectionInstanceFromNodeIid",
169 InstanceIdentifier.class));
170 when(hwvtepConnectionManager.getConnectionInstance(Mockito.any(HwvtepPhysicalSwitchAttributes.class))).
171 thenReturn(connectionInstance);
172 when(hwvtepConnectionManager.getConnectionInstance(Mockito.any(Node.class))).
173 thenReturn(connectionInstance);
174 when(hwvtepConnectionManager.getConnectionInstanceFromNodeIid(Mockito.any(InstanceIdentifier.class)))
175 .thenReturn(connectionInstance);
178 void mockConnectionInstance() throws IllegalAccessException {
179 connectionInfo = mock(OvsdbConnectionInfo.class);
180 ovsdbClient = mock(OvsdbClient.class);
181 transactionInvoker = new TransactionInvokerImpl(dataBroker);
183 connectionInstance = PowerMockito.mock(HwvtepConnectionInstance.class, Mockito.CALLS_REAL_METHODS);
184 field(HwvtepConnectionInstance.class, "instanceIdentifier").set(connectionInstance, nodeIid);
185 field(HwvtepConnectionInstance.class, "txInvoker").set(connectionInstance, transactionInvoker);
186 field(HwvtepConnectionInstance.class, "deviceInfo").set(connectionInstance, new HwvtepDeviceInfo(connectionInstance));
187 field(HwvtepConnectionInstance.class, "client").set(connectionInstance, ovsdbClient);
188 when(connectionInstance.getOvsdbClient()).thenReturn(ovsdbClient);
189 when(ovsdbClient.isActive()).thenReturn(true);
190 when(connectionInstance.getConnectionInfo()).thenReturn(connectionInfo);
191 when(connectionInstance.getConnectionInfo().getRemoteAddress()).thenReturn(mock(InetAddress.class));
192 when(connectionInstance.getInstanceIdentifier()).thenReturn(nodeIid);
193 doReturn(listenableDbSchema).when(connectionInstance).getSchema(anyString());
194 when(connectionInstance.getDataBroker()).thenReturn(dataBroker);
195 when(connectionInstance.getInstanceIdentifier()).thenReturn(nodeIid);
196 connectionInstance.createTransactInvokers();
199 void mockOperations() {
204 * resets the captures so that we can validate the captors of the immediate next execution
206 void resetOperations() {
207 insertOpCapture = ArgumentCaptor.forClass(TypedBaseTable.class);
208 Update update = mock(Update.class);
209 Insert insert = mock(Insert.class);
210 Delete delete = mock(Delete.class);
211 Where where = mock(Where.class);
212 when(delete.where(any())).thenReturn(where);
213 when(insert.withId(any(String.class))).thenReturn(insert);
214 Operations.op = PowerMockito.mock(Operations.class);
215 when(Operations.op.insert(insertOpCapture.capture())).thenReturn(insert);
216 when(Operations.op.update(insertOpCapture.capture())).thenReturn(update);
217 when(update.where(any())).thenReturn(where);
218 when(Operations.op.delete(any())).thenReturn(delete);
219 ListenableFuture<List<OperationResult>> ft = mock(ListenableFuture.class);
220 transactCaptor = ArgumentCaptor.forClass(List.class);
221 when(ovsdbClient.transact(any(DatabaseSchema.class), transactCaptor.capture())).thenReturn(ft);
224 void addNode(LogicalDatastoreType logicalDatastoreType) throws Exception {
225 NodeBuilder nodeBuilder = prepareNode(nodeIid);
226 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
227 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
228 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
229 transaction.put(logicalDatastoreType, nodeIid, nodeBuilder.build(), WriteTransaction.CREATE_MISSING_PARENTS);
230 transaction.submit();
233 void deleteNode(LogicalDatastoreType logicalDatastoreType) {
234 ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
235 tx.delete(logicalDatastoreType, nodeIid);
239 Node addData(LogicalDatastoreType logicalDatastoreType, Class<? extends DataObject> dataObject,
241 NodeBuilder nodeBuilder = prepareNode(nodeIid);
242 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
243 if (LogicalSwitches.class == dataObject) {
244 TestBuilders.addLogicalSwitches(builder, data);
246 if (TerminationPoint.class == dataObject) {
247 TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
249 if (RemoteUcastMacs.class == dataObject) {
250 TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
252 if (RemoteMcastMacs.class == dataObject) {
253 TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
255 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
256 return mergeNode(logicalDatastoreType, nodeIid, nodeBuilder);
259 void deleteData(LogicalDatastoreType logicalDatastoreType, Class<? extends DataObject> dataObject,
261 NodeBuilder nodeBuilder = prepareNode(nodeIid);
262 ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
263 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
264 if (LogicalSwitches.class == dataObject) {
265 List<LogicalSwitches> logicalSwitches = TestBuilders.addLogicalSwitches(builder, data);
267 for (LogicalSwitches ls : logicalSwitches) {
268 InstanceIdentifier<LogicalSwitches> key = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
269 child(LogicalSwitches.class, ls.getKey());
270 tx.delete(logicalDatastoreType, key);
273 if (TerminationPoint.class == dataObject) {
274 TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
276 if (RemoteUcastMacs.class == dataObject) {
277 List<RemoteUcastMacs> macs = TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
278 for (RemoteUcastMacs mac : macs) {
279 InstanceIdentifier<RemoteUcastMacs> key = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
280 child(RemoteUcastMacs.class, mac.getKey());
281 tx.delete(logicalDatastoreType, key);
284 if (RemoteMcastMacs.class == dataObject) {
285 List<RemoteMcastMacs> macs = TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
286 for (RemoteMcastMacs mac : macs) {
287 InstanceIdentifier<RemoteMcastMacs> key = nodeIid.augmentation(HwvtepGlobalAugmentation.class).
288 child(RemoteMcastMacs.class, mac.getKey());
289 tx.delete(logicalDatastoreType, key);
295 NodeBuilder prepareNode(InstanceIdentifier<Node> iid) {
296 NodeBuilder nodeBuilder = new NodeBuilder();
297 nodeBuilder.setNodeId(iid.firstKeyOf(Node.class).getNodeId());
301 Node mergeNode(LogicalDatastoreType datastoreType, InstanceIdentifier<Node> id, NodeBuilder nodeBuilder) {
302 Node node = nodeBuilder.build();
303 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
304 transaction.merge(datastoreType, id, node, WriteTransaction.CREATE_MISSING_PARENTS);
305 transaction.submit();
309 public InstanceIdentifier<Node> createInstanceIdentifier(String nodeIdString) {
310 NodeId nodeId = new NodeId(new Uri(nodeIdString));
311 NodeKey nodeKey = new NodeKey(nodeId);
312 TopologyKey topoKey = new TopologyKey(HwvtepSouthboundConstants.HWVTEP_TOPOLOGY_ID);
313 return InstanceIdentifier.builder(NetworkTopology.class)
314 .child(Topology.class, topoKey)
315 .child(Node.class, nodeKey)