2 * Copyright (c) 2016 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.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;
55 import java.io.InputStream;
56 import java.net.InetAddress;
57 import java.util.List;
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;
69 public class DataChangeListenerTestBase extends AbstractDataBrokerTest {
71 static Logger LOG = LoggerFactory.getLogger(DataChangeListenerTestBase.class);
73 static DataBroker dataBroker;
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;
86 ArgumentCaptor<TypedBaseTable> insertOpCapture;
87 ArgumentCaptor<List> transactCaptor;
90 InstanceIdentifier<Node> nodeIid;
93 public void setupTest() throws Exception {
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)
99 if (dataBroker == null) {
100 dataBroker = getDataBroker();
102 entityOwnershipService = mock(EntityOwnershipService.class);
104 mockConnectionInstance();
105 mockConnectionManager();
108 nodeUuid = java.util.UUID.randomUUID().toString();
109 nodeIid = createInstanceIdentifier(nodeUuid);
110 addNode(OPERATIONAL);
111 addNode(CONFIGURATION);
112 hwvtepDataChangeListener = new HwvtepDataChangeListener(dataBroker, hwvtepConnectionManager);
116 public void tearDown() throws Exception {
117 hwvtepDataChangeListener.close();
118 deleteNode(OPERATIONAL);
119 deleteNode(CONFIGURATION);
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);
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);
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());
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 connectionInstance.createTransactInvokers();
163 void mockOperations() {
168 * resets the captures so that we can validate the captors of the immediate next execution
170 void resetOperations() {
171 insertOpCapture = ArgumentCaptor.forClass(TypedBaseTable.class);
172 Insert insert = mock(Insert.class);
173 when(insert.withId(any(String.class))).thenReturn(insert);
174 Operations.op = PowerMockito.mock(Operations.class);
175 when(Operations.op.comment(any(String.class))).thenReturn(mock(Comment.class));
176 when(Operations.op.insert(insertOpCapture.capture())).thenReturn(insert);
178 ListenableFuture<List<OperationResult>> ft = mock(ListenableFuture.class);
179 transactCaptor = ArgumentCaptor.forClass(List.class);
180 when(ovsdbClient.transact(any(DatabaseSchema.class), transactCaptor.capture())).thenReturn(ft);
183 void addNode(LogicalDatastoreType logicalDatastoreType) throws Exception {
184 NodeBuilder nodeBuilder = prepareNode(nodeIid);
185 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
186 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
187 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
188 transaction.put(logicalDatastoreType, nodeIid, nodeBuilder.build(), WriteTransaction.CREATE_MISSING_PARENTS);
189 transaction.submit();
192 void deleteNode(LogicalDatastoreType logicalDatastoreType) {
193 ReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
194 tx.delete(logicalDatastoreType, nodeIid);
198 void addData(LogicalDatastoreType logicalDatastoreType, Class<? extends DataObject> dataObject,
200 NodeBuilder nodeBuilder = prepareNode(nodeIid);
201 HwvtepGlobalAugmentationBuilder builder = new HwvtepGlobalAugmentationBuilder();
202 if (LogicalSwitches.class == dataObject) {
203 TestBuilders.addLogicalSwitches(builder, data);
205 if (TerminationPoint.class == dataObject) {
206 TestBuilders.addGlobalTerminationPoints(nodeBuilder, nodeIid, data);
208 if (RemoteUcastMacs.class == dataObject) {
209 TestBuilders.addRemoteUcastMacs(nodeIid, builder, data);
211 if (RemoteMcastMacs.class == dataObject) {
212 TestBuilders.addRemoteMcastMacs(nodeIid, builder, data);
214 nodeBuilder.addAugmentation(HwvtepGlobalAugmentation.class, builder.build());
215 mergeNode(logicalDatastoreType, nodeIid, nodeBuilder);
218 NodeBuilder prepareNode(InstanceIdentifier<Node> iid) {
219 NodeBuilder nodeBuilder = new NodeBuilder();
220 nodeBuilder.setNodeId(iid.firstKeyOf(Node.class).getNodeId());
224 Node mergeNode(LogicalDatastoreType datastoreType, InstanceIdentifier<Node> id, NodeBuilder nodeBuilder) {
225 Node node = nodeBuilder.build();
226 WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
227 transaction.merge(datastoreType, id, node, WriteTransaction.CREATE_MISSING_PARENTS);
228 transaction.submit();
232 public InstanceIdentifier<Node> createInstanceIdentifier(String nodeIdString) {
233 NodeId nodeId = new NodeId(new Uri(nodeIdString));
234 NodeKey nodeKey = new NodeKey(nodeId);
235 TopologyKey topoKey = new TopologyKey(HwvtepSouthboundConstants.HWVTEP_TOPOLOGY_ID);
236 return InstanceIdentifier.builder(NetworkTopology.class)
237 .child(Topology.class, topoKey)
238 .child(Node.class, nodeKey)