xos/synchronizer/model_policies/model_policy_volttenant.py

# Copyright 2017-present Open Networking Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


from synchronizers.new_base.modelaccessor import *
from synchronizers.new_base.policy import Policy

class VOLTTenantPolicy(Policy):
    model_name = "VOLTTenant"

    def handle_create(self, tenant):
        return self.handle_update(tenant)

    def handle_update(self, tenant):
        self.manage_vsg(tenant)
        self.manage_subscriber(tenant)
        self.cleanup_orphans(tenant)

    def handle_delete(self, tenant):
        pass
        # assume this is handled by ServiceInstanceLink being deleted
        #if tenant.vcpe:
        #    tenant.vcpe.delete()

    def get_current_vsg(self, tenant):
        for link in ServiceInstanceLink.objects.filter(subscriber_service_instance_id = tenant.id):
            # NOTE: Assumes the first (and only?) link is to a vsg
            # cast from ServiceInstance to VSGTenant
            return link.provider_service_instance.leaf_model
        return None

    def create_vsg(self, tenant):
        vsgServices = VSGService.objects.all()
        if not vsgServices:
            raise XOSConfigurationError("No VSG Services available")

        self.logger.info("MODEL_POLICY: volttenant %s creating vsg" % tenant)

        cur_vsg = VSGServiceInstance(owner=vsgServices[0])
        cur_vsg.creator = tenant.creator
        cur_vsg.save()
        link = ServiceInstanceLink(provider_service_instance=cur_vsg, subscriber_service_instance=tenant)
        link.save()

    def manage_vsg(self, tenant):
        # Each VOLT object owns exactly one VCPE object

        if tenant.deleted:
            self.logger.info("MODEL_POLICY: volttenant %s deleted, deleting vsg" % tenant)
            return

        cur_vsg = self.get_current_vsg(tenant)

        # Check to see if the wrong s-tag is set. This can only happen if the
        # user changed the s-tag after the VoltTenant object was created.
        if cur_vsg and cur_vsg.instance:
            s_tags = Tag.objects.filter(content_type=cur_vsg.instance.self_content_type_id,
                                        object_id=cur_vsg.instance.id, name="s_tag")
            if s_tags and (s_tags[0].value != str(tenant.s_tag)):
                self.logger.info("MODEL_POLICY: volttenant %s s_tag changed, deleting vsg" % tenant)
                cur_vsg.delete()
                cur_vsg = None

        if cur_vsg is None:
            self.create_vsg(tenant)

    def manage_subscriber(self, tenant):
        # check for existing link to a root
        links = tenant.provided_links.all()
        for link in links:
            roots = CordSubscriberRoot.objects.filter(id = link.subscriber_service_instance.id)
            if roots:
                return

        subs = CordSubscriberRoot.objects.filter(service_specific_id = tenant.service_specific_id)
        if subs:
            self.logger.info("MODEL_POLICY: volttenant %s using existing subscriber root" % tenant)
            sub = subs[0]
        else:
            self.logger.info("MODEL_POLICY: volttenant %s creating new subscriber root" % tenant)
            sub = CordSubscriberRoot(service_specific_id = tenant.service_specific_id,
                                     name = "autogenerated-for-vOLT-%s" % tenant.id)
            sub.save()

        link = ServiceInstanceLink(provider_service_instance = tenant, subscriber_service_instance = sub)
        link.save()

    def cleanup_orphans(self, tenant):
        # ensure vOLT only has one vCPE
        cur_vsg = self.get_current_vsg(tenant)

        links = tenant.subscribed_links.all()
        for link in links:
            if (link.provider_service_instance_id != cur_vsg.id):
                link.delete()