2 * Copyright (c) 2015 Inocybe Technologies 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.southbound;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNull;
13 import static org.mockito.Matchers.any;
14 import static org.mockito.Matchers.anyString;
15 import static org.mockito.Matchers.eq;
16 import static org.mockito.Mockito.doNothing;
17 import static org.mockito.Mockito.doReturn;
18 import static org.mockito.Mockito.mock;
19 import static org.mockito.Mockito.times;
20 import static org.mockito.Mockito.verify;
21 import static org.mockito.Mockito.when;
23 import java.util.ArrayList;
24 import java.util.HashMap;
25 import java.util.HashSet;
26 import java.util.List;
30 import org.junit.Before;
31 import org.junit.Test;
32 import org.junit.runner.RunWith;
33 import org.mockito.Mock;
34 import org.mockito.Mockito;
35 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
36 import org.opendaylight.ovsdb.lib.EchoServiceCallbackFilters;
37 import org.opendaylight.ovsdb.lib.LockAquisitionCallback;
38 import org.opendaylight.ovsdb.lib.LockStolenCallback;
39 import org.opendaylight.ovsdb.lib.MonitorCallBack;
40 import org.opendaylight.ovsdb.lib.MonitorHandle;
41 import org.opendaylight.ovsdb.lib.OvsdbClient;
42 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
43 import org.opendaylight.ovsdb.lib.message.MonitorRequest;
44 import org.opendaylight.ovsdb.lib.message.MonitorRequestBuilder;
45 import org.opendaylight.ovsdb.lib.message.MonitorSelect;
46 import org.opendaylight.ovsdb.lib.message.TableUpdates;
47 import org.opendaylight.ovsdb.lib.operations.OperationResult;
48 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
49 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
50 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
51 import org.opendaylight.ovsdb.southbound.ovsdb.transact.BridgeOperationalState;
52 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactCommand;
53 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactInvoker;
54 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
59 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
60 import org.powermock.api.mockito.PowerMockito;
61 import org.powermock.api.support.membermodification.MemberMatcher;
62 import org.powermock.api.support.membermodification.MemberModifier;
63 import org.powermock.core.classloader.annotations.PrepareForTest;
64 import org.powermock.modules.junit4.PowerMockRunner;
65 import org.powermock.reflect.Whitebox;
67 import com.google.common.util.concurrent.ListenableFuture;
69 @PrepareForTest({OvsdbConnectionInstance.class, MonitorRequestBuilder.class})
70 @RunWith(PowerMockRunner.class)
72 public class OvsdbConnectionInstanceTest {
73 @Mock private OvsdbConnectionInstance ovsdbConnectionInstance;
74 @Mock private OvsdbClient client;
75 @Mock private ConnectionInfo connectionInfo;
76 @Mock private TransactionInvoker txInvoker;
77 @Mock private MonitorCallBack callback;
78 @Mock private ConnectionInfo key;
79 @Mock private InstanceIdentifier<Node> instanceIdentifier;
80 private Map<DatabaseSchema,TransactInvoker> transactInvokers;
83 public void setUp() throws Exception {
84 ovsdbConnectionInstance = PowerMockito.mock(OvsdbConnectionInstance.class, Mockito.CALLS_REAL_METHODS);
85 MemberModifier.field(OvsdbConnectionInstance.class, "txInvoker").set(ovsdbConnectionInstance, txInvoker);
86 MemberModifier.field(OvsdbConnectionInstance.class, "connectionInfo").set(ovsdbConnectionInstance, key);
87 MemberModifier.field(OvsdbConnectionInstance.class, "instanceIdentifier").set(ovsdbConnectionInstance, instanceIdentifier);
88 MemberModifier.field(OvsdbConnectionInstance.class, "hasDeviceOwnership").set(ovsdbConnectionInstance, false);
91 @SuppressWarnings({ "unchecked", "rawtypes" })
93 public void testTransact() throws Exception {
94 TransactCommand command = mock(TransactCommand.class);
95 transactInvokers = new HashMap();
97 //init instance variables
98 TransactInvoker transactInvoker1 = mock(TransactInvoker.class);
99 TransactInvoker transactInvoker2 = mock(TransactInvoker.class);
100 transactInvokers.put(mock(DatabaseSchema.class), transactInvoker1);
101 transactInvokers.put(mock(DatabaseSchema.class), transactInvoker2);
102 MemberModifier.field(OvsdbConnectionInstance.class, "transactInvokers").set(ovsdbConnectionInstance , transactInvokers);
104 ovsdbConnectionInstance.transact(command, mock(BridgeOperationalState.class), mock(AsyncDataChangeEvent.class));
105 verify(transactInvoker1).invoke(any(TransactCommand.class), any(BridgeOperationalState.class), any(AsyncDataChangeEvent.class));
106 verify(transactInvoker2).invoke(any(TransactCommand.class), any(BridgeOperationalState.class), any(AsyncDataChangeEvent.class));
109 @SuppressWarnings("unchecked")
111 public void testRegisterCallbacks() throws Exception {
113 //callback not null case
114 MemberModifier.field(OvsdbConnectionInstance.class, "callback").set(ovsdbConnectionInstance , callback);
115 ovsdbConnectionInstance.registerCallbacks();
116 verify(ovsdbConnectionInstance, times(0)).getDatabases();
119 MemberModifier.field(OvsdbConnectionInstance.class, "callback").set(ovsdbConnectionInstance , null);
120 ListenableFuture<List<String>> listenableFuture = mock(ListenableFuture.class);
121 List<String> databases = new ArrayList<>();
122 databases.add("Open_vSwitch");
124 doReturn(listenableFuture).when(ovsdbConnectionInstance).getDatabases();
125 when(listenableFuture.get()).thenReturn(databases);
127 ListenableFuture<DatabaseSchema> listenableDbSchema = mock(ListenableFuture.class);
128 DatabaseSchema dbSchema= mock(DatabaseSchema.class);
129 doReturn(listenableDbSchema).when(ovsdbConnectionInstance).getSchema(anyString());
130 when(listenableDbSchema.get()).thenReturn(dbSchema);
132 MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionInstance.class, "monitorAllTables", String.class,DatabaseSchema.class));
133 ovsdbConnectionInstance.registerCallbacks();
134 PowerMockito.verifyPrivate(ovsdbConnectionInstance, times(1)).invoke("monitorAllTables", anyString(), any(DatabaseSchema.class));
137 @SuppressWarnings({ "unchecked", "rawtypes" })
139 public void testCreateTransactInvokers() throws Exception {
140 //transactInvokers not null case
141 transactInvokers = new HashMap();
142 MemberModifier.field(OvsdbConnectionInstance.class, "transactInvokers").set(ovsdbConnectionInstance , transactInvokers);
143 ovsdbConnectionInstance.createTransactInvokers();
144 verify(ovsdbConnectionInstance, times(0)).getSchema(anyString());
146 //transactInvokers null case
147 MemberModifier.field(OvsdbConnectionInstance.class, "transactInvokers").set(ovsdbConnectionInstance , null);
149 ListenableFuture<DatabaseSchema> listenableDbSchema = mock(ListenableFuture.class);
150 DatabaseSchema dbSchema= mock(DatabaseSchema.class);
151 doReturn(listenableDbSchema).when(ovsdbConnectionInstance).getSchema(anyString());
152 when(listenableDbSchema.get()).thenReturn(dbSchema);
154 ovsdbConnectionInstance.createTransactInvokers();
155 verify(ovsdbConnectionInstance).getSchema(anyString());
157 Map<DatabaseSchema,TransactInvoker> testTransactInvokers = Whitebox.getInternalState(ovsdbConnectionInstance, "transactInvokers");
158 assertEquals("Error, size of the hashmap is incorrect", 1, testTransactInvokers.size());
161 @SuppressWarnings("unchecked")
163 public void testMonitorAllTables() throws Exception {
164 Set<String> tables = new HashSet<>();
165 tables.add("tableName1");
166 tables.add("tableName2");
167 DatabaseSchema dbSchema = mock(DatabaseSchema.class);
168 when(dbSchema.getName()).thenReturn(SouthboundConstants.OPEN_V_SWITCH);
169 when(dbSchema.getTables()).thenReturn(tables);
170 GenericTableSchema tableSchema = mock(GenericTableSchema.class);
171 when(dbSchema.table(anyString(), eq(GenericTableSchema.class))).thenReturn(tableSchema);
173 Set<String> columns = new HashSet<>();
174 columns.add("columnName1");
175 columns.add("columnName2");
176 when(tableSchema.getColumns()).thenReturn(columns);
177 MonitorRequestBuilder<GenericTableSchema> monitorBuilder = mock(MonitorRequestBuilder.class);
178 PowerMockito.mockStatic(MonitorRequestBuilder.class);
179 when(MonitorRequestBuilder.builder(any(GenericTableSchema.class))).thenReturn(monitorBuilder);
180 when(monitorBuilder.addColumn(anyString())).thenReturn(monitorBuilder);
181 MonitorRequest monitorReq = mock(MonitorRequest.class);
182 when(monitorBuilder.with(any(MonitorSelect.class))).thenReturn(monitorBuilder);
183 when(monitorBuilder.build()).thenReturn(monitorReq);
185 MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionInstance.class, "monitor", DatabaseSchema.class, List.class, MonitorCallBack.class));
186 TableUpdates tableUpdates = mock(TableUpdates.class);
187 when(ovsdbConnectionInstance.monitor(any(DatabaseSchema.class), any(List.class), any(MonitorCallBack.class))).thenReturn(tableUpdates);
188 MemberModifier.field(OvsdbConnectionInstance.class, "callback").set(ovsdbConnectionInstance, callback);
189 doNothing().when(callback).update(any(TableUpdates.class), any(DatabaseSchema.class));
191 Whitebox.invokeMethod(ovsdbConnectionInstance, "monitorAllTables", "database", dbSchema);
192 PowerMockito.verifyPrivate(ovsdbConnectionInstance, times(1)).invoke("monitorAllTables", anyString(), any(DatabaseSchema.class));
194 verify(monitorBuilder, times(4)).addColumn(anyString());
197 @SuppressWarnings({ "unchecked" })
199 public void testOvsdbConnectionInstance() throws Exception {
200 MemberModifier.field(OvsdbConnectionInstance.class, "client").set(ovsdbConnectionInstance, client);
201 DatabaseSchema databaseSchema = mock(DatabaseSchema.class);
203 //test getDatabases()
204 ListenableFuture<List<String>> listenableFuture = mock(ListenableFuture.class);
205 when(client.getDatabases()).thenReturn(listenableFuture);
206 assertEquals("Error, did not return correct ListenableFuture<List<String>> object", listenableFuture, ovsdbConnectionInstance.getDatabases());
207 verify(client).getDatabases();
210 ListenableFuture<DatabaseSchema> futureDatabaseSchema = mock(ListenableFuture.class);
211 when(client.getSchema(anyString())).thenReturn(futureDatabaseSchema);
212 assertEquals("Error, did not return correct ListenableFuture<DatabaseSchema> object", futureDatabaseSchema, ovsdbConnectionInstance.getSchema(anyString()));
213 verify(client).getSchema(anyString());
215 //test transactBuilder()
216 TransactionBuilder transactionBuilder = mock(TransactionBuilder.class);
217 when(client.transactBuilder(any(DatabaseSchema.class))).thenReturn(transactionBuilder);
218 assertEquals("Error, did not return correct TransactionBuilder object", transactionBuilder, ovsdbConnectionInstance.transactBuilder(any(DatabaseSchema.class)));
219 verify(client).transactBuilder(any(DatabaseSchema.class));
222 ListenableFuture<List<OperationResult>> futureOperationResult = mock(ListenableFuture.class);
223 when(client.transact(any(DatabaseSchema.class), any(List.class))).thenReturn(futureOperationResult);
224 assertEquals("Error, did not return correct ListenableFuture<List<OperationResult>> object", futureOperationResult, ovsdbConnectionInstance.transact(any(DatabaseSchema.class), any(List.class)));
225 verify(client).transact(any(DatabaseSchema.class), any(List.class));
228 TableUpdates tableUpdates = mock(TableUpdates.class);
229 when(client.monitor(any(DatabaseSchema.class), any(List.class), any(MonitorCallBack.class))).thenReturn(tableUpdates);
230 assertEquals("Error, did not return correct TableUpdates object", tableUpdates, ovsdbConnectionInstance.monitor(any(DatabaseSchema.class), any(List.class), any(MonitorCallBack.class)));
231 verify(client).monitor(any(DatabaseSchema.class), any(List.class), any(MonitorCallBack.class));
233 //test cancelMonitor()
234 doNothing().when(client).cancelMonitor(any(MonitorHandle.class));
235 MonitorHandle monitorHandle = mock(MonitorHandle.class);
236 ovsdbConnectionInstance.cancelMonitor(monitorHandle);
237 verify(client).cancelMonitor(any(MonitorHandle.class));
240 doNothing().when(client).lock(anyString(), any(LockAquisitionCallback.class), any(LockStolenCallback.class));
241 LockAquisitionCallback lockAquisitionCallback = mock(LockAquisitionCallback.class);
242 LockStolenCallback lockStolenCallback = mock(LockStolenCallback.class);
243 ovsdbConnectionInstance.lock("lockId", lockAquisitionCallback, lockStolenCallback);
244 verify(client).lock(anyString(), any(LockAquisitionCallback.class), any(LockStolenCallback.class));
247 ListenableFuture<Boolean> futureBoolean = mock(ListenableFuture.class);
248 when(client.steal(anyString())).thenReturn(futureBoolean);
249 assertEquals("Error, did not return correct ListenableFuture<Boolean> object", futureBoolean, ovsdbConnectionInstance.steal(anyString()));
250 verify(client).steal(anyString());
253 when(client.unLock(anyString())).thenReturn(futureBoolean);
254 assertEquals("Error, did not return correct ListenableFuture<Boolean> object", futureBoolean, ovsdbConnectionInstance.unLock(anyString()));
255 verify(client).unLock(anyString());
257 //test startEchoService()
258 EchoServiceCallbackFilters echoServiceCallbackFilters = mock(EchoServiceCallbackFilters.class);
259 doNothing().when(client).startEchoService(any(EchoServiceCallbackFilters.class));
260 ovsdbConnectionInstance.startEchoService(echoServiceCallbackFilters);
261 verify(client).startEchoService(any(EchoServiceCallbackFilters.class));
263 //test stopEchoService()
264 doNothing().when(client).stopEchoService();
265 ovsdbConnectionInstance.stopEchoService();
266 verify(client).stopEchoService();
269 when(client.isActive()).thenReturn(true);
270 assertEquals("Error, does not match isActive()", true, ovsdbConnectionInstance.isActive());
271 verify(client).isActive();
274 doNothing().when(client).disconnect();
275 ovsdbConnectionInstance.disconnect();
276 verify(client).disconnect();
278 //test getDatabaseSchema()
279 when(client.getDatabaseSchema(anyString())).thenReturn(databaseSchema);
280 assertEquals("Error, did not return correct DatabaseSchema object", databaseSchema, ovsdbConnectionInstance.getDatabaseSchema(anyString()));
281 verify(client).getDatabaseSchema(anyString());
283 //test getConnectionInfo()
284 OvsdbConnectionInfo ovsdbConnectionInfo = mock(OvsdbConnectionInfo.class);
285 when(client.getConnectionInfo()).thenReturn(ovsdbConnectionInfo);
286 assertEquals("Error, did not return correct OvsdbConnectionInfo object", ovsdbConnectionInfo, ovsdbConnectionInstance.getConnectionInfo());
287 verify(client).getConnectionInfo();
289 //test getMDConnectionInfo()
290 assertEquals("Error, incorrect connectionInfo", key, ovsdbConnectionInstance.getMDConnectionInfo());
292 //test setMDConnectionInfo()
293 ovsdbConnectionInstance.setMDConnectionInfo(key);
294 assertEquals("Error, incorrect ConnectionInfo", key, Whitebox.getInternalState(ovsdbConnectionInstance, "connectionInfo"));
296 //test getInstanceIdentifier()
297 assertEquals("Error, incorrect instanceIdentifier", instanceIdentifier, ovsdbConnectionInstance.getInstanceIdentifier());
300 NodeKey nodeKey = mock(NodeKey.class);
301 NodeId nodeId = mock(NodeId.class);
302 MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionInstance.class, "getNodeKey"));
303 when(ovsdbConnectionInstance.getNodeKey()).thenReturn(nodeKey);
304 when(nodeKey.getNodeId()).thenReturn(nodeId);
305 assertEquals("Error, incorrect NodeId object", nodeId, ovsdbConnectionInstance.getNodeId());
307 //test setInstanceIdentifier()
308 ovsdbConnectionInstance.setInstanceIdentifier(instanceIdentifier);
309 assertEquals("Error, incorrect instanceIdentifier", instanceIdentifier, Whitebox.getInternalState(ovsdbConnectionInstance, "instanceIdentifier"));
312 MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionInstance.class, "monitor", DatabaseSchema.class, List.class, MonitorHandle.class, MonitorCallBack.class));
313 when(ovsdbConnectionInstance.monitor(any(DatabaseSchema.class), any(List.class), any(MonitorHandle.class), any(MonitorCallBack.class))).thenReturn(null);
314 assertNull(ovsdbConnectionInstance.monitor(any(DatabaseSchema.class), any(List.class), any(MonitorHandle.class), any(MonitorCallBack.class)));