Added dummy identity provider to remove Keystone dependancy during testing

esi_leap/api/controllers/v1/event.py

@@ -21,7 +21,7 @@
 from esi_leap.api.controllers import types
 from esi_leap.api.controllers.v1 import utils
 from esi_leap.common import exception
-from esi_leap.common import keystone
+from esi_leap.common import idp
 import esi_leap.conf
 from esi_leap.objects import event as event_obj
 from esi_leap.resource_objects import get_resource_object
@@ -82,9 +82,7 @@ def get_all(
             lessee_or_owner_id = cdict["project_id"]
 
         if lessee_or_owner_id is not None:
-            lessee_or_owner_id = keystone.get_project_uuid_from_ident(
-                lessee_or_owner_id
-            )
+            lessee_or_owner_id = idp.get_project_uuid_from_ident(lessee_or_owner_id)
 
         if resource_uuid is not None:
             if resource_type is None:

esi_leap/api/controllers/v1/lease.py

@@ -26,7 +26,7 @@
 from esi_leap.common import constants
 from esi_leap.common import exception
 from esi_leap.common import ironic
-from esi_leap.common import keystone
+from esi_leap.common import idp
 from esi_leap.common import statuses
 import esi_leap.conf
 from esi_leap.objects import lease as lease_obj
@@ -88,7 +88,7 @@ def get_one(self, lease_id):
             request, "esi_leap:lease:get", lease_id
         )
 
-        return Lease(**utils.lease_get_dict_with_added_info(lease))
+        return Lease(**self._lease_get_dict_with_added_info(lease))
 
     @wsme_pecan.wsexpose(
         LeaseCollection,
@@ -120,10 +120,10 @@ def get_all(
         cdict = request.to_policy_values()
 
         if project_id is not None:
-            project_id = keystone.get_project_uuid_from_ident(project_id)
+            project_id = idp.get_project_uuid_from_ident(project_id)
 
         if owner_id is not None:
-            owner_id = keystone.get_project_uuid_from_ident(owner_id)
+            owner_id = idp.get_project_uuid_from_ident(owner_id)
 
         if resource_uuid is not None:
             if resource_type is None:
@@ -156,13 +156,13 @@ def get_all(
 
             with concurrent.futures.ThreadPoolExecutor() as executor:
                 f1 = executor.submit(ironic.get_node_list)
-                f2 = executor.submit(keystone.get_project_list)
+                f2 = executor.submit(idp.get_project_list)
                 node_list = f1.result()
                 project_list = f2.result()
 
             leases_with_added_info = [
                 Lease(
-                    **utils.lease_get_dict_with_added_info(
+                    **self._lease_get_dict_with_added_info(
                         lease, project_list, node_list
                     )
                 )
@@ -196,7 +196,7 @@ def post(self, new_lease):
         lease_dict["resource_uuid"] = resource.get_uuid()
 
         if "project_id" in lease_dict:
-            lease_dict["project_id"] = keystone.get_project_uuid_from_ident(
+            lease_dict["project_id"] = idp.get_project_uuid_from_ident(
                 lease_dict["project_id"]
             )
 
@@ -231,7 +231,7 @@ def post(self, new_lease):
 
         lease = lease_obj.Lease(**lease_dict)
         lease.create(request)
-        return Lease(**utils.lease_get_dict_with_added_info(lease))
+        return Lease(**self._lease_get_dict_with_added_info(lease))
 
     @wsme_pecan.wsexpose(Lease, wtypes.text, body={wtypes.text: wtypes.text})
     def patch(self, lease_uuid, patch=None):
@@ -252,7 +252,7 @@ def patch(self, lease_uuid, patch=None):
         updates = {"end_time": new_end_time}
         lease.update(updates, request)
 
-        return Lease(**utils.lease_get_dict_with_added_info(lease))
+        return Lease(**self._lease_get_dict_with_added_info(lease))
 
     @wsme_pecan.wsexpose(Lease, wtypes.text)
     def delete(self, lease_id):
@@ -339,3 +339,15 @@ def _lease_get_all_authorize_filters(
                 del filters[k]
 
         return filters
+
+    @staticmethod
+    def _lease_get_dict_with_added_info(lease, project_list=None, node_list=None):
+        resource = lease.resource_object()
+
+        lease_dict = lease.to_dict()
+        lease_dict["project"] = idp.get_project_name(lease.project_id, project_list)
+        lease_dict["owner"] = idp.get_project_name(lease.owner_id, project_list)
+        lease_dict["resource"] = resource.get_name(node_list)
+        lease_dict["resource_class"] = resource.get_resource_class(node_list)
+        lease_dict["resource_properties"] = resource.get_properties(node_list)
+        return lease_dict

esi_leap/api/controllers/v1/node.py

@@ -21,7 +21,7 @@
 from esi_leap.api.controllers import base
 from esi_leap.api.controllers import types
 from esi_leap.common import ironic
-from esi_leap.common import keystone
+from esi_leap.common import idp
 from esi_leap.common import statuses
 import esi_leap.conf
 from esi_leap.objects import lease as lease_obj
@@ -83,9 +83,9 @@ def get_all(self, resource_class=None, owner=None, lessee=None):
         context = pecan.request.context
 
         if owner is not None:
-            owner = keystone.get_project_uuid_from_ident(owner)
+            owner = idp.get_project_uuid_from_ident(owner)
         if lessee is not None:
-            lessee = keystone.get_project_uuid_from_ident(lessee)
+            lessee = idp.get_project_uuid_from_ident(lessee)
 
         filter_args = {
             "resource_class": resource_class,
@@ -99,7 +99,7 @@ def get_all(self, resource_class=None, owner=None, lessee=None):
         with concurrent.futures.ThreadPoolExecutor() as executor:
             filter_args = {k: v for k, v in filter_args.items() if v is not None}
             f1 = executor.submit(ironic.get_node_list, context, **filter_args)
-            f2 = executor.submit(keystone.get_project_list)
+            f2 = executor.submit(idp.get_project_list)
             nodes = f1.result()
             project_list = f2.result()
 
@@ -139,8 +139,8 @@ def get_all(self, resource_class=None, owner=None, lessee=None):
                 resource_class=node.resource_class,
                 properties=ironic.get_condensed_properties(node.properties),
                 maintenance=str(node.maintenance),
-                owner=keystone.get_project_name(node.owner, project_list),
-                lessee=keystone.get_project_name(node.lessee, project_list),
+                owner=idp.get_project_name(node.owner, project_list),
+                lessee=idp.get_project_name(node.lessee, project_list),
                 future_offers=f_offer_uuids,
                 future_leases=f_lease_uuids,
             )

esi_leap/api/controllers/v1/offer.py

@@ -26,7 +26,7 @@
 from esi_leap.api.controllers.v1 import utils
 from esi_leap.common import exception
 from esi_leap.common import ironic
-from esi_leap.common import keystone
+from esi_leap.common import idp
 from esi_leap.common import statuses
 import esi_leap.conf
 from esi_leap.objects import lease as lease_obj
@@ -91,7 +91,7 @@ def get_one(self, offer_id):
         )
         utils.check_offer_lessee(cdict, offer)
 
-        o = utils.offer_get_dict_with_added_info(offer)
+        o = self._offer_get_dict_with_added_info(offer)
 
         return Offer(**o)
 
@@ -124,7 +124,7 @@ def get_all(
         utils.policy_authorize("esi_leap:offer:get_all", cdict, cdict)
 
         if project_id is not None:
-            project_id = keystone.get_project_uuid_from_ident(project_id)
+            project_id = idp.get_project_uuid_from_ident(project_id)
 
         if resource_uuid is not None:
             if resource_type is None:
@@ -193,13 +193,13 @@ def get_all(
             node_list = None
             with concurrent.futures.ThreadPoolExecutor() as executor:
                 f1 = executor.submit(ironic.get_node_list)
-                f2 = executor.submit(keystone.get_project_list)
+                f2 = executor.submit(idp.get_project_list)
                 node_list = f1.result()
                 project_list = f2.result()
 
             offers_with_added_info = [
                 Offer(
-                    **utils.offer_get_dict_with_added_info(o, project_list, node_list)
+                    **self._offer_get_dict_with_added_info(o, project_list, node_list)
                 )
                 for o in offers
             ]
@@ -231,7 +231,7 @@ def post(self, new_offer):
         offer_dict["resource_uuid"] = resource.get_uuid()
 
         if "lessee_id" in offer_dict:
-            offer_dict["lessee_id"] = keystone.get_project_uuid_from_ident(
+            offer_dict["lessee_id"] = idp.get_project_uuid_from_ident(
                 offer_dict["lessee_id"]
             )
 
@@ -263,7 +263,7 @@ def post(self, new_offer):
 
         o = offer_obj.Offer(**offer_dict)
         o.create()
-        return Offer(**utils.offer_get_dict_with_added_info(o))
+        return Offer(**self._offer_get_dict_with_added_info(o))
 
     @wsme_pecan.wsexpose(Offer, wtypes.text)
     def delete(self, offer_id):
@@ -321,4 +321,19 @@ def claim(self, offer_uuid, new_lease):
 
         new_lease = lease_obj.Lease(**lease_dict)
         new_lease.create(request)
-        return lease.Lease(**utils.lease_get_dict_with_added_info(new_lease))
+        return lease.Lease(
+            **lease.LeasesController._lease_get_dict_with_added_info(new_lease)
+        )
+
+    @staticmethod
+    def _offer_get_dict_with_added_info(offer, project_list=None, node_list=None):
+        resource = offer.resource_object()
+
+        o = offer.to_dict()
+        o["availabilities"] = offer.get_availabilities()
+        o["project"] = idp.get_project_name(offer.project_id, project_list)
+        o["lessee"] = idp.get_project_name(offer.lessee_id, project_list)
+        o["resource"] = resource.get_name(node_list)
+        o["resource_class"] = resource.get_resource_class(node_list)
+        o["resource_properties"] = resource.get_properties(node_list)
+        return o

esi_leap/api/controllers/v1/utils.py

@@ -16,7 +16,7 @@
 import datetime
 
 from esi_leap.common import exception
-from esi_leap.common import keystone
+from esi_leap.common import idp
 from esi_leap.common import policy
 from esi_leap.objects import lease as lease_obj
 from esi_leap.objects import offer as offer_obj
@@ -148,37 +148,12 @@ def check_offer_lessee(cdict, offer):
     if offer.lessee_id is None or offer.project_id == project_id:
         return
 
-    if offer.lessee_id not in keystone.get_parent_project_id_tree(project_id):
+    if offer.lessee_id not in idp.get_parent_project_id_tree(project_id):
         resource_policy_authorize(
             "esi_leap:offer:offer_admin", cdict, cdict, "offer", offer.uuid
         )
 
 
-def offer_get_dict_with_added_info(offer, project_list=None, node_list=None):
-    resource = offer.resource_object()
-
-    o = offer.to_dict()
-    o["availabilities"] = offer.get_availabilities()
-    o["project"] = keystone.get_project_name(offer.project_id, project_list)
-    o["lessee"] = keystone.get_project_name(offer.lessee_id, project_list)
-    o["resource"] = resource.get_name(node_list)
-    o["resource_class"] = resource.get_resource_class(node_list)
-    o["resource_properties"] = resource.get_properties(node_list)
-    return o
-
-
-def lease_get_dict_with_added_info(lease, project_list=None, node_list=None):
-    resource = lease.resource_object()
-
-    lease_dict = lease.to_dict()
-    lease_dict["project"] = keystone.get_project_name(lease.project_id, project_list)
-    lease_dict["owner"] = keystone.get_project_name(lease.owner_id, project_list)
-    lease_dict["resource"] = resource.get_name(node_list)
-    lease_dict["resource_class"] = resource.get_resource_class(node_list)
-    lease_dict["resource_properties"] = resource.get_properties(node_list)
-    return lease_dict
-
-
 def check_lease_length(cdict, start_time, end_time, max_time):
     if (end_time - start_time) > datetime.timedelta(days=max_time):
         # Check if the current project is admin

esi_leap/common/keystone.py → esi_leap/common/idp.py

@@ -10,38 +10,40 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-from keystoneauth1 import loading as ks_loading
-from keystoneclient import client as keystone_client
 from oslo_utils import uuidutils
 
 from esi_leap.common import exception
 import esi_leap.conf
+from esi_leap.common.idp_clients import baseIDP
+from esi_leap.common.idp_clients import keystoneIDP  # noqa: F401
+from esi_leap.common.idp_clients import dummyIDP  # noqa: F401
 
 
 CONF = esi_leap.conf.CONF
-_cached_keystone_client = None
+IDP_TYPE_MAP = {idp.idp_type: idp for idp in baseIDP.BaseIDP.__subclasses__()}
+_cached_idp_client = None
 _cached_project_list = None
 
 
-def get_keystone_client():
-    global _cached_keystone_client
-    if _cached_keystone_client is not None:
-        return _cached_keystone_client
+def get_idp_client():
+    global _cached_idp_client
+    if _cached_idp_client is not None:
+        return _cached_idp_client
 
-    auth_plugin = ks_loading.load_auth_from_conf_options(CONF, "keystone")
-    sess = ks_loading.load_session_from_conf_options(CONF, "keystone", auth=auth_plugin)
-    cli = keystone_client.Client(session=sess)
-    _cached_keystone_client = cli
+    # Get Client config option
+    idp_type = CONF.esi.idp_type
+    cli = IDP_TYPE_MAP[idp_type]()
+    _cached_idp_client = cli
 
     return cli
 
 
 def get_parent_project_id_tree(project_id):
-    ks_client = get_keystone_client()
-    project = ks_client.projects.get(project_id)
+    idp = get_idp_client()
+    project = idp.get_projects(project_id)
     project_ids = [project.id]
     while project.parent_id is not None:
-        project = ks_client.projects.get(project.parent_id)
+        project = idp.get_projects(project.parent_id)
         project_ids.append(project.id)
     return project_ids
 
@@ -50,21 +52,21 @@ def get_project_uuid_from_ident(project_ident):
     if uuidutils.is_uuid_like(project_ident):
         return project_ident
     else:
-        projects = get_keystone_client().projects.list(name=project_ident)
+        projects = get_idp_client().list_projects(name=project_ident)
         if len(projects) > 0:
             # projects have unique names
             return projects[0].id
         raise exception.ProjectNoSuchName(name=project_ident)
 
 
 def get_project_list():
-    return get_keystone_client().projects.list()
+    return get_idp_client().list_projects()
 
 
 def get_project_name(project_id, project_list=None):
     if project_id:
         if project_list is None:
-            project = get_keystone_client().projects.get(project_id)
+            project = get_idp_client().get_projects(project_id)
         else:
             project = next(
                 (p for p in project_list if getattr(p, "id") == project_id), None

esi_leap/common/idp_clients/baseIDP.py

@@ -0,0 +1,23 @@
+#    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.
+
+import abc
+
+
+class BaseIDP(abc.ABC):
+    @abc.abstractmethod
+    def get_projects(self, project_id):
+        pass
+
+    @abc.abstractmethod
+    def list_projects(self, **kwargs):
+        pass