openstack/net-virt-providers/src/test/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/OF13ProviderTest.java

   1 /*
   2  * Copyright (c) 2015 Inocybe Technologies.  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.openstack.netvirt.providers.openflow13;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.Matchers.any;
  15 import static org.mockito.Matchers.anyString;
  16 import static org.mockito.Matchers.same;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.times;
  19 import static org.mockito.Mockito.verify;
  20 import static org.mockito.Mockito.when;
  21
  22 import java.lang.reflect.Field;
  23 import java.net.InetAddress;
  24 import java.util.ArrayList;
  25 import java.util.Arrays;
  26 import java.util.HashMap;
  27 import java.util.HashSet;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Random;
  31 import java.util.Set;
  32 import java.util.concurrent.BlockingQueue;
  33 import java.util.concurrent.ConcurrentHashMap;
  34 import java.util.concurrent.ConcurrentMap;
  35
  36 import org.junit.Before;
  37 import org.junit.Ignore;
  38 import org.junit.Test;
  39 import org.junit.runner.RunWith;
  40 import org.mockito.InjectMocks;
  41 import org.mockito.Mock;
  42 import org.mockito.Mockito;
  43 import org.mockito.runners.MockitoJUnitRunner;
  44 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  45 import org.opendaylight.neutron.spi.INeutronNetworkCRUD;
  46 import org.opendaylight.neutron.spi.INeutronPortCRUD;
  47 import org.opendaylight.neutron.spi.INeutronSubnetCRUD;
  48 import org.opendaylight.neutron.spi.NeutronLoadBalancerPool;
  49 import org.opendaylight.neutron.spi.NeutronNetwork;
  50 import org.opendaylight.ovsdb.lib.notation.Column;
  51 import org.opendaylight.ovsdb.lib.notation.Row;
  52 import org.opendaylight.ovsdb.lib.notation.UUID;
  53 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
  54 import org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent;
  55 import org.opendaylight.ovsdb.openstack.netvirt.AbstractHandler;
  56 import org.opendaylight.ovsdb.openstack.netvirt.LBaaSHandler;
  57 import org.opendaylight.ovsdb.openstack.netvirt.LBaaSPoolHandler;
  58 import org.opendaylight.ovsdb.openstack.netvirt.NetworkHandler;
  59 import org.opendaylight.ovsdb.openstack.netvirt.NeutronCacheUtils;
  60 import org.opendaylight.ovsdb.openstack.netvirt.api.*;
  61 import org.opendaylight.ovsdb.openstack.netvirt.impl.EventDispatcherImpl;
  62 //import org.opendaylight.ovsdb.plugin.api.OvsdbConfigurationService;
  63 //import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;
  64 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
  65 import org.opendaylight.ovsdb.schema.openvswitch.Interface;
  66 import org.opendaylight.ovsdb.schema.openvswitch.Port;
  67 import org.opendaylight.ovsdb.utils.mdsal.node.StringConvertor;
  68 //import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  70 //import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  73 //import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  74 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  75 import org.osgi.framework.ServiceReference;
  76 import org.powermock.api.mockito.PowerMockito;
  77 import org.powermock.core.classloader.annotations.PrepareForTest;
  78 import org.powermock.modules.junit4.PowerMockRunner;
  79
  80 /**
  81  * Unit test for {@link OF13Provider}
  82  */
  83 /* TODO SB_MIGRATION */
  84 @Ignore
  85 @PrepareForTest(OF13Provider.class)
  86 @RunWith(PowerMockRunner.class)
  87 public class OF13ProviderTest {
  88
  89     @InjectMocks private OF13Provider of13Provider;
  90     @Mock private NeutronNetwork network;
  91     @Mock private org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node openflowNode;
  92     @Mock private Node node;
  93     @Mock private Node node2;
  94     @Mock private Node node3;
  95     @Mock private Interface intf;
  96
  97     @Mock private ConfigurationService configurationService;
  98     @Mock private BridgeConfigurationManager bridgeConfigurationManager;
  99     @Mock private TenantNetworkManager tenantNetworkManager;
 100     /* TODO SB_MIGRATION */
 101     //@Mock private OvsdbConfigurationService ovsdbConfigurationService;
 102     //@Mock private OvsdbConnectionService connectionService;
 103     @Mock private MdsalConsumer mdsalConsumer;
 104     @Mock private SecurityServicesManager securityServicesManager;
 105     @Mock private IngressAclProvider ingressAclProvider;
 106     @Mock private EgressAclProvider egressAclProvider;
 107     @Mock private ClassifierProvider classifierProvider;
 108     @Mock private L2ForwardingProvider l2ForwardingProvider;
 109     @Mock private DataBroker dataBroker;
 110
 111
 112     @Before
 113     public void setUp() throws Exception{
 114         of13Provider = new OF13Provider();
 115
 116         //Setup mock dependency services.
 117         configurationService = Mockito.mock(ConfigurationService.class);
 118         bridgeConfigurationManager = Mockito.mock(BridgeConfigurationManager.class);
 119         tenantNetworkManager = Mockito.mock(TenantNetworkManager.class);
 120         /* TODO SB_MIGRATION */
 121         //ovsdbConfigurationService = Mockito.mock(OvsdbConfigurationService.class);
 122         //connectionService = Mockito.mock(OvsdbConnectionService.class);
 123         mdsalConsumer = Mockito.mock(MdsalConsumer.class);
 124         securityServicesManager = Mockito.mock(SecurityServicesManager.class);
 125         ingressAclProvider = Mockito.mock(IngressAclProvider.class);
 126         egressAclProvider = Mockito.mock(EgressAclProvider.class);
 127         classifierProvider = Mockito.mock(ClassifierProvider.class);
 128         l2ForwardingProvider = Mockito.mock(L2ForwardingProvider.class);
 129         dataBroker = Mockito.mock(DataBroker.class);
 130
 131         this.SeedMockDependencies();
 132
 133         List<Node> nodeList = new ArrayList();
 134         NodeId nodeId = new NodeId("Node1");
 135         NodeKey nodeKey = new NodeKey(nodeId);
 136
 137         node = Mockito.mock(Node.class);
 138         when(node.getNodeId()).thenReturn(nodeId);
 139         when(node.getKey()).thenReturn(new NodeKey(nodeId));
 140         when(configurationService.getTunnelEndPoint(node)).thenReturn(InetAddress.getByName("192.168.0.1"));
 141         nodeList.add(node);
 142
 143         nodeId = new NodeId("Node2");
 144         node2 = Mockito.mock(Node.class);
 145         when(node2.getNodeId()).thenReturn(nodeId);
 146         when(node2.getKey()).thenReturn(new NodeKey(nodeId));
 147         when(configurationService.getTunnelEndPoint(node2)).thenReturn(InetAddress.getByName("192.168.0.2"));
 148         nodeList.add(node2);
 149
 150         nodeId = new NodeId("Node3");
 151         node3 = Mockito.mock(Node.class);
 152         when(node3.getNodeId()).thenReturn(nodeId);
 153         when(node3.getKey()).thenReturn(new NodeKey(nodeId));
 154         when(configurationService.getTunnelEndPoint(node3)).thenReturn(InetAddress.getByName("192.168.0.3"));
 155         nodeList.add(node3);
 156
 157         /* TODO SB_MIGRATION */
 158         //when(connectionService.getNodes()).thenReturn(nodeList);
 159
 160         final String key = "key";
 161         ConcurrentHashMap<String, Row> bridgeTable = new ConcurrentHashMap();
 162         bridgeTable.put(key, new Row());
 163
 164         Row bridgeRow = Mockito.mock(Row.class);
 165         Bridge bridge = Mockito.mock(Bridge.class);
 166
 167
 168         Set<String> paths = new HashSet<String>(Arrays.asList(new String[] { "100"}));
 169         Column<GenericTableSchema, Set<String>> dataPathIdColumns = Mockito.mock(Column.class);
 170
 171         when(dataPathIdColumns.getData()).thenReturn(paths);
 172         when(bridge.getDatapathIdColumn()).thenReturn(dataPathIdColumns);
 173
 174         /* TODO SB_MIGRATION */
 175         when(configurationService.getIntegrationBridgeName()).thenReturn(key);
 176         //when(ovsdbConfigurationService.getTableName(node, Bridge.class)).thenReturn(key);
 177         //when(ovsdbConfigurationService.getRows(node, key)).thenReturn(bridgeTable);
 178         //when(ovsdbConfigurationService.getRow(node, ovsdbConfigurationService.getTableName(node, Bridge.class), key)).thenReturn(bridgeRow);
 179         //when(ovsdbConfigurationService.getTypedRow(node, Bridge.class, bridgeRow)).thenReturn(bridge);
 180
 181         Bridge bridge1 = Mockito.mock(Bridge.class);
 182         when(bridge1.getName()).thenReturn(key);
 183         //when(ovsdbConfigurationService.getTypedRow(node, Bridge.class, bridgeTable.get(key))).thenReturn(bridge1);
 184
 185         Port port = mock(Port.class);
 186         Column<GenericTableSchema, Set<UUID>> itfaceColumns = mock(Column.class);
 187         when(port.getInterfacesColumn()).thenReturn(itfaceColumns);
 188         Set<UUID> ifaceUUIDs = new HashSet();
 189         ifaceUUIDs.add(mock(UUID.class));
 190         when(itfaceColumns.getData()).thenReturn(ifaceUUIDs );
 191         //when(ovsdbConfigurationService.getTypedRow(any(Node.class), same(Port.class), any(Row.class))).thenReturn(port);
 192
 193         intf = mock(Interface.class);
 194
 195         Set<Long> ports = new HashSet<Long>(Arrays.asList(new Long[] { 21L, 23L ,80L}));
 196         Column<GenericTableSchema, Set<Long>> openFlowPortColumns = Mockito.mock(Column.class);
 197         when(openFlowPortColumns.getData()).thenReturn(ports);
 198
 199         when(intf.getName()).thenReturn("intf1");
 200         when(intf.getOpenFlowPortColumn()).thenReturn(openFlowPortColumns);
 201
 202         Column<GenericTableSchema, Map<String, String>> externalIdColumns = mock(Column.class);
 203         Map<String, String> externalIds = new HashMap();
 204         externalIds.put(Constants.EXTERNAL_ID_INTERFACE_ID, "portUUID");
 205         externalIds.put(Constants.EXTERNAL_ID_VM_MAC, "extMac");
 206         when(externalIdColumns.getData()).thenReturn(externalIds);
 207
 208         when(intf.getExternalIdsColumn()).thenReturn(externalIdColumns);
 209         //when(ovsdbConfigurationService.getTypedRow(any(Node.class), same(Interface.class), any(Row.class))).thenReturn(intf);
 210
 211     }
 212
 213
 214     /**
 215      * Tests for defaults
 216      *      getName()
 217      *      supportsServices()
 218      *      hasPerTenantTunneling()
 219      */
 220     @Test
 221     public void verifyObjectDefaultSettings(){
 222         assertEquals("Error, getName() - Default provider name is invalid","OF13Provider",of13Provider.getName());
 223         assertEquals("Error, supportsServices() - Support services is disabled", true, of13Provider.supportsServices());
 224         assertEquals("Error, hasPerTenantTunneling() - Support for per tenant tunnelling is enabled", false, of13Provider.hasPerTenantTunneling());
 225     }
 226
 227     /**
 228      * Test method
 229      * {@link OF13Provider#notifyFlowCapableNodeEventTest(Long, Action)}
 230      */
 231     @Test
 232     public void notifyFlowCapableNodeEventTest(){
 233
 234         long flowId = 100;
 235         Action action = Action.ADD;
 236
 237         of13Provider.notifyFlowCapableNodeEvent(flowId, action);
 238         verify(mdsalConsumer, times(1)).notifyFlowCapableNodeCreateEvent(Constants.OPENFLOW_NODE_PREFIX + flowId, action);
 239     }
 240
 241     /**
 242      * Test method
 243      * {@link OF13Provider#initializeFlowRules(Node)}
 244      */
 245     @Test
 246     public void initializeFlowRulesTest(){
 247
 248         Row row = Mockito.mock(Row.class);
 249         //when(ovsdbConfigurationService.getTypedRow(node, Interface.class, row)).thenReturn(intf);
 250
 251         ConcurrentHashMap<String, Row> intfs = new ConcurrentHashMap();
 252         intfs.put("intf1", row);
 253
 254         NeutronNetwork network = Mockito.mock(NeutronNetwork.class);
 255         when(network.getProviderNetworkType()).thenReturn(NetworkHandler.NETWORK_TYPE_VLAN);
 256         when(tenantNetworkManager.getTenantNetwork(intf)).thenReturn(network);
 257         //when(ovsdbConfigurationService.getRows(node, ovsdbConfigurationService.getTableName(node, Interface.class))).thenReturn(intfs);
 258
 259         of13Provider.initializeFlowRules(node);
 260
 261         /**
 262          * The final phase of the initialization process is to call triggerInterfaceUpdates(node)
 263          * This must call tenantNetworkManager.getTenantNetwork(Interface) for each interface.
 264          * Verify that this is called once since we are initializing flow rules for only one interface.
 265          */
 266         /* TODO SB_MIGRATION */
 267         //verify(tenantNetworkManager, times(1)).getTenantNetwork(intf);
 268     }
 269
 270     /**
 271      * Test method
 272      * {@link OF13Provider#initializeOFFlowRulesTest(Node)}
 273      */
 274     @Test
 275     public void initializeOFFlowRulesTest(){
 276         /* TODO SB_MIGRATION */
 277         //of13Provider.initializeOFFlowRules(openflowNode);
 278         //verify(connectionService, times(1)).getNodes();
 279     }
 280
 281     /**
 282      * Test method
 283      * {@link OF13Provider#handleInterfaceUpdateTest(NeutronNetwork, Node, Interface)}
 284      */
 285     @Test
 286     public void handleInterfaceUpdateTest(){
 287         NeutronNetwork network = Mockito.mock(NeutronNetwork.class);
 288
 289         /**
 290          * For Vlan network type, test ensures that all parameter validations
 291          * passed by ensuring that ovsdbConfigurationService.getRows(node,"interface_table_name))
 292          * is called at least once.
 293          */
 294
 295         when(network.getProviderNetworkType()).thenReturn(NetworkHandler.NETWORK_TYPE_VLAN);
 296         /* TODO SB_MIGRATION */
 297         //this.of13Provider.handleInterfaceUpdate(network, node, intf);
 298         //verify(ovsdbConfigurationService, times(1)).getRows(node, ovsdbConfigurationService.getTableName(node, Interface.class));
 299
 300         /**
 301          * Ideally we want to verify that the right rule tables are constructed for
 302          * each type of network (vlan, gre, vxlan). However, to simplify things, we just
 303          * verify that configurationService.getTunnelEndPoint() is called twice for the appropriate
 304          * network types and for each of the two remaining nodes.
 305          */
 306
 307         when(network.getProviderNetworkType()).thenReturn(NetworkHandler.NETWORK_TYPE_GRE);
 308         /* TODO SB_MIGRATION */
 309         //this.of13Provider.handleInterfaceUpdate(network, node, intf);this.of13Provider.handleInterfaceUpdate(network, node, intf);
 310         /* TODO SB_MIGRATION */
 311         //verify(configurationService, times(4)).getTunnelEndPoint(node);
 312
 313         when(network.getProviderNetworkType()).thenReturn(NetworkHandler.NETWORK_TYPE_VXLAN);
 314         /* TODO SB_MIGRATION */
 315         //this.of13Provider.handleInterfaceUpdate(network, node, intf);this.of13Provider.handleInterfaceUpdate(network, node, intf);
 316         //verify(configurationService, times(8)).getTunnelEndPoint(node);
 317
 318         assertEquals("Error, handleInterfaceUpdate(String, String) - is returning a non NULL value.", null, this.of13Provider.handleInterfaceUpdate("",""));
 319     }
 320
 321     /**
 322      * Test method
 323      * {@link OF13Provider#handleInterfaceDelete(String, NeutronNetwork, Node, Interface, boolean)}
 324      */
 325     @Test
 326     public void handleInterfaceDeleteTest(){
 327         NeutronNetwork network = Mockito.mock(NeutronNetwork.class);
 328
 329
 330         when(network.getProviderNetworkType()).thenReturn(NetworkHandler.NETWORK_TYPE_VLAN);
 331         when(bridgeConfigurationManager.getAllPhysicalInterfaceNames(node)).thenReturn(Arrays.asList(new String[] { "eth0", "eth1" ,"eth2"}));
 332
 333         Column<GenericTableSchema, String> typeColumn = Mockito.mock(Column.class);
 334         when(typeColumn.getData()).thenReturn(NetworkHandler.NETWORK_TYPE_VXLAN);
 335         when(intf.getTypeColumn()).thenReturn(typeColumn);
 336
 337         Map<String, String> options = new HashMap();
 338         options.put("local_ip", "192.168.0.1");
 339         options.put("remote_ip", "10.0.12.0");
 340
 341         Column<GenericTableSchema, Map<String, String>> optionColumns = Mockito.mock(Column.class);
 342         when(intf.getOptionsColumn()).thenReturn(optionColumns);
 343
 344         /* TODO SB_MIGRATION */
 345         Status status = null;//this.of13Provider.handleInterfaceDelete("tunnel1", network, node, intf, true);
 346
 347         assertEquals("Error, handleInterfaceDelete(String, NeutronNetwor, Node, Interface, boolean) - returned the wrong status.", new Status(StatusCode.SUCCESS), status);
 348     }
 349
 350
 351     /**
 352      * Test method
 353      * {@link OF13Provider#createNodeBuilderTest(String)}
 354      */
 355     @Test
 356     public void createNodeBuilderTest(){
 357         final String nodeId="node1";
 358
 359         NodeBuilder builder = new NodeBuilder();
 360         builder.setId(new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId(nodeId));
 361         builder.setKey(new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey(builder.getId()));
 362
 363         NodeBuilder builderStatic = OF13Provider.createNodeBuilder(nodeId);
 364
 365         assertEquals("Error, createNodeBuilder() returned an invalid Node Builder Id", builderStatic.getId(), builder.getId());
 366         assertEquals("Error, createNodeBuilder() returned an invalid Node Builder key", builderStatic.getKey(), builder.getKey());
 367     }
 368
 369     /**
 370      * Seeds mock dependencies into the of13Provider object
 371      * @throws Exception
 372      */
 373     private void SeedMockDependencies() throws Exception{
 374
 375         SeedClassFieldValue(of13Provider, "configurationService", configurationService);
 376         SeedClassFieldValue(of13Provider, "bridgeConfigurationManager", bridgeConfigurationManager);
 377         SeedClassFieldValue(of13Provider, "tenantNetworkManager", tenantNetworkManager);
 378         /* TODO SB_MIGRATION */
 379         //SeedClassFieldValue(of13Provider, "ovsdbConfigurationService", ovsdbConfigurationService);
 380         //SeedClassFieldValue(of13Provider, "connectionService", connectionService);
 381         SeedClassFieldValue(of13Provider, "mdsalConsumer", mdsalConsumer);
 382         SeedClassFieldValue(of13Provider, "securityServicesManager", securityServicesManager);
 383         SeedClassFieldValue(of13Provider, "ingressAclProvider", ingressAclProvider);
 384         SeedClassFieldValue(of13Provider, "egressAclProvider", egressAclProvider);
 385         SeedClassFieldValue(of13Provider, "classifierProvider", classifierProvider);
 386         SeedClassFieldValue(of13Provider, "l2ForwardingProvider", l2ForwardingProvider);
 387         SeedClassFieldValue(of13Provider, "dataBroker", dataBroker);
 388     }
 389
 390     /**
 391      * Get the specified field from OF13Provider using reflection
 392      * @param instance - the class instance
 393      * @param fieldName - the field to retrieve
 394      *
 395      * @return the desired field
 396      */
 397     private Object getClassField(OF13Provider instance, String fieldName) throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException{
 398         Field field = OF13Provider.class.getDeclaredField(fieldName);
 399         field.setAccessible(true);
 400         return field.get(instance);
 401     }
 402
 403     /**
 404      * Sets the internal value of a field from OF13Provider using reflection
 405      * @param instance
 406      * @param fieldName
 407      * @param value
 408      * @throws NoSuchFieldException
 409      * @throws SecurityException
 410      * @throws IllegalArgumentException
 411      * @throws IllegalAccessException
 412      */
 413     private void SeedClassFieldValue(OF13Provider instance, String fieldName, Object value)throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException{
 414
 415         Field field = OF13Provider.class.getDeclaredField(fieldName);
 416         field.setAccessible(true);
 417         field.set(instance, value);
 418     }
 419 }