From f0de0c6291600706fe13db201f203f9da8f5d45c Mon Sep 17 00:00:00 2001 From: Ronald Bradford Date: Tue, 5 Apr 2016 16:50:20 -0400 Subject: Add oslo.context name attributes matching ids Provide in the oslo.context base class _name attributes to match the already defined id attributes (that are not yet called _id). These attributes are made available for oslo.log to use in context aware logging. This will replace any projects that subclass RequestContext and subsequently add these attributes to to_dict(). e.g. http://git.openstack.org/cgit/openstack/nova/tree/nova/context.py#n176 See as discussed on ML at http://lists.openstack.org/pipermail/openstack-dev/2016-April/091453.html Change-Id: I1fbb613ded8dbcb99b2f43a4bc43f9046097c0ce --- oslo_context/context.py | 24 ++++- oslo_context/tests/test_context.py | 177 +++++++++++++++++++------------------ 2 files changed, 114 insertions(+), 87 deletions(-) (limited to 'oslo_context') diff --git a/oslo_context/context.py b/oslo_context/context.py index d4902ad..bbf26a4 100644 --- a/oslo_context/context.py +++ b/oslo_context/context.py @@ -44,7 +44,11 @@ _ENVIRON_HEADERS = {'auth_token': ['HTTP_X_AUTH_TOKEN', 'HTTP_X_TENANT_ID', 'HTTP_X_TENANT'], 'user_domain': ['HTTP_X_USER_DOMAIN_ID'], - 'project_domain': ['HTTP_X_PROJECT_DOMAIN_ID']} + 'project_domain': ['HTTP_X_PROJECT_DOMAIN_ID'], + 'user_name': ['HTTP_X_USER_NAME'], + 'project_name': ['HTTP_X_PROJECT_NAME'], + 'user_domain_name': ['HTTP_X_USER_DOMAIN_NAME'], + 'project_domain_name': ['HTTP_X_PROJECT_DOMAIN_NAME']} def generate_request_id(): @@ -65,7 +69,9 @@ class RequestContext(object): 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, - resource_uuid=None, overwrite=True, roles=None): + resource_uuid=None, overwrite=True, roles=None, + user_name=None, project_name=None, domain_name=None, + user_domain_name=None, project_domain_name=None): """Initialize the RequestContext :param overwrite: Set to False to ensure that the greenthread local @@ -73,10 +79,17 @@ class RequestContext(object): """ self.auth_token = auth_token self.user = user + self.user_name = user_name + # NOTE (rbradfor): tenant will become project + # See spec discussion on https://review.openstack.org/#/c/290907/ self.tenant = tenant + self.project_name = project_name self.domain = domain + self.domain_name = domain_name self.user_domain = user_domain + self.user_domain_name = user_domain_name self.project_domain = project_domain + self.project_domain_name = project_domain_name self.is_admin = is_admin self.read_only = read_only self.show_deleted = show_deleted @@ -135,7 +148,12 @@ class RequestContext(object): def get_logging_values(self): """Return a dictionary of logging specific context attributes.""" - values = self.to_dict() + values = {'user_name': self.user_name, + 'project_name': self.project_name, + 'domain_name': self.domain_name, + 'user_domain_name': self.user_domain_name, + 'project_domain_name': self.project_domain_name} + values.update(self.to_dict()) return values @classmethod diff --git a/oslo_context/tests/test_context.py b/oslo_context/tests/test_context.py index 2165608..6829416 100644 --- a/oslo_context/tests/test_context.py +++ b/oslo_context/tests/test_context.py @@ -14,6 +14,7 @@ # License for the specific language governing permissions and limitations # under the License. +import hashlib import uuid from oslotest import base as test_base @@ -22,6 +23,10 @@ from oslo_context import context from oslo_context import fixture +def generate_id(name): + return hashlib.md5(name.encode('utf-8')).hexdigest() + + class Object(object): pass @@ -81,10 +86,15 @@ class ContextTest(test_base.BaseTestCase): dct = { "auth_token": "token1", "user": "user1", + "user_name": "user1_name", "tenant": "tenant1", + "project_name": "tenant1_name", "domain": "domain1", + "domain_name": "domain1_name", "user_domain": "user_domain1", + "user_domain_name": "user_domain1_name", "project_domain": "project_domain1", + "project_domain_name": "project_domain1_name", "is_admin": True, "read_only": True, "show_deleted": True, @@ -93,17 +103,22 @@ class ContextTest(test_base.BaseTestCase): "extra_data": "foo" } ctx = context.RequestContext.from_dict(dct) - self.assertEqual("token1", ctx.auth_token) - self.assertEqual("user1", ctx.user) - self.assertEqual("tenant1", ctx.tenant) - self.assertEqual("domain1", ctx.domain) - self.assertEqual("user_domain1", ctx.user_domain) - self.assertEqual("project_domain1", ctx.project_domain) + self.assertEqual(dct['auth_token'], ctx.auth_token) + self.assertEqual(dct['user'], ctx.user) + self.assertEqual(dct['tenant'], ctx.tenant) + self.assertEqual(dct['domain'], ctx.domain) + self.assertEqual(dct['user_domain'], ctx.user_domain) + self.assertEqual(dct['project_domain'], ctx.project_domain) self.assertTrue(ctx.is_admin) self.assertTrue(ctx.read_only) self.assertTrue(ctx.show_deleted) - self.assertEqual("request1", ctx.request_id) - self.assertEqual("instance1", ctx.resource_uuid) + self.assertEqual(dct['request_id'], ctx.request_id) + self.assertEqual(dct['resource_uuid'], ctx.resource_uuid) + self.assertEqual(dct['user_name'], ctx.user_name) + self.assertEqual(dct['project_name'], ctx.project_name) + self.assertEqual(dct['domain_name'], ctx.domain_name) + self.assertEqual(dct['user_domain_name'], ctx.user_domain_name) + self.assertEqual(dct['project_domain_name'], ctx.project_domain_name) def test_from_dict_unknown_keys(self): dct = { @@ -132,10 +147,14 @@ class ContextTest(test_base.BaseTestCase): def test_from_environ_variables(self): auth_token = uuid.uuid4().hex - user_id = uuid.uuid4().hex - project_id = uuid.uuid4().hex - user_domain_id = uuid.uuid4().hex - project_domain_id = uuid.uuid4().hex + user_name = uuid.uuid4().hex + user_id = generate_id(user_name) + project_name = uuid.uuid4().hex + project_id = generate_id(project_name) + user_domain_name = uuid.uuid4().hex + user_domain_id = generate_id(user_domain_name) + project_domain_name = uuid.uuid4().hex + project_domain_id = generate_id(project_domain_name) roles = [uuid.uuid4().hex, uuid.uuid4().hex, uuid.uuid4().hex] environ = {'HTTP_X_AUTH_TOKEN': auth_token, @@ -143,15 +162,23 @@ class ContextTest(test_base.BaseTestCase): 'HTTP_X_PROJECT_ID': project_id, 'HTTP_X_USER_DOMAIN_ID': user_domain_id, 'HTTP_X_PROJECT_DOMAIN_ID': project_domain_id, - 'HTTP_X_ROLES': ','.join(roles)} + 'HTTP_X_ROLES': ','.join(roles), + 'HTTP_X_USER_NAME': user_name, + 'HTTP_X_PROJECT_NAME': project_name, + 'HTTP_X_USER_DOMAIN_NAME': user_domain_name, + 'HTTP_X_PROJECT_DOMAIN_NAME': project_domain_name} ctx = context.RequestContext.from_environ(environ) self.assertEqual(auth_token, ctx.auth_token) self.assertEqual(user_id, ctx.user) + self.assertEqual(user_name, ctx.user_name) self.assertEqual(project_id, ctx.tenant) + self.assertEqual(project_name, ctx.project_name) self.assertEqual(user_domain_id, ctx.user_domain) + self.assertEqual(user_domain_name, ctx.user_domain_name) self.assertEqual(project_domain_id, ctx.project_domain) + self.assertEqual(project_domain_name, ctx.project_domain_name) self.assertEqual(roles, ctx.roles) def test_from_environ_no_roles(self): @@ -232,11 +259,16 @@ class ContextTest(test_base.BaseTestCase): def test_values(self): auth_token = "token1" # test unicode support - user = u"John Gāo" - tenant = "tenant1" - domain = "domain1" - user_domain = "user_domain1" - project_domain = "project_domain1" + user_name = u"John Gāo" + user_id = generate_id(user_name) + project_name = 'tenant1' + project_id = generate_id(project_name) + domain_name = 'domain1' + domain_id = generate_id(domain_name) + user_domain_name = 'user_domain1' + user_domain_id = generate_id(user_domain_name) + project_domain_name = 'project_domain1' + project_domain_id = generate_id(project_domain_name) is_admin = True read_only = True show_deleted = True @@ -244,22 +276,32 @@ class ContextTest(test_base.BaseTestCase): resource_uuid = "uuid1" ctx = context.RequestContext(auth_token=auth_token, - user=user, - tenant=tenant, - domain=domain, - user_domain=user_domain, - project_domain=project_domain, + user=user_id, + user_name=user_name, + tenant=project_id, + project_name=project_name, + domain=domain_id, + domain_name=domain_name, + user_domain=user_domain_id, + user_domain_name=user_domain_name, + project_domain=project_domain_id, + project_domain_name=project_domain_name, is_admin=is_admin, read_only=read_only, show_deleted=show_deleted, request_id=request_id, resource_uuid=resource_uuid) self.assertEqual(auth_token, ctx.auth_token) - self.assertEqual(user, ctx.user) - self.assertEqual(tenant, ctx.tenant) - self.assertEqual(domain, ctx.domain) - self.assertEqual(user_domain, ctx.user_domain) - self.assertEqual(project_domain, ctx.project_domain) + self.assertEqual(user_id, ctx.user) + self.assertEqual(user_name, ctx.user_name) + self.assertEqual(project_id, ctx.tenant) + self.assertEqual(project_name, ctx.project_name) + self.assertEqual(domain_id, ctx.domain) + self.assertEqual(domain_name, ctx.domain_name) + self.assertEqual(user_domain_id, ctx.user_domain) + self.assertEqual(user_domain_name, ctx.user_domain_name) + self.assertEqual(project_domain_id, ctx.project_domain) + self.assertEqual(project_domain_name, ctx.project_domain_name) self.assertEqual(is_admin, ctx.is_admin) self.assertEqual(read_only, ctx.read_only) self.assertEqual(show_deleted, ctx.show_deleted) @@ -280,58 +322,27 @@ class ContextTest(test_base.BaseTestCase): self.assertIn('resource_uuid', d) self.assertIn('user_identity', d) self.assertIn('roles', d) + self.assertNotIn('user_name', d) + self.assertNotIn('project_name', d) + self.assertNotIn('domain_name', d) + self.assertNotIn('user_domain_name', d) + self.assertNotIn('project_domain_name', d) self.assertEqual(auth_token, d['auth_token']) - self.assertEqual(tenant, d['tenant']) - self.assertEqual(domain, d['domain']) - self.assertEqual(user_domain, d['user_domain']) - self.assertEqual(project_domain, d['project_domain']) + self.assertEqual(project_id, d['tenant']) + self.assertEqual(domain_id, d['domain']) + self.assertEqual(user_domain_id, d['user_domain']) + self.assertEqual(project_domain_id, d['project_domain']) self.assertEqual(is_admin, d['is_admin']) self.assertEqual(read_only, d['read_only']) self.assertEqual(show_deleted, d['show_deleted']) self.assertEqual(request_id, d['request_id']) self.assertEqual(resource_uuid, d['resource_uuid']) - user_identity = "%s %s %s %s %s" % (user, tenant, domain, - user_domain, project_domain) + user_identity = "%s %s %s %s %s" % (user_id, project_id, domain_id, + user_domain_id, project_domain_id) self.assertEqual(user_identity, d['user_identity']) self.assertEqual([], d['roles']) - def test_get_logging_values(self): - auth_token = "token1" - user = "user1" - tenant = "tenant1" - domain = "domain1" - user_domain = "user_domain1" - project_domain = "project_domain1" - is_admin = True - read_only = True - show_deleted = True - request_id = "id1" - resource_uuid = "uuid1" - - ctx = context.RequestContext(auth_token=auth_token, - user=user, - tenant=tenant, - domain=domain, - user_domain=user_domain, - project_domain=project_domain, - is_admin=is_admin, - read_only=read_only, - show_deleted=show_deleted, - request_id=request_id, - resource_uuid=resource_uuid) - self.assertEqual(auth_token, ctx.auth_token) - self.assertEqual(user, ctx.user) - self.assertEqual(tenant, ctx.tenant) - self.assertEqual(domain, ctx.domain) - self.assertEqual(user_domain, ctx.user_domain) - self.assertEqual(project_domain, ctx.project_domain) - self.assertEqual(is_admin, ctx.is_admin) - self.assertEqual(read_only, ctx.read_only) - self.assertEqual(show_deleted, ctx.show_deleted) - self.assertEqual(request_id, ctx.request_id) - self.assertEqual(resource_uuid, ctx.resource_uuid) - d = ctx.get_logging_values() self.assertIn('auth_token', d) self.assertIn('user', d) @@ -345,20 +356,18 @@ class ContextTest(test_base.BaseTestCase): self.assertIn('request_id', d) self.assertIn('resource_uuid', d) self.assertIn('user_identity', d) - - self.assertEqual(auth_token, d['auth_token']) - self.assertEqual(tenant, d['tenant']) - self.assertEqual(domain, d['domain']) - self.assertEqual(user_domain, d['user_domain']) - self.assertEqual(project_domain, d['project_domain']) - self.assertEqual(is_admin, d['is_admin']) - self.assertEqual(read_only, d['read_only']) - self.assertEqual(show_deleted, d['show_deleted']) - self.assertEqual(request_id, d['request_id']) - self.assertEqual(resource_uuid, d['resource_uuid']) - user_identity = "%s %s %s %s %s" % (user, tenant, domain, - user_domain, project_domain) - self.assertEqual(user_identity, d['user_identity']) + self.assertIn('roles', d) + self.assertIn('user_name', d) + self.assertIn('project_name', d) + self.assertIn('domain_name', d) + self.assertIn('user_domain_name', d) + self.assertIn('project_domain_name', d) + + self.assertEqual(user_name, d['user_name']) + self.assertEqual(project_name, d['project_name']) + self.assertEqual(domain_name, d['domain_name']) + self.assertEqual(user_domain_name, d['user_domain_name']) + self.assertEqual(project_domain_name, d['project_domain_name']) def test_dict_empty_user_identity(self): ctx = context.RequestContext() -- cgit v1.2.1