From fd2e85be29c9693a479f3b9ff657a95541569856 Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug.hellmann@dreamhost.com>
Date: Sun, 6 Oct 2013 12:41:06 -0400
Subject: [PATCH] Use abstract base class for assignment driver

Use the abc module for managing abstract base classes in the driver
layer and add missing methods to concrete classes.

bp abstract-base-class-drivers

Change-Id: I91b20ff2f7fd591ea51da619a76044907a7f0c76
---
 keystone/assignment/backends/kvs.py  | 16 ++++++++++++++
 keystone/assignment/backends/ldap.py | 26 ++++++++++++++++++++++
 keystone/assignment/core.py          | 32 ++++++++++++++++++++++++++++
 keystone/tests/test_drivers.py       |  5 -----
 4 files changed, 74 insertions(+), 5 deletions(-)

diff --git a/keystone/assignment/backends/kvs.py b/keystone/assignment/backends/kvs.py
index b50ba49770..0d1f93fae6 100644
--- a/keystone/assignment/backends/kvs.py
+++ b/keystone/assignment/backends/kvs.py
@@ -499,3 +499,19 @@ class Assignment(kvs.Base, assignment.Driver):
         domain_list = set(self.db.get('domain_list', []))
         domain_list.remove(domain_id)
         self.db.set('domain_list', list(domain_list))
+
+    def delete_user(self, user_id):
+        """Deletes all assignments for a user.
+
+        :raises: keystone.exception.RoleNotFound
+
+        """
+        raise exception.NotImplemented()
+
+    def delete_group(self, group_id):
+        """Deletes all assignments for a group.
+
+        :raises: keystone.exception.RoleNotFound
+
+        """
+        raise exception.NotImplemented()
diff --git a/keystone/assignment/backends/ldap.py b/keystone/assignment/backends/ldap.py
index 851f9ec7bd..1eb21ee210 100644
--- a/keystone/assignment/backends/ldap.py
+++ b/keystone/assignment/backends/ldap.py
@@ -259,6 +259,32 @@ class Assignment(assignment.Driver):
                 finally:
                     conn.unbind_s()
 
+    def create_grant(self, role_id, user_id=None, group_id=None,
+                     domain_id=None, project_id=None,
+                     inherited_to_projects=False):
+        raise exception.NotImplemented()
+
+    def get_grant(self, role_id, user_id=None, group_id=None,
+                  domain_id=None, project_id=None,
+                  inherited_to_projects=False):
+        raise exception.NotImplemented()
+
+    def delete_grant(self, role_id, user_id=None, group_id=None,
+                     domain_id=None, project_id=None,
+                     inherited_to_projects=False):
+        raise exception.NotImplemented()
+
+    def list_grants(self, user_id=None, group_id=None,
+                    domain_id=None, project_id=None,
+                    inherited_to_projects=False):
+        raise exception.NotImplemented()
+
+    def get_domain_by_name(self, domain_name):
+        raise exception.NotImplemented()
+
+    def list_role_assignments(self):
+        raise exception.NotImplemented()
+
 
 # TODO(termie): turn this into a data object and move logic to driver
 class ProjectApi(common_ldap.EnabledEmuMixIn, common_ldap.BaseLdap):
diff --git a/keystone/assignment/core.py b/keystone/assignment/core.py
index 0876d8287d..71a1a3e596 100644
--- a/keystone/assignment/core.py
+++ b/keystone/assignment/core.py
@@ -16,6 +16,9 @@
 
 """Main entry point into the assignment service."""
 
+import abc
+
+import six
 
 from keystone import clean
 from keystone.common import cache
@@ -327,6 +330,7 @@ class Manager(manager.Manager):
                 if r['role_id'] == role_id]
 
 
+@six.add_metaclass(abc.ABCMeta)
 class Driver(object):
 
     def _role_to_dict(self, role_id, inherited):
@@ -363,6 +367,7 @@ class Driver(object):
                                                      inherited).items()))
         return [dict(r) for r in role_set]
 
+    @abc.abstractmethod
     def get_project_by_name(self, tenant_name, domain_id):
         """Get a tenant by name.
 
@@ -372,6 +377,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_user_ids_for_project(self, tenant_id):
         """Lists all user IDs with a role assignment in the specified project.
 
@@ -381,6 +387,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def add_role_to_user_and_project(self, user_id, tenant_id, role_id):
         """Add a role to a user within given tenant.
 
@@ -390,6 +397,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def remove_role_from_user_and_project(self, user_id, tenant_id, role_id):
         """Remove a role from a user within given tenant.
 
@@ -402,6 +410,7 @@ class Driver(object):
 
     # assignment/grant crud
 
+    @abc.abstractmethod
     def create_grant(self, role_id, user_id=None, group_id=None,
                      domain_id=None, project_id=None,
                      inherited_to_projects=False):
@@ -421,6 +430,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_grants(self, user_id=None, group_id=None,
                     domain_id=None, project_id=None,
                     inherited_to_projects=False):
@@ -436,6 +446,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_grant(self, role_id, user_id=None, group_id=None,
                   domain_id=None, project_id=None,
                   inherited_to_projects=False):
@@ -451,6 +462,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def delete_grant(self, role_id, user_id=None, group_id=None,
                      domain_id=None, project_id=None,
                      inherited_to_projects=False):
@@ -466,11 +478,13 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_role_assignments(self):
 
         raise exception.NotImplemented()
 
     # domain crud
+    @abc.abstractmethod
     def create_domain(self, domain_id, domain):
         """Creates a new domain.
 
@@ -479,6 +493,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_domains(self):
         """List all domains in the system.
 
@@ -487,6 +502,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_domain(self, domain_id):
         """Get a domain by ID.
 
@@ -496,6 +512,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_domain_by_name(self, domain_name):
         """Get a domain by name.
 
@@ -505,6 +522,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def update_domain(self, domain_id, domain):
         """Updates an existing domain.
 
@@ -514,6 +532,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def delete_domain(self, domain_id):
         """Deletes an existing domain.
 
@@ -523,6 +542,7 @@ class Driver(object):
         raise exception.NotImplemented()
 
     # project crud
+    @abc.abstractmethod
     def create_project(self, project_id, project):
         """Creates a new project.
 
@@ -531,6 +551,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_projects(self, domain_id=None):
         """List all projects in the system.
 
@@ -539,6 +560,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_projects_for_user(self, user_id, group_ids):
         """List all projects associated with a given user.
 
@@ -552,6 +574,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_project(self, project_id):
         """Get a project by ID.
 
@@ -561,6 +584,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def update_project(self, project_id, project):
         """Updates an existing project.
 
@@ -570,6 +594,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def delete_project(self, project_id):
         """Deletes an existing project.
 
@@ -581,6 +606,7 @@ class Driver(object):
     """Interface description for an assignment driver."""
     # role crud
 
+    @abc.abstractmethod
     def create_role(self, role_id, role):
         """Creates a new role.
 
@@ -589,6 +615,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_roles(self):
         """List all roles in the system.
 
@@ -597,6 +624,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_role(self, role_id):
         """Get a role by ID.
 
@@ -606,6 +634,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def update_role(self, role_id, role):
         """Updates an existing role.
 
@@ -615,6 +644,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def delete_role(self, role_id):
         """Deletes an existing role.
 
@@ -624,6 +654,7 @@ class Driver(object):
         raise exception.NotImplemented()
 
 #TODO(ayoung): determine what else these two functions raise
+    @abc.abstractmethod
     def delete_user(self, user_id):
         """Deletes all assignments for a user.
 
@@ -632,6 +663,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def delete_group(self, group_id):
         """Deletes all assignments for a group.
 
diff --git a/keystone/tests/test_drivers.py b/keystone/tests/test_drivers.py
index 95532388e1..a01e268ac9 100644
--- a/keystone/tests/test_drivers.py
+++ b/keystone/tests/test_drivers.py
@@ -17,7 +17,6 @@
 import inspect
 import testtools
 
-from keystone import assignment
 from keystone import catalog
 from keystone.contrib import endpoint_filter
 from keystone.contrib import oauth1
@@ -52,10 +51,6 @@ class TestDrivers(testtools.TestCase):
             if name[0] != '_' and callable(method):
                 self.assertMethodNotImplemented(method)
 
-    def test_assignment_driver_unimplemented(self):
-        interface = assignment.Driver()
-        self.assertInterfaceNotImplemented(interface)
-
     def test_catalog_driver_unimplemented(self):
         interface = catalog.Driver()
         self.assertInterfaceNotImplemented(interface)