Merge lp:~niedbalski/charm-helpers/lp1667478-2 into lp:charm-helpers

[Jorge Niedbalski]

This commit adds the following changes:

  1) Support to load a keystone manager from a identityservice context.
  2) The service_exists function ensures that service_type and service_name are
  separated terms to search by.

[lp:~niedbalski/charm-helpers/lp1667478-2]

706. By Jorge Niedbalski on 2017-02-28

Properly test the identityservicecontext class

[Felipe Reyes (freyes)]

LGTM! thanks jorge

review: Approve

[Shane Peters (shaner)]

LGTM

review: Approve

=== modified file 'charmhelpers/contrib/openstack/keystone.py'
--- charmhelpers/contrib/openstack/keystone.py	2017-02-24 21:31:23 +0000
+++ charmhelpers/contrib/openstack/keystone.py	2017-02-28 17:12:23 +0000
@@ -16,6 +16,11 @@
 
 import six
 from charmhelpers.fetch import apt_install
+from charmhelpers.contrib.openstack.context import IdentityServiceContext
+from charmhelpers.core.hookenv import (
+    log,
+    ERROR,
+)
 
 
 def get_api_suffix(api_version):
@@ -24,7 +29,7 @@
     @returns the api suffix formatted according to the given api
     version
     """
-    return 'v2.0' if api_version == 2 else 'v3'
+    return 'v2.0' if api_version in (2, "2.0") else 'v3'
 
 
 def format_endpoint(schema, addr, port, api_version):
@@ -54,23 +59,52 @@
     raise ValueError('No manager found for api version {}'.format(api_version))
 
 
+def get_keystone_manager_from_identity_service_context():
+    """Return a keystonmanager generated from a
+    instance of charmhelpers.contrib.openstack.context.IdentityServiceContext
+    @returns keystonamenager instance
+   """
+    context = IdentityServiceContext()()
+    if not context:
+        msg = "Identity service context cannot be generated"
+        log(msg, level=ERROR)
+        raise ValueError(msg)
+
+    endpoint = format_endpoint(context['service_protocol'],
+                               context['service_host'],
+                               context['service_port'],
+                               context['api_version'])
+
+    if context['api_version'] in (2, "2.0"):
+        api_version = 2
+    else:
+        api_version = 3
+
+    return get_keystone_manager(endpoint, api_version,
+                                username=context['admin_user'],
+                                password=context['admin_password'],
+                                tenant_name=context['admin_tenant_name'])
+
+
 class KeystoneManager(object):
 
-    def resolve_service_id(self, name, service_type=None):
+    def resolve_service_id(self, service_name=None, service_type=None):
         """Find the service_id of a given service"""
         services = [s._info for s in self.api.services.list()]
 
+        service_name = service_name.lower()
         for s in services:
-            if service_type:
-                if (name.lower() == s['name'].lower() and
-                        service_type == s['type']):
-                    return s['id']
-            else:
-                if name.lower() == s['name'].lower():
-                    return s['id']
+            name = s['name'].lower()
+            if service_type and service_name:
+                if (service_name == name and service_type == s['type']):
+                    return s['id']
+            elif service_name and service_name == name:
+                return s['id']
+            elif service_type and service_type == s['type']:
+                return s['id']
         return None
 
-    def service_exists(self, service_name, service_type=None):
+    def service_exists(self, service_name=None, service_type=None):
         """Determine if the given service exists on the service list"""
         return self.resolve_service_id(service_name, service_type) is not None
 
@@ -138,7 +172,7 @@
             auth = v3.Password(auth_url=endpoint,
                                user_id=kwargs.get("username"),
                                password=kwargs.get("password"),
-                               project_id=kwargs.get("tenant_id"))
+                               project_id=kwargs.get("tenant_name"))
             sess = session.Session(auth=auth)
 
         self.api = client.Client(session=sess)

=== modified file 'tests/contrib/openstack/test_keystone_utils.py'
--- tests/contrib/openstack/test_keystone_utils.py	2017-02-24 21:28:56 +0000
+++ tests/contrib/openstack/test_keystone_utils.py	2017-02-28 17:12:23 +0000
@@ -8,6 +8,9 @@
 
 TO_PATCH = [
     'apt_install',
+    "log",
+    "ERROR",
+    "IdentityServiceContext",
 ]
 
 
@@ -40,7 +43,7 @@
             def __iter__(self):
                 class Service(object):
                     _info = {
-                        'type': 'openstack',
+                        'type': 'metering',
                         'name': "ceilometer",
                         'id': "uuid-uuid",
                     }
@@ -49,19 +52,18 @@
         manager = keystone.get_keystone_manager('test-endpoint', 2,
                                                 token="1234")
         manager.api.services.list = PropertyMock(return_value=ServiceList())
-        self.assertTrue(manager.service_exists("ceilometer"))
-        self.assertFalse(manager.service_exists("barbican"))
-        self.assertFalse(manager.service_exists("barbican",
+        self.assertTrue(manager.service_exists(service_name="ceilometer",
+                                               service_type="metering"))
+        self.assertFalse(manager.service_exists(service_name="barbican"))
+        self.assertFalse(manager.service_exists(service_name="barbican",
                                                 service_type="openstack"))
-        self.assertTrue(manager.service_exists("ceilometer",
-                                               service_type="openstack"))
 
     def test_resolve_sevice_id_v3(self):
         class ServiceList(list):
             def __iter__(self):
                 class Service(object):
                     _info = {
-                        'type': 'openstack',
+                        'type': 'metering',
                         'name': "ceilometer",
                         'id': "uuid-uuid",
                     }
@@ -70,12 +72,11 @@
         manager = keystone.get_keystone_manager('test-endpoint', 3,
                                                 token="12345")
         manager.api.services.list = PropertyMock(return_value=ServiceList())
-        self.assertTrue(manager.service_exists("ceilometer"))
-        self.assertFalse(manager.service_exists("barbican"))
-        self.assertFalse(manager.service_exists("barbican",
+        self.assertTrue(manager.service_exists(service_name="ceilometer",
+                                               service_type="metering"))
+        self.assertFalse(manager.service_exists(service_name="barbican"))
+        self.assertFalse(manager.service_exists(service_name="barbican",
                                                 service_type="openstack"))
-        self.assertTrue(manager.service_exists("ceilometer",
-                                               service_type="openstack"))
 
     def test_get_api_suffix(self):
         self.assertEquals(keystone.get_api_suffix(2), "v2.0")
@@ -84,3 +85,38 @@
     def test_format_endpoint(self):
         self.assertEquals(keystone.format_endpoint(
             "http", "10.0.0.5", "5000", 2), "http://10.0.0.5:5000/v2.0/")
+
+    def test_get_keystone_manager_from_identity_service_context(self):
+        class FakeIdentityServiceV2(object):
+            def __call__(self, *args, **kwargs):
+                return {
+                    "service_protocol": "https",
+                    "service_host": "10.5.0.5",
+                    "service_port": "5000",
+                    "api_version": "2.0",
+                    "admin_user": "amdin",
+                    "admin_password": "admin",
+                    "admin_tenant_name": "admin_tenant"
+                }
+
+        self.IdentityServiceContext.return_value = FakeIdentityServiceV2()
+
+        manager = keystone.get_keystone_manager_from_identity_service_context()
+        self.assertIsInstance(manager, keystone.KeystoneManager2)
+
+        class FakeIdentityServiceV3(object):
+            def __call__(self, *args, **kwargs):
+                return {
+                    "service_protocol": "https",
+                    "service_host": "10.5.0.5",
+                    "service_port": "5000",
+                    "api_version": "3",
+                    "admin_user": "amdin",
+                    "admin_password": "admin",
+                    "admin_tenant_name": "admin_tenant"
+                }
+
+        self.IdentityServiceContext.return_value = FakeIdentityServiceV3()
+
+        manager = keystone.get_keystone_manager_from_identity_service_context()
+        self.assertIsInstance(manager, keystone.KeystoneManager3)