From 92e3ebee208500e4db5c3aebf0d24c8619b6d8a9 Mon Sep 17 00:00:00 2001 From: Abhishek Chanda Date: Sun, 14 Dec 2014 16:37:33 +0530 Subject: [PATCH] Migrate to oslo.context Remove deprecated oslo incubator code Change-Id: Iee16111fc86aef83603251aedf6d58f6da78fc92 --- magnum/common/context.py | 2 +- magnum/objects/base.py | 2 +- magnum/openstack/common/context.py | 122 ----------------------------- openstack-common.conf | 1 - requirements.txt | 1 + 5 files changed, 3 insertions(+), 125 deletions(-) delete mode 100644 magnum/openstack/common/context.py diff --git a/magnum/common/context.py b/magnum/common/context.py index 08b4f4d48b..6f6ee15c5e 100644 --- a/magnum/common/context.py +++ b/magnum/common/context.py @@ -12,7 +12,7 @@ # License for the specific language governing permissions and limitations # under the License. -from magnum.openstack.common import context +from oslo_context import context class RequestContext(context.RequestContext): diff --git a/magnum/objects/base.py b/magnum/objects/base.py index d789f28869..1f23ffd26f 100644 --- a/magnum/objects/base.py +++ b/magnum/objects/base.py @@ -18,13 +18,13 @@ import collections import copy from oslo import messaging +from oslo_context import context import six from magnum.common import exception from magnum.objects import utils as obj_utils from magnum.openstack.common._i18n import _ from magnum.openstack.common._i18n import _LE -from magnum.openstack.common import context from magnum.openstack.common import log as logging from magnum.openstack.common import versionutils diff --git a/magnum/openstack/common/context.py b/magnum/openstack/common/context.py deleted file mode 100644 index 168989004c..0000000000 --- a/magnum/openstack/common/context.py +++ /dev/null @@ -1,122 +0,0 @@ -# Copyright 2011 OpenStack Foundation. -# All Rights Reserved. -# -# 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. - -""" -Simple class that stores security context information in the web request. - -Projects should subclass this class if they wish to enhance the request -context or provide additional information in their specific WSGI pipeline. -""" - -import itertools -import uuid - - -def generate_request_id(): - return b'req-' + str(uuid.uuid4()).encode('ascii') - - -class RequestContext(object): - - """Helper class to represent useful information about a request context. - - Stores information about the security context under which the user - accesses the system, as well as additional request information. - """ - - user_idt_format = '{user} {tenant} {domain} {user_domain} {p_domain}' - - def __init__(self, auth_token=None, user=None, tenant=None, domain=None, - user_domain=None, project_domain=None, is_admin=False, - read_only=False, show_deleted=False, request_id=None, - instance_uuid=None): - self.auth_token = auth_token - self.user = user - self.tenant = tenant - self.domain = domain - self.user_domain = user_domain - self.project_domain = project_domain - self.is_admin = is_admin - self.read_only = read_only - self.show_deleted = show_deleted - self.instance_uuid = instance_uuid - if not request_id: - request_id = generate_request_id() - self.request_id = request_id - - def to_dict(self): - user_idt = ( - self.user_idt_format.format(user=self.user or '-', - tenant=self.tenant or '-', - domain=self.domain or '-', - user_domain=self.user_domain or '-', - p_domain=self.project_domain or '-')) - - return {'user': self.user, - 'tenant': self.tenant, - 'domain': self.domain, - 'user_domain': self.user_domain, - 'project_domain': self.project_domain, - 'is_admin': self.is_admin, - 'read_only': self.read_only, - 'show_deleted': self.show_deleted, - 'auth_token': self.auth_token, - 'request_id': self.request_id, - 'instance_uuid': self.instance_uuid, - 'user_identity': user_idt} - - @classmethod - def from_dict(cls, ctx): - return cls( - auth_token=ctx.get("auth_token"), - user=ctx.get("user"), - tenant=ctx.get("tenant"), - domain=ctx.get("domain"), - user_domain=ctx.get("user_domain"), - project_domain=ctx.get("project_domain"), - is_admin=ctx.get("is_admin", False), - read_only=ctx.get("read_only", False), - show_deleted=ctx.get("show_deleted", False), - request_id=ctx.get("request_id"), - instance_uuid=ctx.get("instance_uuid")) - - -def get_admin_context(show_deleted=False): - context = RequestContext(None, - tenant=None, - is_admin=True, - show_deleted=show_deleted) - return context - - -def get_context_from_function_and_args(function, args, kwargs): - """Find an arg of type RequestContext and return it. - - This is useful in a couple of decorators where we don't - know much about the function we're wrapping. - """ - - for arg in itertools.chain(kwargs.values(), args): - if isinstance(arg, RequestContext): - return arg - - return None - - -def is_user_context(context): - """Indicates if the request context is a normal user.""" - if not context or context.is_admin: - return False - return context.user_id and context.project_id diff --git a/openstack-common.conf b/openstack-common.conf index 36a5535f76..1f02709a77 100644 --- a/openstack-common.conf +++ b/openstack-common.conf @@ -1,7 +1,6 @@ [DEFAULT] # The list of modules to copy from oslo-incubator.git -module=context module=eventlet_backdoor module=log module=loopingcall diff --git a/requirements.txt b/requirements.txt index 1ab25ad6de..f998833949 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ Babel>=1.3 oslo.concurrency>=0.1.0 oslo.config>=1.4.0 +oslo.context>=0.1.0 # Apache-2.0 oslo.db>=0.2.0 # Apache-2.0 oslo.messaging>=1.4.0 oslo.serialization>=1.0.0