python-openstackclient/openstackclient/identity/common.py

#   Copyright 2012-2013 OpenStack 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.
#

"""Common identity code"""

from keystoneclient import exceptions as identity_exc
from keystoneclient.v3 import domains
from keystoneclient.v3 import groups
from keystoneclient.v3 import projects
from keystoneclient.v3 import users
from openstackclient.common import exceptions
from openstackclient.common import utils


def find_service(identity_client, name_type_or_id):
    """Find a service by id, name or type."""

    try:
        # search for the usual ID or name
        return utils.find_resource(identity_client.services, name_type_or_id)
    except exceptions.CommandError:
        try:
            # search for service type
            return identity_client.services.find(type=name_type_or_id)
        # FIXME(dtroyer): This exception should eventually come from
        #                 common client exceptions
        except identity_exc.NotFound:
            msg = ("No service with a type, name or ID of '%s' exists."
                   % name_type_or_id)
            raise exceptions.CommandError(msg)


def find_domain(identity_client, name_or_id):
    """Find a domain.

       If the user does not have permissions to access the v3 domain API, e.g.,
       if the user is a project admin, assume that the domain given is the id
       rather than the name. This method is used by the project list command,
       so errors accessing the domain will be ignored and if the user has
       access to the project API, everything will work fine.

       Closes bugs #1317478 and #1317485.
    """
    try:
        dom = utils.find_resource(identity_client.domains, name_or_id)
        if dom is not None:
            return dom
    except identity_exc.Forbidden:
        pass
    return domains.Domain(None, {'id': name_or_id, 'name': name_or_id})


def find_group(identity_client, name_or_id):
    """Find a group.

       If the user does not have permissions to to perform a list groups call,
       e.g., if the user is a project admin, assume that the group given is the
       id rather than the name.  This method is used by the role add command to
       allow a role to be assigned to a group by a project admin who does not
       have permission to list groups.
    """
    try:
        group = utils.find_resource(identity_client.groups, name_or_id)
        if group is not None:
            return group
    except identity_exc.Forbidden:
        pass
    return groups.Group(None, {'id': name_or_id, 'name': name_or_id})


def find_project(identity_client, name_or_id):
    """Find a project.

       If the user does not have permissions to to perform a list projects
       call, e.g., if the user is a project admin, assume that the project
       given is the id rather than the name.  This method is used by the role
       add command to allow a role to be assigned to a user by a project admin
       who does not have permission to list projects.
    """
    try:
        project = utils.find_resource(identity_client.projects, name_or_id)
        if project is not None:
            return project
    except identity_exc.Forbidden:
        pass
    return projects.Project(None, {'id': name_or_id, 'name': name_or_id})


def find_user(identity_client, name_or_id):
    """Find a user.

       If the user does not have permissions to to perform a list users call,
       e.g., if the user is a project admin, assume that the user given is the
       id rather than the name.  This method is used by the role add command to
       allow a role to be assigned to a user by a project admin who does not
       have permission to list users.
    """
    try:
        user = utils.find_resource(identity_client.users, name_or_id)
        if user is not None:
            return user
    except identity_exc.Forbidden:
        pass
    return users.User(None, {'id': name_or_id, 'name': name_or_id})