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