Merge "Unit tests for NeutronSubnetAware"
[groupbasedpolicy.git] / neutron-mapper / src / main / java / org / opendaylight / groupbasedpolicy / neutron / mapper / mapping / NeutronSubnetAware.java
index 208f0a2f69b7ab97d7b7fc90cefa4a3dc3d9d73c..43d21d56751bf043670f2b9f2a08f5cf8e78876e 100644 (file)
@@ -12,107 +12,195 @@ import static com.google.common.base.Preconditions.checkNotNull;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.groupbasedpolicy.neutron.mapper.util.DataStoreHelper;
-import org.opendaylight.groupbasedpolicy.neutron.mapper.util.IidFactory;
-import org.opendaylight.groupbasedpolicy.neutron.mapper.util.Utils;
-import org.opendaylight.neutron.spi.INeutronSubnetAware;
-import org.opendaylight.neutron.spi.NeutronSubnet;
+import org.opendaylight.groupbasedpolicy.domain_extension.l2_l3.util.L2L3IidFactory;
+import org.opendaylight.groupbasedpolicy.neutron.mapper.EndpointRegistrator;
+import org.opendaylight.groupbasedpolicy.neutron.mapper.util.MappingUtils;
+import org.opendaylight.groupbasedpolicy.neutron.mapper.util.NetworkUtils;
+import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
+import org.opendaylight.groupbasedpolicy.util.IidFactory;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContextId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L3ContextId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Name;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.NetworkDomainId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubnetId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.Subnet;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.SubnetBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.L2FloodDomain;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.SubnetAugmentForwarding;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.SubnetAugmentForwardingBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.has.subnet.SubnetBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.forwarding.by.tenant.NetworkDomain;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.forwarding.by.tenant.NetworkDomainBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.Subnet;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.google.common.base.Optional;
 import com.google.common.base.Strings;
 
-public class NeutronSubnetAware implements INeutronSubnetAware {
+public class NeutronSubnetAware implements
+        NeutronAware<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet> {
 
     private final static Logger LOG = LoggerFactory.getLogger(NeutronSubnetAware.class);
+    public static final InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet> SUBNET_WILDCARD_IID =
+            InstanceIdentifier.builder(Neutron.class)
+                .child(Subnets.class)
+                .child(org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet.class)
+                .build();
     private final DataBroker dataProvider;
+    private final EndpointRegistrator epRegistrator;
 
-    public NeutronSubnetAware(DataBroker dataProvider) {
+    public NeutronSubnetAware(DataBroker dataProvider, EndpointRegistrator epRegistrator) {
         this.dataProvider = checkNotNull(dataProvider);
+        this.epRegistrator = checkNotNull(epRegistrator);
     }
 
-    /**
-     * @see org.opendaylight.neutron.spi.INeutronSubnetAware#canCreateSubnet(org.opendaylight.neutron.spi.NeutronSubnet)
-     */
     @Override
-    public int canCreateSubnet(NeutronSubnet subnet) {
-        LOG.trace("canCreateSubnet - {}", subnet);
-        // nothing to consider
-        return StatusCode.OK;
-    }
-
-    /**
-     * @see org.opendaylight.neutron.spi.INeutronSubnetAware#neutronSubnetCreated(org.opendaylight.neutron.spi.NeutronSubnet)
-     */
-    @Override
-    public void neutronSubnetCreated(NeutronSubnet neutronSubnet) {
-        LOG.trace("neutronSubnetCreated - {}", neutronSubnet);
+    public void onCreated(
+            org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet,
+            Neutron neutron) {
+        LOG.trace("created subnet - {}", neutronSubnet);
         ReadWriteTransaction rwTx = dataProvider.newReadWriteTransaction();
-        SubnetId subnetId = new SubnetId(Utils.normalizeUuid(neutronSubnet.getID()));
-        TenantId tenantId = new TenantId(Utils.normalizeUuid(neutronSubnet.getTenantID()));
-        Subnet subnet = createSubnet(neutronSubnet);
-        rwTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.subnetIid(tenantId, subnetId), subnet, true);
+        TenantId tenantId = new TenantId(neutronSubnet.getTenantId().getValue());
+
+        Optional<Network> potentialNetwork =
+                NetworkUtils.findNetwork(neutronSubnet.getNetworkId(), neutron.getNetworks());
+        if (!potentialNetwork.isPresent()) {
+            LOG.warn("Illegal state - network {} does not exist for subnet {}.",
+                    neutronSubnet.getNetworkId().getValue(), neutronSubnet);
+            rwTx.cancel();
+            return;
+        }
 
+        Network networkOfSubnet = potentialNetwork.get();
+
+        NetworkDomain subnetDomain = null;
+        if (NetworkUtils.isProviderPhysicalNetwork(networkOfSubnet)) {
+            // add virtual router IP only in case it is provider physical network
+            subnetDomain = createSubnet(neutronSubnet, neutronSubnet.getGatewayIp());
+            IpAddress gatewayIp = neutronSubnet.getGatewayIp();
+            boolean registeredDefaultRoute = epRegistrator.registerExternalL3PrefixEndpoint(MappingUtils.DEFAULT_ROUTE,
+                    new L3ContextId(neutronSubnet.getNetworkId().getValue()), gatewayIp, tenantId);
+            if (!registeredDefaultRoute) {
+                LOG.warn("Could not add EndpointL3Prefix as default route. Subnet within provider physical network {}",
+                        neutronSubnet);
+                rwTx.cancel();
+                return;
+            }
+        } else {
+            // virtual router IP is not set and it will be set when router gateway port is set
+            // or when a router port is attached to a network
+            subnetDomain = createSubnet(neutronSubnet, null);
+        }
+        processTenantSubnet(neutronSubnet, networkOfSubnet, tenantId, rwTx);
+        rwTx.put(LogicalDatastoreType.CONFIGURATION, L2L3IidFactory.subnetIid(tenantId, subnetDomain.getNetworkDomainId()), subnetDomain, true);
         DataStoreHelper.submitToDs(rwTx);
     }
 
-    private Subnet createSubnet(NeutronSubnet neutronSubnet) {
-        SubnetBuilder subnetBuilder = new SubnetBuilder();
-        subnetBuilder.setId(new SubnetId(neutronSubnet.getID()));
-        subnetBuilder.setParent(new ContextId(neutronSubnet.getNetworkUUID()));
-        if (!Strings.isNullOrEmpty(neutronSubnet.getName())) {
-            subnetBuilder.setName(new Name(neutronSubnet.getName()));
+    public static NetworkDomain createSubnet(
+            org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet subnet,
+            IpAddress virtualRouterIp) {
+        SubnetBuilder sb = new SubnetBuilder();
+        sb.setIpPrefix(subnet.getCidr());
+        sb.setVirtualRouterIp(virtualRouterIp);
+        NetworkDomainBuilder ndb = new NetworkDomainBuilder();
+        if (!Strings.isNullOrEmpty(subnet.getName())) {
+            try {
+                ndb.setName(new Name(subnet.getName()));
+            } catch (Exception e) {
+                LOG.info("Name '{}' of Neutron Subnet '{}' is ignored.", subnet.getName(), subnet.getUuid().getValue());
+                LOG.debug("Name exception", e);
+            }
         }
-        subnetBuilder.setIpPrefix(Utils.createIpPrefix(neutronSubnet.getCidr()));
-        return subnetBuilder.build();
+        ndb.setNetworkDomainId(new NetworkDomainId(subnet.getUuid().getValue()));
+        ndb.setNetworkDomainType(MappingUtils.SUBNET);
+        ndb.setParent(MappingUtils.createParent(new NetworkDomainId(subnet.getNetworkId().getValue()), L2FloodDomain.class));
+        ndb.addAugmentation(SubnetAugmentForwarding.class, new SubnetAugmentForwardingBuilder().setSubnet(sb.build())
+            .build());
+        return ndb.build();
     }
 
-    /**
-     * @see org.opendaylight.neutron.spi.INeutronSubnetAware#canUpdateSubnet(org.opendaylight.neutron.spi.NeutronSubnet,
-     *      org.opendaylight.neutron.spi.NeutronSubnet)
-     */
-    @Override
-    public int canUpdateSubnet(NeutronSubnet delta, NeutronSubnet original) {
-        LOG.trace("canUpdateSubnet - delta: {} original: {}", delta, original);
-        // nothing to consider
-        return StatusCode.OK;
+    @Deprecated
+    private void processTenantSubnet(org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet, Network networkOfSubnet, TenantId tenantId, ReadWriteTransaction rwTx) {
+        Subnet subnet;
+        if (NetworkUtils.isProviderPhysicalNetwork(networkOfSubnet)) {
+            // add virtual router IP only in case it is provider physical network
+            subnet = createTenantSubnet(neutronSubnet, neutronSubnet.getGatewayIp());
+            IpAddress gatewayIp = neutronSubnet.getGatewayIp();
+            boolean registeredDefaultRoute = epRegistrator.registerExternalL3PrefixEndpoint(MappingUtils.DEFAULT_ROUTE,
+                    new L3ContextId(neutronSubnet.getNetworkId().getValue()), gatewayIp, tenantId);
+            if (!registeredDefaultRoute) {
+                LOG.warn("Could not add EndpointL3Prefix as default route. Subnet within provider physical network {}",
+                        neutronSubnet);
+                rwTx.cancel();
+                return;
+            }
+        } else {
+            // virtual router IP is not set and it will be set when router gateway port is set
+            // or when a router port is attached to a network
+            subnet = createTenantSubnet(neutronSubnet, null);
+        }
+        rwTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.subnetIid(tenantId, subnet.getId()), subnet, true);
     }
 
-    /**
-     * @see org.opendaylight.neutron.spi.INeutronSubnetAware#neutronSubnetUpdated(org.opendaylight.neutron.spi.NeutronSubnet)
-     */
-    @Override
-    public void neutronSubnetUpdated(NeutronSubnet subnet) {
-        LOG.trace("neutronSubnetUpdated - {}", subnet);
-        neutronSubnetCreated(subnet);
+    @Deprecated
+    public static Subnet createTenantSubnet(
+            org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet subnet,
+            IpAddress virtualRouterIp) {
+        org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.SubnetBuilder subnetBuilder = new org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.SubnetBuilder();
+        subnetBuilder.setId(new SubnetId(subnet.getUuid().getValue()));
+        subnetBuilder.setParent(new ContextId(subnet.getNetworkId().getValue()));
+        if (!Strings.isNullOrEmpty(subnet.getName())) {
+            try {
+                subnetBuilder.setName(new Name(subnet.getName()));
+            } catch (Exception e) {
+                LOG.info("Name '{}' of Neutron Subnet '{}' is ignored.", subnet.getName(),
+                        subnet.getUuid().getValue());
+                LOG.debug("Name exception", e);
+            }
+        }
+        subnetBuilder.setIpPrefix(subnet.getCidr());
+        subnetBuilder.setVirtualRouterIp(virtualRouterIp);
+        return subnetBuilder.build();
     }
 
-    /**
-     * @see org.opendaylight.neutron.spi.INeutronSubnetAware#canDeleteSubnet(org.opendaylight.neutron.spi.NeutronSubnet)
-     */
     @Override
-    public int canDeleteSubnet(NeutronSubnet subnet) {
-        LOG.trace("canDeleteSubnet - {}", subnet);
-        // nothing to consider
-        return StatusCode.OK;
+    public void onUpdated(
+            org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet oldItem,
+            org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet newItem,
+            Neutron oldNeutron, Neutron newNeutron) {
+        LOG.trace("updated subnet - {}", newItem);
+        onCreated(newItem, newNeutron);
     }
 
-    /**
-     * @see org.opendaylight.neutron.spi.INeutronSubnetAware#neutronSubnetDeleted(org.opendaylight.neutron.spi.NeutronSubnet)
-     */
     @Override
-    public void neutronSubnetDeleted(NeutronSubnet neutronSubnet) {
-        LOG.trace("neutronSubnetDeleted - {}", neutronSubnet);
+    public void onDeleted(
+            org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet,
+            Neutron oldNeutron, Neutron newNeutron) {
+        LOG.trace("deleted subnet - {}", neutronSubnet);
         ReadWriteTransaction rwTx = dataProvider.newReadWriteTransaction();
-        SubnetId subnetId = new SubnetId(Utils.normalizeUuid(neutronSubnet.getID()));
-        TenantId tenantId = new TenantId(Utils.normalizeUuid(neutronSubnet.getTenantID()));
+        NetworkDomainId subnetId = new NetworkDomainId(neutronSubnet.getUuid().getValue());
+        TenantId tenantId = new TenantId(neutronSubnet.getTenantId().getValue());
+        Optional<NetworkDomain> potentialSubnetDomain = DataStoreHelper.removeIfExists(LogicalDatastoreType.CONFIGURATION,
+                L2L3IidFactory.subnetIid(tenantId, subnetId), rwTx);
+        if (!potentialSubnetDomain.isPresent()) {
+            LOG.warn("Illegal state - subnet network domain {} does not exist.", subnetId.getValue());
+            rwTx.cancel();
+            return;
+        }
+        removeTenantSubnet(tenantId, new SubnetId(subnetId), rwTx);
+
+        // TODO remove default gateway EP in case when subnet is in provider physical network
+
+        DataStoreHelper.submitToDs(rwTx);
+    }
+
+    @Deprecated
+    private void removeTenantSubnet(TenantId tenantId, SubnetId subnetId, ReadWriteTransaction rwTx) {
         Optional<Subnet> potentialSubnet = DataStoreHelper.removeIfExists(LogicalDatastoreType.CONFIGURATION,
                 IidFactory.subnetIid(tenantId, subnetId), rwTx);
         if (!potentialSubnet.isPresent()) {
@@ -120,8 +208,5 @@ public class NeutronSubnetAware implements INeutronSubnetAware {
             rwTx.cancel();
             return;
         }
-
-        DataStoreHelper.submitToDs(rwTx);
     }
-
 }