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