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