Source code for heat.engine.clients.os.neutron

#
#    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 neutronclient.common import exceptions
from neutronclient.neutron import v2_0 as neutronV20
from neutronclient.v2_0 import client as nc
from oslo_config import cfg
from oslo_utils import uuidutils

from heat.common import exception
from heat.common.i18n import _
from heat.engine.clients import client_plugin
from heat.engine.clients import os as os_client


[docs]class NeutronClientPlugin(os_client.ExtensionMixin,
                          client_plugin.ClientPlugin):

    exceptions_module = exceptions

    service_types = [NETWORK] = ['network']

    RES_TYPES = (
        RES_TYPE_NETWORK, RES_TYPE_SUBNET, RES_TYPE_ROUTER, RES_TYPE_PORT,
        RES_TYPE_SUBNET_POOL, RES_TYPE_ADDRESS_SCOPE,
        RES_TYPE_SECURITY_GROUP,
        RES_TYPE_QOS_POLICY,
        RES_TYPE_LOADBALANCER,
        RES_TYPE_LB_LISTENER, RES_TYPE_LB_POOL, RES_TYPE_LB_L7POLICY,
    ) = (
        'network', 'subnet', 'router', 'port',
        'subnetpool', 'address_scope',
        'security_group',
        'policy',
        'loadbalancer',
        'listener', 'pool', 'l7policy',
    )

    _res_cmdres_mapping = {
        # resource: cmd_resource
        RES_TYPE_QOS_POLICY: 'qos_policy',
        RES_TYPE_LOADBALANCER: 'lbaas_loadbalancer',
        RES_TYPE_LB_POOL: 'lbaas_pool',
        RES_TYPE_LB_L7POLICY: 'lbaas_l7policy'
    }

    def _create(self):

        con = self.context
        interface = self._get_client_option('neutron', 'endpoint_type')
        args = {
            'session': con.keystone_session,
            'service_type': self.NETWORK,
            'interface': interface,
            'region_name': self._get_region_name(),
            'connect_retries': cfg.CONF.client_retry_limit
        }

        return nc.Client(**args)

[docs]    def is_not_found(self, ex):
        if isinstance(ex, (exceptions.NotFound,
                           exceptions.NetworkNotFoundClient,
                           exceptions.PortNotFoundClient)):
            return True
        return (isinstance(ex, exceptions.NeutronClientException) and
                ex.status_code == 404)

[docs]    def is_conflict(self, ex):
        bad_conflicts = (exceptions.OverQuotaClient,)
        return (isinstance(ex, exceptions.Conflict) and
                not isinstance(ex, bad_conflicts))

[docs]    def is_over_limit(self, ex):
        if not isinstance(ex, exceptions.NeutronClientException):
            return False
        return ex.status_code == 413

[docs]    def is_no_unique(self, ex):
        return isinstance(ex, exceptions.NeutronClientNoUniqueMatch)

[docs]    def is_invalid(self, ex):
        return isinstance(ex, exceptions.StateInvalidClient)

[docs]    def find_resourceid_by_name_or_id(self, resource, name_or_id,
                                      cmd_resource=None):
        """Find a resource ID given either a name or an ID.

        The `resource` argument should be one of the constants defined in
        RES_TYPES.
        """
        cmd_resource = (cmd_resource or
                        self._res_cmdres_mapping.get(resource))
        return self._find_resource_id(self.context.tenant_id,
                                      resource, name_or_id,
                                      cmd_resource)

    @os_client.MEMOIZE_FINDER
    def _find_resource_id(self, tenant_id,
                          resource, name_or_id, cmd_resource):
        # tenant id in the signature is used for the memoization key,
        # that would differentiate similar resource names across tenants.
        return neutronV20.find_resourceid_by_name_or_id(
            self.client(), resource, name_or_id, cmd_resource=cmd_resource)

    @os_client.MEMOIZE_EXTENSIONS
    def _list_extensions(self):
        extensions = self.client().list_extensions().get('extensions')
        return set(extension.get('alias') for extension in extensions)

    def _resolve(self, props, key, id_key, key_type):
        if props.get(key):
            props[id_key] = self.find_resourceid_by_name_or_id(key_type,
                                                               props.pop(key))
        return props[id_key]

[docs]    def resolve_pool(self, props, pool_key, pool_id_key):
        if props.get(pool_key):
            props[pool_id_key] = self.find_resourceid_by_name_or_id(
                'pool', props.get(pool_key))
            props.pop(pool_key)
        return props[pool_id_key]

[docs]    def resolve_router(self, props, router_key, router_id_key):
        return self._resolve(props, router_key, router_id_key, 'router')

[docs]    def network_id_from_subnet_id(self, subnet_id):
        subnet_info = self.client().show_subnet(subnet_id)
        return subnet_info['subnet']['network_id']

[docs]    def check_lb_status(self, lb_id):
        lb = self.client().show_loadbalancer(lb_id)['loadbalancer']
        status = lb['provisioning_status']
        if status == 'ERROR':
            raise exception.ResourceInError(resource_status=status)
        return status == 'ACTIVE'

[docs]    def get_qos_policy_id(self, policy):
        """Returns the id of QoS policy.

        Args:
        policy: ID or name of the policy.
        """
        return self.find_resourceid_by_name_or_id(
            'policy', policy)

[docs]    def get_secgroup_uuids(self, security_groups):
        '''Returns a list of security group UUIDs.

        Args:
        security_groups: List of security group names or UUIDs
        '''
        seclist = []
        all_groups = None
        for sg in security_groups:
            if uuidutils.is_uuid_like(sg):
                seclist.append(sg)
            else:
                if not all_groups:
                    # filtering by project_id so that if the user
                    # has access to multiple (like admin)
                    # only groups from the token scope are returned
                    response = self.client().list_security_groups(
                        project_id=self.context.project_id)
                    all_groups = response['security_groups']
                same_name_groups = [g for g in all_groups if g['name'] == sg]
                groups = [g['id'] for g in same_name_groups]
                if len(groups) == 0:
                    raise exception.EntityNotFound(entity='Resource', name=sg)
                elif len(groups) == 1:
                    seclist.append(groups[0])
                else:
                    raise exception.PhysicalResourceNameAmbiguity(name=sg)
        return seclist

    def _resolve_resource_path(self, resource):
        """Returns ext resource path."""

        if resource == 'port_pair':
            path = "/sfc/port_pairs"
        elif resource == 'port_pair_group':
            path = "/sfc/port_pair_groups"
        elif resource == 'flow_classifier':
            path = "/sfc/flow_classifiers"
        elif resource == 'port_chain':
            path = "/sfc/port_chains"
        elif resource == 'tap_service':
            path = "/taas/tap_services"
        elif resource == 'tap_flow':
            path = "/taas/tap_flows"
        return path

[docs]    def create_ext_resource(self, resource, props):
        """Returns created ext resource record."""

        path = self._resolve_resource_path(resource)
        record = self.client().create_ext(path, {resource: props}
                                          ).get(resource)
        return record

[docs]    def update_ext_resource(self, resource, prop_diff, resource_id):
        """Returns updated ext resource record."""

        path = self._resolve_resource_path(resource)
        return self.client().update_ext(path + '/%s', resource_id,
                                        {resource: prop_diff})

[docs]    def delete_ext_resource(self, resource, resource_id):
        """Deletes ext resource record and returns status."""

        path = self._resolve_resource_path(resource)
        return self.client().delete_ext(path + '/%s', resource_id)

[docs]    def show_ext_resource(self, resource, resource_id):
        """Returns specific ext resource record."""

        path = self._resolve_resource_path(resource)
        return self.client().show_ext(path + '/%s', resource_id
                                      ).get(resource)

[docs]    def check_ext_resource_status(self, resource, resource_id):
        ext_resource = self.show_ext_resource(resource, resource_id)
        status = ext_resource['status']
        if status == 'ERROR':
            raise exception.ResourceInError(resource_status=status)
        return status == 'ACTIVE'

[docs]    def resolve_ext_resource(self, resource, name_or_id):
        """Returns the id and validate neutron ext resource."""

        path = self._resolve_resource_path(resource)

        try:
            record = self.client().show_ext(path + '/%s', name_or_id)
            return record.get(resource).get('id')
        except exceptions.NotFound:
            res_plural = resource + 's'
            result = self.client().list_ext(collection=res_plural,
                                            path=path, retrieve_all=True)
            resources = result.get(res_plural)
            matched = []
            for res in resources:
                if res.get('name') == name_or_id:
                    matched.append(res.get('id'))
            if len(matched) > 1:
                raise exceptions.NeutronClientNoUniqueMatch(resource=resource,
                                                            name=name_or_id)
            elif len(matched) == 0:
                not_found_message = (_("Unable to find %(resource)s with name "
                                       "or id '%(name_or_id)s'") %
                                     {'resource': resource,
                                      'name_or_id': name_or_id})
                raise exceptions.NotFound(message=not_found_message)
            else:
                return matched[0]