neutron-mapper/src/test/java/org/opendaylight/groupbasedpolicy/neutron/mapper/mapping/NeutronRouterAwareDataStoreTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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.groupbasedpolicy.neutron.mapper.mapping;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotEquals;
  13 import static org.junit.Assert.fail;
  14 import static org.mockito.Matchers.any;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.when;
  17
  18 import java.util.concurrent.ExecutionException;
  19 import java.util.concurrent.Future;
  20
  21 import com.google.common.base.Optional;
  22 import com.google.common.collect.ImmutableList;
  23 import org.junit.Before;
  24 import org.junit.Rule;
  25 import org.junit.Test;
  26 import org.junit.rules.ExpectedException;
  27 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  28 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  29 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  30 import org.opendaylight.groupbasedpolicy.neutron.mapper.EndpointRegistrator;
  31 import org.opendaylight.groupbasedpolicy.neutron.mapper.test.NeutronMapperDataBrokerTest;
  32 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.Utils;
  33 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
  34 import org.opendaylight.groupbasedpolicy.util.IidFactory;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.BaseEndpointService;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContextId;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L3ContextId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.EndpointService;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.L3Context;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.NetworksBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIpsBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.PortsBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.SubnetsBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetBuilder;
  62 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  63 import org.opendaylight.yangtools.yang.common.RpcResult;
  64
  65 public class NeutronRouterAwareDataStoreTest extends NeutronMapperDataBrokerTest {
  66
  67     private final Uuid tenantUuid = new Uuid("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa");
  68     private final Uuid routerUuid = new Uuid("bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb");
  69     private final Uuid newRouterUuid = new Uuid("bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbb2");
  70     private final Uuid subnetUuid = new Uuid("cccccccc-cccc-cccc-cccc-cccccccccccc");
  71     private final Uuid networkUuid = new Uuid("dddddddd-dddd-dddd-dddd-dddddddddddd");
  72     private final Uuid gatewayPortUuid = new Uuid("dddddddd-dddd-dddd-dddd-ddddddddddd1");
  73     private final IpAddress ipAddress = new IpAddress(new Ipv4Address("10.0.0.2"));
  74     private static final long METADATA_IPV4_SERVER_PORT = 80;
  75     private static final IpPrefix METADATA_IP_PREFIX = new IpPrefix(new Ipv4Prefix("169.254.169.254/32"));
  76
  77     private DataBroker dataBroker;
  78     private NeutronRouterAware routerAware;
  79     private EndpointRegistrator epRegistrator;
  80     private EndpointService epService;
  81     private BaseEndpointService baseEpService;
  82     private Neutron neutron;
  83     private Future<RpcResult<Void>> futureRpcResult;
  84     private Future<RpcResult<Void>> futureRpcFail;
  85     private RpcResult<Void> rpcResult;
  86     private RpcResult<Void> rpcFail;
  87     private NeutronNetworkAware networkAware;
  88     private Network network;
  89
  90     @Before
  91     public void init() throws ExecutionException, InterruptedException {
  92         futureRpcResult = mock(Future.class);
  93         futureRpcFail = mock(Future.class);
  94         rpcResult = mock(RpcResult.class);
  95         rpcFail = mock(RpcResult.class);
  96         when(rpcResult.isSuccessful()).thenReturn(true);
  97         when(rpcFail.isSuccessful()).thenReturn(false);
  98         dataBroker = getDataBroker();
  99         neutron = mock(Neutron.class);
 100         epService = mock(EndpointService.class);
 101         baseEpService = mock(BaseEndpointService.class);
 102         when(futureRpcResult.get()).thenReturn(rpcResult);
 103         when(futureRpcFail.get()).thenReturn(rpcFail);
 104         when(epService.registerEndpoint(
 105                 any(org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.RegisterEndpointInput.class)))
 106                     .thenReturn(futureRpcResult);
 107         when(epService.registerL3PrefixEndpoint(
 108                 any(org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.RegisterL3PrefixEndpointInput.class)))
 109                     .thenReturn(futureRpcResult);
 110         when(baseEpService.registerEndpoint(
 111                 any(org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.RegisterEndpointInput.class)))
 112                     .thenReturn(futureRpcResult);
 113         epRegistrator = new EndpointRegistrator(epService, baseEpService);
 114
 115         networkAware = new NeutronNetworkAware(dataBroker, METADATA_IPV4_SERVER_PORT);
 116         network = new NetworkBuilder().setTenantId(tenantUuid).setUuid(networkUuid).setName("networkName").build();
 117
 118         routerAware = new NeutronRouterAware(dataBroker, epRegistrator);
 119     }
 120
 121     @Rule
 122     public ExpectedException thrown = ExpectedException.none();
 123
 124     @Test
 125     public void testConstructor_invalidArgument() throws NullPointerException {
 126         thrown.expect(NullPointerException.class);
 127         new NeutronRouterAware(null, null);
 128     }
 129
 130     @Test
 131     public void testOnCreated() {
 132         Router router = new RouterBuilder().setTenantId(tenantUuid).setName("routerName").setUuid(routerUuid).build();
 133
 134         routerAware.onCreated(router, neutron);
 135
 136         assertRouterExists(router);
 137     }
 138
 139     @Test
 140     public void testOnCreated_incorrectName() {
 141         Router router = new RouterBuilder().setTenantId(tenantUuid).setName("123").setUuid(routerUuid).build();
 142
 143         routerAware.onCreated(router, neutron);
 144
 145         assertRouterExists(router);
 146     }
 147
 148     @Test
 149     public void testOnUpdated() {
 150         Subnets subnets = createSubnets();
 151         when(neutron.getSubnets()).thenReturn(subnets);
 152         when(neutron.getNetworks()).thenReturn(new NetworksBuilder().setNetwork(ImmutableList.of(network)).build());
 153
 154         FixedIps fixedIps = new FixedIpsBuilder().setIpAddress(ipAddress).setSubnetId(subnetUuid).build();
 155         Port port = new PortBuilder().setUuid(gatewayPortUuid).setFixedIps(ImmutableList.of(fixedIps)).build();
 156         Ports ports = new PortsBuilder().setPort(ImmutableList.of(port)).build();
 157         when(neutron.getPorts()).thenReturn(ports);
 158
 159         Router oldRouter =
 160                 new RouterBuilder().setTenantId(tenantUuid).setName("oldRouterName").setUuid(routerUuid).build();
 161         Router newRouter = new RouterBuilder().setTenantId(tenantUuid)
 162             .setName("newRouterName")
 163             .setUuid(newRouterUuid)
 164             .setGatewayPortId(gatewayPortUuid)
 165             .build();
 166
 167         networkAware.onCreated(network, neutron);
 168
 169         assertRouterNotExists(oldRouter);
 170
 171         routerAware.onCreated(oldRouter, neutron);
 172
 173         assertRouterExists(oldRouter);
 174         assertRouterNotExists(newRouter);
 175
 176         routerAware.onUpdated(oldRouter, newRouter, neutron, neutron);
 177
 178         assertRouterExists(oldRouter);
 179         assertRouterExists(newRouter);
 180     }
 181
 182     @Test
 183     public void testOnUpdated_GatewayPortNotFound() {
 184         Subnets subnets = createSubnets();
 185         when(neutron.getSubnets()).thenReturn(subnets);
 186
 187         FixedIps fixedIps = new FixedIpsBuilder().setIpAddress(ipAddress).setSubnetId(subnetUuid).build();
 188         Port port = new PortBuilder().setUuid(new Uuid("dddddddd-dddd-dddd-dddd-000000000000"))
 189             .setFixedIps(ImmutableList.of(fixedIps))
 190             .build();
 191         Ports ports = new PortsBuilder().setPort(ImmutableList.of(port)).build();
 192         when(neutron.getPorts()).thenReturn(ports);
 193
 194         Router oldRouter =
 195                 new RouterBuilder().setTenantId(tenantUuid).setName("oldRouterName").setUuid(routerUuid).build();
 196         Router newRouter = new RouterBuilder().setTenantId(tenantUuid)
 197             .setName("newRouterName")
 198             .setUuid(newRouterUuid)
 199             .setGatewayPortId(gatewayPortUuid)
 200             .build();
 201
 202         routerAware.onCreated(oldRouter, neutron);
 203         routerAware.onUpdated(oldRouter, newRouter, neutron, neutron);
 204
 205         assertRouterNotExists(newRouter);
 206     }
 207
 208     @Test
 209     public void testOnUpdated_noIps() {
 210         Subnets subnets = createSubnets();
 211         when(neutron.getSubnets()).thenReturn(subnets);
 212
 213         Port port = new PortBuilder().setUuid(gatewayPortUuid).build();
 214         Ports ports = new PortsBuilder().setPort(ImmutableList.of(port)).build();
 215         when(neutron.getPorts()).thenReturn(ports);
 216
 217         Router oldRouter =
 218                 new RouterBuilder().setTenantId(tenantUuid).setName("oldRouterName").setUuid(routerUuid).build();
 219         Router newRouter = new RouterBuilder().setTenantId(tenantUuid)
 220             .setName("newRouterName")
 221             .setUuid(newRouterUuid)
 222             .setGatewayPortId(gatewayPortUuid)
 223             .build();
 224
 225         routerAware.onCreated(oldRouter, neutron);
 226         routerAware.onUpdated(oldRouter, newRouter, neutron, neutron);
 227
 228         assertRouterNotExists(newRouter);
 229     }
 230
 231     @Test
 232     public void testOnUpdated_noSubnet() {
 233         Subnets subnets = createSubnets();
 234         when(neutron.getSubnets()).thenReturn(subnets);
 235
 236         FixedIps fixedIps = new FixedIpsBuilder().setIpAddress(ipAddress).build();
 237         Port port = new PortBuilder().setUuid(gatewayPortUuid).setFixedIps(ImmutableList.of(fixedIps)).build();
 238         Ports ports = new PortsBuilder().setPort(ImmutableList.of(port)).build();
 239         when(neutron.getPorts()).thenReturn(ports);
 240
 241         Router oldRouter =
 242                 new RouterBuilder().setTenantId(tenantUuid).setName("oldRouterName").setUuid(routerUuid).build();
 243         Router newRouter = new RouterBuilder().setTenantId(tenantUuid)
 244             .setName("newRouterName")
 245             .setUuid(newRouterUuid)
 246             .setGatewayPortId(gatewayPortUuid)
 247             .build();
 248
 249         routerAware.onCreated(oldRouter, neutron);
 250         routerAware.onUpdated(oldRouter, newRouter, neutron, neutron);
 251
 252         assertRouterNotExists(newRouter);
 253     }
 254
 255     @Test
 256     public void testOnUpdated_ExtGatewayNotRegistered() {
 257         when(baseEpService.registerEndpoint(
 258                 any(org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.RegisterEndpointInput.class)))
 259                     .thenReturn(futureRpcFail);
 260
 261         Subnets subnets = createSubnets();
 262         when(neutron.getSubnets()).thenReturn(subnets);
 263
 264         FixedIps fixedIps = new FixedIpsBuilder().setIpAddress(ipAddress).setSubnetId(subnetUuid).build();
 265         Port port = new PortBuilder().setUuid(gatewayPortUuid).setFixedIps(ImmutableList.of(fixedIps)).build();
 266         Ports ports = new PortsBuilder().setPort(ImmutableList.of(port)).build();
 267         when(neutron.getPorts()).thenReturn(ports);
 268
 269         Router oldRouter =
 270                 new RouterBuilder().setTenantId(tenantUuid).setName("oldRouterName").setUuid(routerUuid).build();
 271         Router newRouter = new RouterBuilder().setTenantId(tenantUuid)
 272             .setName("newRouterName")
 273             .setUuid(newRouterUuid)
 274             .setGatewayPortId(gatewayPortUuid)
 275             .build();
 276
 277         routerAware.onCreated(oldRouter, neutron);
 278         routerAware.onUpdated(oldRouter, newRouter, neutron, neutron);
 279
 280         assertRouterNotExists(newRouter);
 281     }
 282
 283     @Test
 284     public void testOnUpdated_noL2BridgeDomain() {
 285         Subnets subnets = createSubnets();
 286         when(neutron.getSubnets()).thenReturn(subnets);
 287         when(neutron.getNetworks()).thenReturn(new NetworksBuilder().setNetwork(ImmutableList.of(network)).build());
 288
 289         FixedIps fixedIps = new FixedIpsBuilder().setIpAddress(ipAddress).setSubnetId(subnetUuid).build();
 290         Port port = new PortBuilder().setUuid(gatewayPortUuid).setFixedIps(ImmutableList.of(fixedIps)).build();
 291         Ports ports = new PortsBuilder().setPort(ImmutableList.of(port)).build();
 292         when(neutron.getPorts()).thenReturn(ports);
 293
 294         Router oldRouter =
 295                 new RouterBuilder().setTenantId(tenantUuid).setName("oldRouterName").setUuid(routerUuid).build();
 296         Router newRouter = new RouterBuilder().setTenantId(tenantUuid)
 297             .setName("newRouterName")
 298             .setUuid(newRouterUuid)
 299             .setGatewayPortId(gatewayPortUuid)
 300             .build();
 301
 302         routerAware.onCreated(oldRouter, neutron);
 303         routerAware.onUpdated(oldRouter, newRouter, neutron, neutron);
 304
 305         assertRouterNotExists(newRouter);
 306     }
 307
 308     @Test
 309     public void testOnDeleted() {
 310         Router router =
 311                 new RouterBuilder().setTenantId(tenantUuid).setName("oldRouterName").setUuid(routerUuid).build();
 312
 313         routerAware.onCreated(router, neutron);
 314         routerAware.onDeleted(router, neutron, neutron);
 315         // no op
 316     }
 317
 318     private Subnets createSubnets() {
 319         Subnet subnet = new SubnetBuilder().setTenantId(tenantUuid)
 320             .setUuid(subnetUuid)
 321             .setName("subnetName")
 322             .setNetworkId(networkUuid)
 323             .setGatewayIp(ipAddress)
 324             .setCidr(Utils.createIpPrefix("10.0.0.0/24"))
 325             .build();
 326         return new SubnetsBuilder().setSubnet(ImmutableList.of(subnet)).build();
 327     }
 328
 329     private void assertRouterExists(Router router) {
 330         Optional<L3Context> opt = getL3ContextOptional(router);
 331         if (opt.isPresent()) {
 332             assertEquals(router.getUuid().getValue(), opt.get().getId().getValue());
 333         } else {
 334             fail("no router in DS, Uuid:" + router.getUuid());
 335         }
 336     }
 337
 338     private void assertRouterNotExists(Router router) {
 339         Optional<L3Context> opt = getL3ContextOptional(router);
 340         if (opt.isPresent()) {
 341             assertNotEquals(router.getUuid().getValue(), opt.get().getId().getValue());
 342         }
 343     }
 344
 345     private Optional<L3Context> getL3ContextOptional(Router router) {
 346         ReadOnlyTransaction rTx = dataBroker.newReadOnlyTransaction();
 347         TenantId tenantId = new TenantId(router.getTenantId().getValue());
 348         ContextId routerL3CtxId = new ContextId(router.getUuid().getValue());
 349         L3ContextId l3ContextId = new L3ContextId(routerL3CtxId);
 350         InstanceIdentifier<L3Context> l3ContextIid = IidFactory.l3ContextIid(tenantId, l3ContextId);
 351         return DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION, l3ContextIid, rTx);
 352     }
 353
 354 }