southbound/southbound-impl/src/test/java/org/opendaylight/ovsdb/southbound/OvsdbConnectionManagerTest.java

   1 /*
   2  * Copyright (c) 2015 Inocybe Technologies and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.ovsdb.southbound;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Matchers.anyInt;
  14 import static org.mockito.Mockito.doNothing;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.verify;
  17 import static org.mockito.Mockito.when;
  18
  19 import java.net.InetAddress;
  20 import java.util.Map;
  21 import java.util.concurrent.ConcurrentHashMap;
  22
  23 import org.junit.Before;
  24 import org.junit.Ignore;
  25 import org.junit.Test;
  26 import org.junit.runner.RunWith;
  27 import org.mockito.Mock;
  28 import org.mockito.Mockito;
  29 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  30 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  31 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  32 import org.opendaylight.ovsdb.lib.OvsdbClient;
  33 import org.opendaylight.ovsdb.lib.OvsdbConnection;
  34 import org.opendaylight.ovsdb.lib.impl.OvsdbConnectionService;
  35 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionCommand;
  36 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAttributes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.powermock.api.mockito.PowerMockito;
  45 import org.powermock.api.support.membermodification.MemberMatcher;
  46 import org.powermock.api.support.membermodification.MemberModifier;
  47 import org.powermock.core.classloader.annotations.PrepareForTest;
  48 import org.powermock.modules.junit4.PowerMockRunner;
  49 import org.powermock.reflect.Whitebox;
  50
  51 import com.google.common.base.Optional;
  52
  53 @PrepareForTest({SouthboundMapper.class, OvsdbConnectionManager.class, OvsdbConnectionService.class, InstanceIdentifier.class, SouthboundUtil.class, Optional.class})
  54 @RunWith(PowerMockRunner.class)
  55 public class OvsdbConnectionManagerTest {
  56
  57     @Mock private OvsdbConnectionManager ovsdbConnectionManager;
  58     @Mock private DataBroker db;
  59     @Mock private TransactionInvoker txInvoker;
  60     @Mock private EntityOwnershipService entityOwnershipService;
  61     @Mock private OvsdbConnection ovsdbConnection;
  62     private Map<ConnectionInfo,OvsdbConnectionInstance> clients;
  63     private Map<ConnectionInfo,InstanceIdentifier<Node>> instanceIdentifiers;
  64     private Map<Entity, OvsdbConnectionInstance> entityConnectionMap;
  65
  66     @Mock private InstanceIdentifier<Node> iid;
  67
  68     @Before
  69     public void setUp() throws Exception {
  70         ovsdbConnectionManager = PowerMockito.mock(OvsdbConnectionManager.class, Mockito.CALLS_REAL_METHODS);
  71         MemberModifier.field(OvsdbConnectionManager.class, "db").set(ovsdbConnectionManager, db);
  72         MemberModifier.field(OvsdbConnectionManager.class, "txInvoker").set(ovsdbConnectionManager, txInvoker);
  73         MemberModifier.field(OvsdbConnectionManager.class, "entityOwnershipService").set(ovsdbConnectionManager, entityOwnershipService);
  74         MemberModifier.field(OvsdbConnectionManager.class, "ovsdbConnection")
  75                 .set(ovsdbConnectionManager, ovsdbConnection);
  76         entityConnectionMap = new ConcurrentHashMap<>();
  77     }
  78     @Test
  79     public void testConnected() throws Exception {
  80         OvsdbConnectionInstance client = mock(OvsdbConnectionInstance.class);
  81         OvsdbClient externalClient = mock(OvsdbClient.class);
  82         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "connectedButCallBacksNotRegistered", OvsdbClient.class));
  83         when(ovsdbConnectionManager.connectedButCallBacksNotRegistered(any(OvsdbClient.class))).thenReturn(client);
  84         doNothing().when(client).registerCallbacks();
  85
  86         //TODO: Write unit tests for EntityOwnershipService
  87         InstanceIdentifier<Node> iid = mock(InstanceIdentifier.class);
  88         when(client.getInstanceIdentifier()).thenReturn(iid);
  89         MemberModifier.field(OvsdbConnectionManager.class, "entityConnectionMap").set(ovsdbConnectionManager, entityConnectionMap);
  90         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getEntityFromConnectionInstance", OvsdbConnectionInstance.class));
  91
  92         //TODO: Write unit tests for entity ownership service related code.
  93         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "registerEntityForOwnership", OvsdbConnectionInstance.class));
  94         ovsdbConnectionManager.connected(externalClient);
  95     }
  96
  97     @SuppressWarnings("unchecked")
  98     @Test
  99     public void testConnectedButCallBacksNotRegistered() throws Exception {
 100         OvsdbClient externalClient = mock(OvsdbClient.class, Mockito.RETURNS_DEEP_STUBS);
 101         OvsdbConnectionInstance client = mock(OvsdbConnectionInstance.class);
 102
 103         InetAddress ip = mock(InetAddress.class);
 104
 105         when(externalClient.getConnectionInfo().getRemoteAddress()).thenReturn(ip);
 106         when(externalClient.getConnectionInfo().getRemotePort()).thenReturn(8080);
 107
 108         ConnectionInfo key = mock(ConnectionInfo.class);
 109         PowerMockito.mockStatic(SouthboundMapper.class);
 110         when(SouthboundMapper.createConnectionInfo(any(OvsdbClient.class))).thenReturn(key);
 111
 112         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getInstanceIdentifier", ConnectionInfo.class));
 113         InstanceIdentifier<Node> iid = mock(InstanceIdentifier.class);
 114         when(ovsdbConnectionManager.getInstanceIdentifier(key)).thenReturn(iid);
 115
 116         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getConnectionInstance", ConnectionInfo.class));
 117         when(ovsdbConnectionManager.getConnectionInstance(key)).thenReturn(null);
 118
 119         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "putConnectionInstance", ConnectionInfo.class, OvsdbConnectionInstance.class));
 120         doNothing().when(client).createTransactInvokers();
 121         PowerMockito.whenNew(OvsdbConnectionInstance.class).
 122         withArguments(any(ConnectionInfo.class), any(OvsdbClient.class),any(TransactionInvoker.class), any(InstanceIdentifier.class)).
 123         thenReturn(client);
 124
 125         assertEquals("Error, did not receive correct OvsdbConnectionInstance object", client, ovsdbConnectionManager.connectedButCallBacksNotRegistered(externalClient));
 126     }
 127
 128     @Test
 129     public void testDisconnected() throws Exception {
 130         OvsdbClient client = mock(OvsdbClient.class, Mockito.RETURNS_DEEP_STUBS);
 131         OvsdbConnectionInstance ovsdbConnectionInstance = mock(OvsdbConnectionInstance.class);
 132         InetAddress ip = mock(InetAddress.class);
 133         when(client.getConnectionInfo().getRemoteAddress()).thenReturn(ip);
 134         when(client.getConnectionInfo().getRemotePort()).thenReturn(8080);
 135
 136         ConnectionInfo key = mock(ConnectionInfo.class);
 137         PowerMockito.mockStatic(SouthboundMapper.class);
 138         when(SouthboundMapper.createConnectionInfo(any(OvsdbClient.class))).thenReturn(key);
 139
 140         clients = new ConcurrentHashMap<>();
 141         clients.put(key, ovsdbConnectionInstance);
 142         MemberModifier.field(OvsdbConnectionManager.class, "clients").set(ovsdbConnectionManager, clients);
 143
 144         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getConnectionInstance", ConnectionInfo.class));
 145         when(ovsdbConnectionManager.getConnectionInstance(any(ConnectionInfo.class))).thenReturn(ovsdbConnectionInstance);
 146         doNothing().when(txInvoker).invoke(any(TransactionCommand.class));
 147
 148         when(SouthboundMapper.suppressLocalIpPort(any(ConnectionInfo.class))).thenReturn(key);
 149
 150       //TODO: Write unit tests for EntityOwnershipService
 151         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "unregisterEntityForOwnership", OvsdbConnectionInstance.class));
 152         ovsdbConnectionManager.disconnected(client);
 153         Map<ConnectionInfo,OvsdbConnectionInstance> testClients = Whitebox.getInternalState(ovsdbConnectionManager, "clients");
 154         assertEquals("Error, size of the hashmap is incorrect", 0, testClients.size());
 155     }
 156
 157     @Test
 158     public void testDisconnect() throws Exception {
 159         OvsdbNodeAugmentation ovsdbNode = mock(OvsdbNodeAugmentation.class);
 160         ConnectionInfo connectionInfo = mock(ConnectionInfo.class);
 161         when(ovsdbNode.getConnectionInfo()).thenReturn(connectionInfo);
 162         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getConnectionInstance", ConnectionInfo.class));
 163         OvsdbConnectionInstance ovsdbConnectionInstance = mock(OvsdbConnectionInstance.class);
 164         when(ovsdbConnectionManager.getConnectionInstance(any(ConnectionInfo.class))).thenReturn(ovsdbConnectionInstance);
 165
 166         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "removeInstanceIdentifier", ConnectionInfo.class));
 167
 168         //TODO: Write unit tests for entity ownership service related code.
 169         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "unregisterEntityForOwnership", OvsdbConnectionInstance.class));
 170         ovsdbConnectionManager.disconnect(ovsdbNode);
 171         verify((OvsdbClient)ovsdbConnectionInstance).disconnect();
 172     }
 173
 174     @Ignore
 175     @Test
 176     public void testInit() {
 177         ConnectionInfo key = mock(ConnectionInfo.class);
 178         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getConnectionInstance", ConnectionInfo.class));
 179         OvsdbConnectionInstance ovsdbConnectionInstance = mock(OvsdbConnectionInstance.class);
 180         when(ovsdbConnectionManager.getConnectionInstance(any(ConnectionInfo.class))).thenReturn(ovsdbConnectionInstance);
 181
 182         //client not null
 183         // ovsdbConnectionManager.init(key);
 184         verify(ovsdbConnectionInstance).registerCallbacks();
 185     }
 186
 187     @Test
 188     public void testClose() throws Exception {
 189         ConnectionInfo key1 = mock(ConnectionInfo.class);
 190         ConnectionInfo key2 = mock(ConnectionInfo.class);
 191         OvsdbConnectionInstance ovsdbConnectionInstance1 = mock(OvsdbConnectionInstance.class);
 192         OvsdbConnectionInstance ovsdbConnectionInstance2 = mock(OvsdbConnectionInstance.class);
 193         clients = new ConcurrentHashMap<>();
 194         clients.put(key1, ovsdbConnectionInstance1);
 195         clients.put(key2, ovsdbConnectionInstance2);
 196         MemberModifier.field(OvsdbConnectionManager.class, "clients").set(ovsdbConnectionManager, clients);
 197         ovsdbConnectionManager.close();
 198         verify(ovsdbConnectionInstance1).disconnect();
 199         verify(ovsdbConnectionInstance2).disconnect();
 200     }
 201
 202     @Test
 203     public void testPutAndGetConnectionInstance() throws Exception {
 204         ConnectionInfo key = mock(ConnectionInfo.class);
 205         ConnectionInfo connectionInfo = mock(ConnectionInfo.class);
 206         OvsdbConnectionInstance instance = mock(OvsdbConnectionInstance.class);
 207         PowerMockito.mockStatic(SouthboundMapper.class);
 208         when(SouthboundMapper.suppressLocalIpPort(key)).thenReturn(connectionInfo);
 209
 210         clients = new ConcurrentHashMap<>();
 211         MemberModifier.field(OvsdbConnectionManager.class, "clients").set(ovsdbConnectionManager, clients);
 212
 213         //Test putConnectionInstance()
 214         Whitebox.invokeMethod(ovsdbConnectionManager, "putConnectionInstance", key, instance);
 215         Map<ConnectionInfo,OvsdbConnectionInstance> testClients = Whitebox.getInternalState(ovsdbConnectionManager, "clients");
 216         assertEquals("Error, size of the hashmap is incorrect", 1, testClients.size());
 217
 218         //Test getConnectionInstance(ConnectionInfo key)
 219         assertEquals("Error, returned incorrect OvsdbConnectionInstance object", instance, ovsdbConnectionManager.getConnectionInstance(key));
 220     }
 221
 222     @SuppressWarnings("unchecked")
 223     @Test
 224     public void testPutandGetInstanceIdentifier() throws Exception {
 225         ConnectionInfo key = mock(ConnectionInfo.class);
 226         ConnectionInfo connectionInfo = mock(ConnectionInfo.class);
 227         InstanceIdentifier<Node> iid = mock(InstanceIdentifier.class);
 228         PowerMockito.mockStatic(SouthboundMapper.class);
 229         when(SouthboundMapper.suppressLocalIpPort(key)).thenReturn(connectionInfo);
 230
 231         instanceIdentifiers = new ConcurrentHashMap<>();
 232         MemberModifier.field(OvsdbConnectionManager.class, "instanceIdentifiers").set(ovsdbConnectionManager, instanceIdentifiers);
 233
 234         //Test putInstanceIdentifier()
 235         Whitebox.invokeMethod(ovsdbConnectionManager, "putInstanceIdentifier", key, iid);
 236         Map<ConnectionInfo,OvsdbConnectionInstance> testIids = Whitebox.getInternalState(ovsdbConnectionManager, "instanceIdentifiers");
 237         assertEquals("Error, size of the hashmap is incorrect", 1, testIids.size());
 238
 239         //Test getInstanceIdentifier()
 240         assertEquals("Error returning correct InstanceIdentifier object",iid , ovsdbConnectionManager.getInstanceIdentifier(key));
 241
 242         //Test removeInstanceIdentifier()
 243         Whitebox.invokeMethod(ovsdbConnectionManager, "removeInstanceIdentifier", key);
 244         Map<ConnectionInfo,OvsdbConnectionInstance> testRemoveIids = Whitebox.getInternalState(ovsdbConnectionManager, "instanceIdentifiers");
 245         assertEquals("Error, size of the hashmap is incorrect", 0, testRemoveIids.size());
 246     }
 247
 248     @Test
 249     public void testGetClient() {
 250         OvsdbClient ovsdbClient = mock(OvsdbConnectionInstance.class);
 251
 252         //Test getClient(ConnectionInfo connectionInfo)
 253         ConnectionInfo key = mock(ConnectionInfo.class);
 254         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getConnectionInstance", ConnectionInfo.class));
 255         when(ovsdbConnectionManager.getConnectionInstance(key)).thenReturn((OvsdbConnectionInstance)ovsdbClient);
 256         assertEquals("Error getting correct OvsdbClient object", ovsdbClient, ovsdbConnectionManager.getClient(key));
 257
 258         //Test getClient(OvsdbBridgeAttributes mn)
 259         OvsdbBridgeAttributes mn = mock(OvsdbBridgeAttributes.class);
 260         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getConnectionInstance", OvsdbBridgeAttributes.class));
 261         when(ovsdbConnectionManager.getConnectionInstance(mn)).thenReturn((OvsdbConnectionInstance)ovsdbClient);
 262         assertEquals("Error getting correct OvsdbClient object", ovsdbClient, ovsdbConnectionManager.getClient(mn));
 263
 264         //Test getClient(Node node)
 265         Node node = mock(Node.class);
 266         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getConnectionInstance", Node.class));
 267         when(ovsdbConnectionManager.getConnectionInstance(node)).thenReturn((OvsdbConnectionInstance)ovsdbClient);
 268         assertEquals("Error getting correct OvsdbClient object", ovsdbClient, ovsdbConnectionManager.getClient(node));
 269     }
 270
 271     @SuppressWarnings("unchecked")
 272     @Test
 273     public void testConnect() throws Exception {
 274         OvsdbNodeAugmentation ovsdbNode = mock(OvsdbNodeAugmentation.class);
 275         ConnectionInfo connectionInfo = mock(ConnectionInfo.class);
 276         when(ovsdbNode.getConnectionInfo()).thenReturn(connectionInfo);
 277         IpAddress ipAddr = mock(IpAddress.class);
 278         when(connectionInfo.getRemoteIp()).thenReturn(ipAddr);
 279
 280         PowerMockito.mockStatic(SouthboundMapper.class);
 281         InetAddress ip = mock(InetAddress.class);
 282         when(SouthboundMapper.createInetAddress(any(IpAddress.class))).thenReturn(ip);
 283
 284         OvsdbClient client = mock(OvsdbClient.class);
 285         PowerMockito.mockStatic(OvsdbConnectionService.class);
 286         when(OvsdbConnectionService.getService()).thenReturn(ovsdbConnection);
 287         PortNumber port = mock(PortNumber.class);
 288         when(connectionInfo.getRemotePort()).thenReturn(port);
 289         when(port.getValue()).thenReturn(8080);
 290         when(ovsdbConnection.connect(any(InetAddress.class), anyInt())).thenReturn(client);
 291
 292         //client not null case
 293         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "putInstanceIdentifier", ConnectionInfo.class, InstanceIdentifier.class));
 294         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "connectedButCallBacksNotRegistered", OvsdbClient.class));
 295
 296         PowerMockito.doNothing().when(ovsdbConnectionManager, "putInstanceIdentifier", any(ConnectionInfo.class), any(InstanceIdentifier.class));
 297
 298         OvsdbConnectionInstance ovsdbConnectionInstance = mock(OvsdbConnectionInstance.class);
 299         when(ovsdbConnectionManager.connectedButCallBacksNotRegistered(any(OvsdbClient.class))).thenReturn(ovsdbConnectionInstance);
 300
 301         InstanceIdentifier<Node> iid = mock(InstanceIdentifier.class);
 302         when(ovsdbConnectionInstance.getInstanceIdentifier()).thenReturn(iid);
 303         MemberModifier.field(OvsdbConnectionManager.class, "entityConnectionMap").set(ovsdbConnectionManager, entityConnectionMap);
 304         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "getEntityFromConnectionInstance", OvsdbConnectionInstance.class));
 305         //TODO: Write unit tests for entity ownership service related code.
 306         MemberModifier.suppress(MemberMatcher.method(OvsdbConnectionManager.class, "registerEntityForOwnership", OvsdbConnectionInstance.class));
 307         assertEquals("ERROR", client, ovsdbConnectionManager.connect(PowerMockito.mock(InstanceIdentifier.class), ovsdbNode));
 308     }
 309 }