From cc65556ed680493317cd1f34d3ddd0bbf94b3994 Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Tue, 9 Dec 2014 18:34:39 +0100 Subject: [PATCH] Switch to oslo.context library Change-Id: I2eba3c17eb5b3a16d84c268b9e4999c48635ac2b --- ceilometer/agent/base.py | 2 +- ceilometer/agent/plugin_base.py | 2 +- ceilometer/alarm/notifier/rest.py | 2 +- ceilometer/alarm/rpc.py | 2 +- ceilometer/api/controllers/v2.py | 2 +- ceilometer/cli.py | 2 +- ceilometer/messaging.py | 3 +- ceilometer/notification.py | 2 +- ceilometer/notifier.py | 2 +- ceilometer/objectstore/swift_middleware.py | 2 +- ceilometer/openstack/common/context.py | 122 ------------------ ceilometer/tests/alarm/test_notifier.py | 4 +- .../tests/api/v2/test_alarm_scenarios.py | 2 +- ceilometer/tests/energy/test_kwapi.py | 2 +- ceilometer/tests/image/test_glance.py | 2 +- .../tests/network/services/test_fwaas.py | 2 +- .../tests/network/services/test_lbaas.py | 2 +- .../tests/network/services/test_vpnaas.py | 2 +- ceilometer/tests/network/test_floatingip.py | 2 +- .../publisher/test_messaging_publisher.py | 2 +- ceilometer/tests/test_collector.py | 2 +- ceilometer/tests/test_notification.py | 2 +- openstack-common.conf | 1 - requirements.txt | 1 + 24 files changed, 23 insertions(+), 146 deletions(-) delete mode 100644 ceilometer/openstack/common/context.py diff --git a/ceilometer/agent/base.py b/ceilometer/agent/base.py index 241da325c4..c6d9b34a94 100644 --- a/ceilometer/agent/base.py +++ b/ceilometer/agent/base.py @@ -23,13 +23,13 @@ import fnmatch import itertools from oslo.config import cfg +from oslo_context import context import six from six.moves.urllib import parse as urlparse from stevedore import extension from ceilometer import coordination from ceilometer.i18n import _ -from ceilometer.openstack.common import context from ceilometer.openstack.common import log from ceilometer.openstack.common import service as os_service from ceilometer import pipeline as publish_pipeline diff --git a/ceilometer/agent/plugin_base.py b/ceilometer/agent/plugin_base.py index a2125af9dd..902ed3b450 100644 --- a/ceilometer/agent/plugin_base.py +++ b/ceilometer/agent/plugin_base.py @@ -24,11 +24,11 @@ import fnmatch from keystoneclient.v2_0 import client as ksclient from oslo.config import cfg import oslo.messaging +from oslo_context import context import six from ceilometer.i18n import _ from ceilometer import messaging -from ceilometer.openstack.common import context from ceilometer.openstack.common import log from ceilometer.publisher import utils diff --git a/ceilometer/alarm/notifier/rest.py b/ceilometer/alarm/notifier/rest.py index 44dc986b41..e923ead03d 100644 --- a/ceilometer/alarm/notifier/rest.py +++ b/ceilometer/alarm/notifier/rest.py @@ -19,12 +19,12 @@ import eventlet from oslo.config import cfg from oslo.serialization import jsonutils +from oslo_context import context import requests import six.moves.urllib.parse as urlparse from ceilometer.alarm import notifier from ceilometer.i18n import _ -from ceilometer.openstack.common import context from ceilometer.openstack.common import log LOG = log.getLogger(__name__) diff --git a/ceilometer/alarm/rpc.py b/ceilometer/alarm/rpc.py index 6509a2325c..b50303c5f1 100644 --- a/ceilometer/alarm/rpc.py +++ b/ceilometer/alarm/rpc.py @@ -16,12 +16,12 @@ # under the License. from oslo.config import cfg +from oslo_context import context import six from ceilometer.alarm.storage import models from ceilometer.i18n import _ from ceilometer import messaging -from ceilometer.openstack.common import context from ceilometer.openstack.common import log OPTS = [ diff --git a/ceilometer/api/controllers/v2.py b/ceilometer/api/controllers/v2.py index 53231d3f37..e92020c08b 100644 --- a/ceilometer/api/controllers/v2.py +++ b/ceilometer/api/controllers/v2.py @@ -41,6 +41,7 @@ from oslo.config import cfg from oslo.utils import netutils from oslo.utils import strutils from oslo.utils import timeutils +from oslo_context import context import pecan from pecan import rest import pytz @@ -56,7 +57,6 @@ from ceilometer.api import rbac from ceilometer.event.storage import models as event_models from ceilometer.i18n import _ from ceilometer import messaging -from ceilometer.openstack.common import context from ceilometer.openstack.common import log from ceilometer import sample from ceilometer import storage diff --git a/ceilometer/cli.py b/ceilometer/cli.py index b66f3af0d1..d1f4870e07 100644 --- a/ceilometer/cli.py +++ b/ceilometer/cli.py @@ -30,8 +30,8 @@ import eventlet eventlet.monkey_patch(socket=True, select=True, thread=True) from oslo.config import cfg from oslo.utils import timeutils +from oslo_context import context -from ceilometer.openstack.common import context from ceilometer import pipeline from ceilometer import sample from ceilometer import service diff --git a/ceilometer/messaging.py b/ceilometer/messaging.py index cf479d7331..694ec77fb2 100644 --- a/ceilometer/messaging.py +++ b/ceilometer/messaging.py @@ -18,8 +18,7 @@ from oslo.config import cfg import oslo.messaging from oslo.serialization import jsonutils - -from ceilometer.openstack.common import context +from oslo_context import context DEFAULT_URL = "__default__" TRANSPORTS = {} diff --git a/ceilometer/notification.py b/ceilometer/notification.py index 99630008e5..883a801b57 100644 --- a/ceilometer/notification.py +++ b/ceilometer/notification.py @@ -17,13 +17,13 @@ from oslo.config import cfg import oslo.messaging +from oslo_context import context from stevedore import extension from ceilometer import coordination from ceilometer.event import endpoint as event_endpoint from ceilometer.i18n import _ from ceilometer import messaging -from ceilometer.openstack.common import context from ceilometer.openstack.common import log from ceilometer.openstack.common import service as os_service from ceilometer import pipeline diff --git a/ceilometer/notifier.py b/ceilometer/notifier.py index a8946f84d9..cf04f09c21 100644 --- a/ceilometer/notifier.py +++ b/ceilometer/notifier.py @@ -15,10 +15,10 @@ # License for the specific language governing permissions and limitations # under the License. +from oslo_context import context as req_context from stevedore import extension from ceilometer.i18n import _ -from ceilometer.openstack.common import context as req_context from ceilometer.openstack.common import log as logging from ceilometer import pipeline from ceilometer import transformer diff --git a/ceilometer/objectstore/swift_middleware.py b/ceilometer/objectstore/swift_middleware.py index fbb033774d..6eb7f8ed96 100644 --- a/ceilometer/objectstore/swift_middleware.py +++ b/ceilometer/objectstore/swift_middleware.py @@ -43,10 +43,10 @@ from __future__ import absolute_import import logging from oslo.utils import timeutils +from oslo_context import context import six import six.moves.urllib.parse as urlparse -from ceilometer.openstack.common import context from ceilometer import pipeline from ceilometer import sample from ceilometer import service diff --git a/ceilometer/openstack/common/context.py b/ceilometer/openstack/common/context.py deleted file mode 100644 index 168989004c..0000000000 --- a/ceilometer/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/ceilometer/tests/alarm/test_notifier.py b/ceilometer/tests/alarm/test_notifier.py index 82681ab24a..281cf03d18 100644 --- a/ceilometer/tests/alarm/test_notifier.py +++ b/ceilometer/tests/alarm/test_notifier.py @@ -18,12 +18,12 @@ import mock from oslo.config import fixture as fixture_config from oslo.serialization import jsonutils +from oslo_context import context from oslotest import mockpatch import requests import six.moves.urllib.parse as urlparse from ceilometer.alarm import service -from ceilometer.openstack.common import context from ceilometer.tests import base as tests_base @@ -49,7 +49,7 @@ class TestAlarmNotifier(tests_base.BaseTestCase): self.setup_messaging(self.CONF) self.service = service.AlarmNotifierService() self.useFixture(mockpatch.Patch( - 'ceilometer.openstack.common.context.generate_request_id', + 'oslo_context.context.generate_request_id', self._fake_generate_request_id)) @mock.patch('ceilometer.pipeline.setup_pipeline', mock.MagicMock()) diff --git a/ceilometer/tests/api/v2/test_alarm_scenarios.py b/ceilometer/tests/api/v2/test_alarm_scenarios.py index e3e22d35e7..ac2f93cdd9 100644 --- a/ceilometer/tests/api/v2/test_alarm_scenarios.py +++ b/ceilometer/tests/api/v2/test_alarm_scenarios.py @@ -2213,7 +2213,7 @@ class TestAlarms(v2.FunctionalTest, 'user_id']).issubset(payload.keys())) endpoint.info.assert_called_once_with( - {'instance_uuid': None, + {'resource_uuid': None, 'domain': None, 'project_domain': None, 'auth_token': None, diff --git a/ceilometer/tests/energy/test_kwapi.py b/ceilometer/tests/energy/test_kwapi.py index 3940598e0d..8055416e3d 100644 --- a/ceilometer/tests/energy/test_kwapi.py +++ b/ceilometer/tests/energy/test_kwapi.py @@ -18,13 +18,13 @@ import datetime from keystoneclient import exceptions import mock +from oslo_context import context from oslotest import base from oslotest import mockpatch import six from ceilometer.agent import manager from ceilometer.energy import kwapi -from ceilometer.openstack.common import context PROBE_DICT = { diff --git a/ceilometer/tests/image/test_glance.py b/ceilometer/tests/image/test_glance.py index 5ae5f48218..d60e488dc1 100644 --- a/ceilometer/tests/image/test_glance.py +++ b/ceilometer/tests/image/test_glance.py @@ -17,12 +17,12 @@ import mock from oslo.config import fixture as fixture_config +from oslo_context import context from oslotest import base from oslotest import mockpatch from ceilometer.agent import manager from ceilometer.image import glance -from ceilometer.openstack.common import context IMAGE_LIST = [ type('Image', (object,), diff --git a/ceilometer/tests/network/services/test_fwaas.py b/ceilometer/tests/network/services/test_fwaas.py index fd2b59b85c..34440e1f78 100644 --- a/ceilometer/tests/network/services/test_fwaas.py +++ b/ceilometer/tests/network/services/test_fwaas.py @@ -16,6 +16,7 @@ # under the License. import mock +from oslo_context import context from oslotest import base from oslotest import mockpatch @@ -23,7 +24,6 @@ from ceilometer.agent import manager from ceilometer.agent import plugin_base from ceilometer.network.services import discovery from ceilometer.network.services import fwaas -from ceilometer.openstack.common import context class _BaseTestFWPollster(base.BaseTestCase): diff --git a/ceilometer/tests/network/services/test_lbaas.py b/ceilometer/tests/network/services/test_lbaas.py index 209f336f51..b00092db64 100644 --- a/ceilometer/tests/network/services/test_lbaas.py +++ b/ceilometer/tests/network/services/test_lbaas.py @@ -16,6 +16,7 @@ # under the License. import mock +from oslo_context import context from oslotest import base from oslotest import mockpatch @@ -23,7 +24,6 @@ from ceilometer.agent import manager from ceilometer.agent import plugin_base from ceilometer.network.services import discovery from ceilometer.network.services import lbaas -from ceilometer.openstack.common import context class _BaseTestLBPollster(base.BaseTestCase): diff --git a/ceilometer/tests/network/services/test_vpnaas.py b/ceilometer/tests/network/services/test_vpnaas.py index d8cf0bc560..e1ae2d7886 100644 --- a/ceilometer/tests/network/services/test_vpnaas.py +++ b/ceilometer/tests/network/services/test_vpnaas.py @@ -16,6 +16,7 @@ # under the License. import mock +from oslo_context import context from oslotest import base from oslotest import mockpatch @@ -23,7 +24,6 @@ from ceilometer.agent import manager from ceilometer.agent import plugin_base from ceilometer.network.services import discovery from ceilometer.network.services import vpnaas -from ceilometer.openstack.common import context class _BaseTestVPNPollster(base.BaseTestCase): diff --git a/ceilometer/tests/network/test_floatingip.py b/ceilometer/tests/network/test_floatingip.py index 7cf77cdce8..6811697d7f 100644 --- a/ceilometer/tests/network/test_floatingip.py +++ b/ceilometer/tests/network/test_floatingip.py @@ -20,11 +20,11 @@ # under the License. import mock +from oslo_context import context from oslotest import base from ceilometer.agent import manager from ceilometer.network import floatingip -from ceilometer.openstack.common import context class TestFloatingIPPollster(base.BaseTestCase): diff --git a/ceilometer/tests/publisher/test_messaging_publisher.py b/ceilometer/tests/publisher/test_messaging_publisher.py index a9d783afbd..678fd627f2 100644 --- a/ceilometer/tests/publisher/test_messaging_publisher.py +++ b/ceilometer/tests/publisher/test_messaging_publisher.py @@ -24,10 +24,10 @@ import mock from oslo.config import fixture as fixture_config import oslo.messaging from oslo.utils import netutils +from oslo_context import context import testscenarios.testcase from ceilometer import messaging -from ceilometer.openstack.common import context from ceilometer.publisher import messaging as msg_publisher from ceilometer import sample from ceilometer.tests import base as tests_base diff --git a/ceilometer/tests/test_collector.py b/ceilometer/tests/test_collector.py index bc58fb30b1..3293acbcb2 100644 --- a/ceilometer/tests/test_collector.py +++ b/ceilometer/tests/test_collector.py @@ -22,13 +22,13 @@ import msgpack from oslo.config import fixture as fixture_config import oslo.messaging from oslo.utils import timeutils +from oslo_context import context from oslotest import mockpatch from stevedore import extension from ceilometer import collector from ceilometer import dispatcher from ceilometer import messaging -from ceilometer.openstack.common import context from ceilometer.publisher import utils from ceilometer import sample from ceilometer.tests import base as tests_base diff --git a/ceilometer/tests/test_notification.py b/ceilometer/tests/test_notification.py index d62f247529..e15e033814 100644 --- a/ceilometer/tests/test_notification.py +++ b/ceilometer/tests/test_notification.py @@ -22,13 +22,13 @@ from oslo.config import fixture as fixture_config import oslo.messaging import oslo.messaging.conffixture from oslo.utils import timeutils +from oslo_context import context from stevedore import extension import yaml from ceilometer.compute.notifications import instance from ceilometer import messaging from ceilometer import notification -from ceilometer.openstack.common import context from ceilometer.openstack.common import fileutils from ceilometer.publisher import test as test_publisher from ceilometer.tests import base as tests_base diff --git a/openstack-common.conf b/openstack-common.conf index 98fe4c7422..40b7f86d23 100644 --- a/openstack-common.conf +++ b/openstack-common.conf @@ -1,7 +1,6 @@ [DEFAULT] # The list of modules to copy from oslo-incubator -module=context module=log module=policy module=service diff --git a/requirements.txt b/requirements.txt index 4adf7d8531..a06d2746e7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -16,6 +16,7 @@ lockfile>=0.8 lxml>=2.3 msgpack-python>=0.4.0 netaddr>=0.7.12 +oslo.context>=0.1.0 # Apache-2.0 oslo.db>=1.1.0 # Apache-2.0 oslo.concurrency>=0.3.0 # Apache-2.0 oslo.config>=1.4.0 # Apache-2.0