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
8 package org.opendaylight.ovsdb.hwvtepsouthbound;
10 import static org.mockito.ArgumentMatchers.any;
11 import static org.mockito.ArgumentMatchers.anyString;
12 import static org.mockito.Mockito.doReturn;
13 import static org.mockito.Mockito.mock;
14 import static org.mockito.Mockito.spy;
16 import com.fasterxml.jackson.databind.JsonNode;
17 import com.fasterxml.jackson.databind.ObjectMapper;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import java.io.IOException;
20 import java.io.InputStream;
21 import java.lang.reflect.Field;
22 import java.lang.reflect.Modifier;
23 import java.net.InetAddress;
24 import java.util.List;
25 import java.util.concurrent.ExecutionException;
26 import org.apache.commons.lang3.reflect.FieldUtils;
27 import org.junit.After;
28 import org.junit.Before;
29 import org.mockito.ArgumentCaptor;
30 import org.opendaylight.mdsal.binding.api.DataBroker;
31 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
32 import org.opendaylight.mdsal.binding.api.WriteTransaction;
33 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTest;
34 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
35 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
36 import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvoker;
37 import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvokerImpl;
38 import org.opendaylight.ovsdb.lib.OvsdbClient;
39 import org.opendaylight.ovsdb.lib.OvsdbConnection;
40 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
41 import org.opendaylight.ovsdb.lib.operations.Delete;
42 import org.opendaylight.ovsdb.lib.operations.Insert;
43 import org.opendaylight.ovsdb.lib.operations.OperationResult;
44 import org.opendaylight.ovsdb.lib.operations.Operations;
45 import org.opendaylight.ovsdb.lib.operations.Select;
46 import org.opendaylight.ovsdb.lib.operations.Update;
47 import org.opendaylight.ovsdb.lib.operations.Where;
48 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
49 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
50 import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
51 import org.opendaylight.ovsdb.lib.schema.typed.TypedDatabaseSchema;
52 import org.opendaylight.ovsdb.utils.mdsal.utils.TransactionHistory;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentationBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalSwitchAttributes;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitchesKey;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacs;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacs;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
68 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
70 import org.opendaylight.yangtools.yang.binding.DataObject;
71 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
72 import org.slf4j.Logger;
73 import org.slf4j.LoggerFactory;
75 public class DataChangeListenerTestBase extends AbstractDataBrokerTest {
77 static Logger LOG = LoggerFactory.getLogger(DataChangeListenerTestBase.class);
79 static DataBroker dataBroker;
81 EntityOwnershipService entityOwnershipService;
82 OvsdbClient ovsdbClient;
83 TypedDatabaseSchema dbSchema;
84 ListenableFuture<TypedDatabaseSchema> listenableDbSchema = mock(ListenableFuture.class);
85 TransactionInvoker transactionInvoker;
86 OvsdbConnectionInfo connectionInfo;
87 Operations operations;
88 HwvtepDataChangeListener hwvtepDataChangeListener;
89 HwvtepConnectionManager hwvtepConnectionManager;
90 HwvtepConnectionInstance connectionInstance;
92 ArgumentCaptor<TypedBaseTable> insertOpCapture;
93 ArgumentCaptor<List> transactCaptor;
96 InstanceIdentifier<Node> nodeIid;
97 InstanceIdentifier<LogicalSwitches> ls0Iid;
98 InstanceIdentifier<LogicalSwitches> ls1Iid;
101 public void setupTest() throws Exception {
103 * Use the same databroker across tests ,otherwise the following exception is thrown
104 * Caused by: java.lang.RuntimeException: org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.
105 * topology.rev131021.node.attributes.SupportingNode$StreamWriter: frozen class (cannot edit)
107 if (dataBroker == null) {
108 dataBroker = super.getDataBroker();
110 entityOwnershipService = mock(EntityOwnershipService.class);
111 nodeUuid = java.util.UUID.randomUUID().toString();
112 nodeIid = createInstanceIdentifier(nodeUuid);
113 ls0Iid = nodeIid.augmentation(HwvtepGlobalAugmentation.class).child(LogicalSwitches.class,
114 new LogicalSwitchesKey(new HwvtepNodeName("ls0")));
115 ls1Iid = nodeIid.augmentation(HwvtepGlobalAugmentation.class).child(LogicalSwitches.class,
116 new LogicalSwitchesKey(new HwvtepNodeName("ls1")));
118 mockConnectionInstance();
119 mockConnectionManager();
122 addNode(LogicalDatastoreType.OPERATIONAL);
123 addNode(LogicalDatastoreType.CONFIGURATION);
124 hwvtepDataChangeListener = new HwvtepDataChangeListener(dataBroker, hwvtepConnectionManager);
128 public void tearDown() throws Exception {
129 hwvtepDataChangeListener.close();
130 deleteNode(LogicalDatastoreType.OPERATIONAL);
131 deleteNode(LogicalDatastoreType.CONFIGURATION);
134 static final void setFinalStatic(final Class<?> cls, final String fieldName, final Object newValue)
135 throws SecurityException, ReflectiveOperationException {
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(
151 "hwvtep_schema.json")) {
152 ObjectMapper mapper = new ObjectMapper();
153 JsonNode jsonNode = mapper.readTree(resourceAsStream);
154 dbSchema = TypedDatabaseSchema.of(DatabaseSchema.fromJson(HwvtepSchemaConstants.HARDWARE_VTEP,
155 jsonNode.get("result")));
156 listenableDbSchema = mock(ListenableFuture.class);
157 doReturn(dbSchema).when(listenableDbSchema).get();
158 } catch (IOException | ExecutionException | InterruptedException e) {
159 LOG.error("Failed to load schema", e);
163 private void mockConnectionManager() throws IllegalAccessException {
164 hwvtepConnectionManager = spy(new HwvtepConnectionManager(dataBroker, transactionInvoker,
165 entityOwnershipService, mock(OvsdbConnection.class)));
166 doReturn(connectionInstance).when(hwvtepConnectionManager).getConnectionInstance(
167 any(HwvtepPhysicalSwitchAttributes.class));
168 doReturn(connectionInstance).when(hwvtepConnectionManager).getConnectionInstance(any(Node.class));
169 doReturn(connectionInstance).when(hwvtepConnectionManager).getConnectionInstanceFromNodeIid(
170 any(InstanceIdentifier.class));
173 void mockConnectionInstance() throws IllegalAccessException {
174 connectionInfo = mock(OvsdbConnectionInfo.class);
175 doReturn(mock(InetAddress.class)).when(connectionInfo).getRemoteAddress();
177 ovsdbClient = mock(OvsdbClient.class);
178 doReturn(true).when(ovsdbClient).isActive();
179 doReturn(connectionInfo).when(ovsdbClient).getConnectionInfo();
180 doReturn(listenableDbSchema).when(ovsdbClient).getSchema(anyString());
182 transactionInvoker = new TransactionInvokerImpl(dataBroker);
184 connectionInstance = new HwvtepConnectionInstance(null, null, ovsdbClient, nodeIid, transactionInvoker,
186 connectionInstance.reconciliationFt.set(Boolean.TRUE);
187 connectionInstance.firstUpdateTriggered.set(true);
188 connectionInstance.setControllerTxHistory(new TransactionHistory(10000, 7500));
189 connectionInstance.setDeviceUpdateHistory(new TransactionHistory(10000, 7500));
190 connectionInstance.createTransactInvokers();
193 void mockOperations() {
198 * Resets the captures so that we can validate the captors of the immediate next execution.
200 void resetOperations() {
201 insertOpCapture = ArgumentCaptor.forClass(TypedBaseTable.class);
202 Delete delete = mock(Delete.class);
203 Where where = mock(Where.class);
204 doReturn(where).when(delete).where(any());
205 Insert insert = mock(Insert.class);
206 doReturn(insert).when(insert).withId(any(String.class));
207 Operations mockOp = mock(Operations.class);
208 doReturn(insert).when(mockOp).insert(insertOpCapture.capture());
209 Update update = mock(Update.class);
210 doReturn(update).when(mockOp).update(insertOpCapture.capture());
211 Select select = mock(Select.class);
212 doReturn(select).when(mockOp).select(any(GenericTableSchema.class));
213 doReturn(where).when(update).where(any());
214 doReturn(delete).when(mockOp).delete(any());
219 setFinalStatic(Operations.class, "op", mockOp);
220 } catch (SecurityException | ReflectiveOperationException e) {
221 throw new AssertionError("Set of Operations.op field failed", e);
224 ListenableFuture<List<OperationResult>> ft = mock(ListenableFuture.class);
225 transactCaptor = ArgumentCaptor.forClass(List.class);
226 doReturn(ft).when(ovsdbClient).transact(any(DatabaseSchema.class), transactCaptor.capture());
229 void addNode(final LogicalDatastoreType logicalDatastoreType) throws Exception {
230 NodeBuilder nodeBuilder = prepareNode(nodeIid);
231 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
232 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
233 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
234 transaction.put(logicalDatastoreType, nodeIid, nodeBuilder.build(), WriteTransaction.CREATE_MISSING_PARENTS);
235 transaction.commit();
238 void deleteNode(final LogicalDatastoreType logicalDatastoreType) {
239 ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
240 tx.delete(logicalDatastoreType, nodeIid);
244 Node addData(final LogicalDatastoreType logicalDatastoreType, final Class<? extends DataObject> dataObject,
245 final String[]... data) {
246 NodeBuilder nodeBuilder = prepareNode(nodeIid);
247 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
248 if (LogicalSwitches.class == dataObject) {
249 TestBuilders.addLogicalSwitches(builder, data);
251 if (TerminationPoint.class == dataObject) {
252 TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
254 if (RemoteUcastMacs.class == dataObject) {
255 TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
257 if (RemoteMcastMacs.class == dataObject) {
258 TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
260 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
261 return mergeNode(logicalDatastoreType, nodeIid, nodeBuilder);
264 void deleteData(final LogicalDatastoreType logicalDatastoreType, final Class<? extends DataObject> dataObject,
265 final String[]... data) {
266 NodeBuilder nodeBuilder = prepareNode(nodeIid);
267 ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
268 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
269 if (LogicalSwitches.class == dataObject) {
270 List<LogicalSwitches> logicalSwitches = TestBuilders.addLogicalSwitches(builder, data);
272 for (LogicalSwitches ls : logicalSwitches) {
273 InstanceIdentifier<LogicalSwitches> key =
274 nodeIid.augmentation(HwvtepGlobalAugmentation.class).child(LogicalSwitches.class, ls.key());
275 tx.delete(logicalDatastoreType, key);
278 if (TerminationPoint.class == dataObject) {
279 TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
281 if (RemoteUcastMacs.class == dataObject) {
282 List<RemoteUcastMacs> macs = TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
283 for (RemoteUcastMacs mac : macs) {
284 InstanceIdentifier<RemoteUcastMacs> key =
285 nodeIid.augmentation(HwvtepGlobalAugmentation.class).child(RemoteUcastMacs.class, mac.key());
286 tx.delete(logicalDatastoreType, key);
289 if (RemoteMcastMacs.class == dataObject) {
290 List<RemoteMcastMacs> macs = TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
291 for (RemoteMcastMacs mac : macs) {
292 InstanceIdentifier<RemoteMcastMacs> key =
293 nodeIid.augmentation(HwvtepGlobalAugmentation.class).child(RemoteMcastMacs.class, mac.key());
294 tx.delete(logicalDatastoreType, key);
300 NodeBuilder prepareNode(final InstanceIdentifier<Node> iid) {
301 NodeBuilder nodeBuilder = new NodeBuilder();
302 nodeBuilder.setNodeId(iid.firstKeyOf(Node.class).getNodeId());
306 Node mergeNode(final LogicalDatastoreType datastoreType, final InstanceIdentifier<Node> id,
307 final NodeBuilder nodeBuilder) {
308 Node node = nodeBuilder.build();
309 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
310 transaction.merge(datastoreType, id, node, WriteTransaction.CREATE_MISSING_PARENTS);
311 transaction.commit();
315 public InstanceIdentifier<Node> createInstanceIdentifier(final String nodeIdString) {
316 NodeId nodeId = new NodeId(new Uri(nodeIdString));
317 NodeKey nodeKey = new NodeKey(nodeId);
318 TopologyKey topoKey = new TopologyKey(HwvtepSouthboundConstants.HWVTEP_TOPOLOGY_ID);
319 return InstanceIdentifier.builder(NetworkTopology.class)
320 .child(Topology.class, topoKey)
321 .child(Node.class, nodeKey)