Use abstract base class for identity driver

Use the abc module for managing abstract base classes in the driver
layer.

bp abstract-base-class-drivers

Change-Id: Ifc3b7c158a3a26ca0295e5e133d0108a357b1e37

keystone/identity/backends/pam.py

@@ -84,15 +84,9 @@ class PamIdentity(identity.Driver):
         # in LDAP backend
         return {'id': user_name, 'name': user_name}
 
-    def get_role(self, role_id):
-        raise NotImplementedError()
-
     def list_users(self):
         raise NotImplementedError()
 
-    def list_roles(self):
-        raise NotImplementedError()
-
     def add_user_to_project(self, tenant_id, user_id):
         pass
 
@@ -102,15 +96,6 @@ class PamIdentity(identity.Driver):
     def list_projects_for_user(self, user_id):
         return [{'id': user_id, 'name': user_id}]
 
-    def get_roles_for_user_and_project(self, user_id, tenant_id):
-        raise NotImplementedError()
-
-    def add_role_to_user_and_project(self, user_id, tenant_id, role_id):
-        raise NotImplementedError()
-
-    def remove_role_from_user_and_project(self, user_id, tenant_id, role_id):
-        raise NotImplementedError()
-
     def create_user(self, user_id, user):
         raise NotImplementedError()
 
@@ -132,11 +117,32 @@ class PamIdentity(identity.Driver):
     def _update_metadata(self, user_id, tenant_id, metadata):
         raise NotImplementedError()
 
-    def create_role(self, role_id, role):
+    def add_user_to_group(self, user_id, group_id):
         raise NotImplementedError()
 
-    def update_role(self, role_id, role):
+    def check_user_in_group(self, user_id, group_id):
         raise NotImplementedError()
 
-    def delete_role(self, role_id):
+    def remove_user_from_group(self, user_id, group_id):
+        raise NotImplementedError()
+
+    def create_group(self, group_id, group):
+        raise NotImplementedError()
+
+    def list_groups(self):
+        raise NotImplementedError()
+
+    def list_groups_for_user(self, user_id):
+        raise NotImplementedError()
+
+    def list_users_in_group(self, group_id):
+        raise NotImplementedError()
+
+    def get_group(self, group_id):
+        raise NotImplementedError()
+
+    def update_group(self, group_id, group):
+        raise NotImplementedError()
+
+    def delete_group(self, group_id):
         raise NotImplementedError()

keystone/identity/core.py

@@ -16,10 +16,12 @@
 
 """Main entry point into the Identity service."""
 
+import abc
 import functools
 import os
 
 from oslo.config import cfg
+import six
 
 from keystone import clean
 from keystone.common import controller
@@ -556,8 +558,11 @@ class Manager(manager.Manager):
         return self.assignment_api.remove_user_from_project(tenant_id, user_id)
 
 
+@six.add_metaclass(abc.ABCMeta)
 class Driver(object):
     """Interface description for an Identity driver."""
+
+    @abc.abstractmethod
     def authenticate(self, user_id, password):
         """Authenticate a given user and password.
         :returns: user_ref
@@ -567,6 +572,7 @@ class Driver(object):
 
     # user crud
 
+    @abc.abstractmethod
     def create_user(self, user_id, user):
         """Creates a new user.
 
@@ -575,6 +581,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_users(self):
         """List all users in the system.
 
@@ -583,6 +590,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_users_in_group(self, group_id):
         """List all users in a group.
 
@@ -591,6 +599,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_user(self, user_id):
         """Get a user by ID.
 
@@ -600,6 +609,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def update_user(self, user_id, user):
         """Updates an existing user.
 
@@ -609,6 +619,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def add_user_to_group(self, user_id, group_id):
         """Adds a user to a group.
 
@@ -618,6 +629,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def check_user_in_group(self, user_id, group_id):
         """Checks if a user is a member of a group.
 
@@ -627,6 +639,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def remove_user_from_group(self, user_id, group_id):
         """Removes a user from a group.
 
@@ -635,6 +648,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def delete_user(self, user_id):
         """Deletes an existing user.
 
@@ -643,6 +657,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_user_by_name(self, user_name, domain_id):
         """Get a user by name.
 
@@ -654,6 +669,7 @@ class Driver(object):
 
     # group crud
 
+    @abc.abstractmethod
     def create_group(self, group_id, group):
         """Creates a new group.
 
@@ -662,6 +678,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_groups(self):
         """List all groups in the system.
 
@@ -670,6 +687,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def list_groups_for_user(self, user_id):
         """List all groups a user is in
 
@@ -678,6 +696,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def get_group(self, group_id):
         """Get a group by ID.
 
@@ -687,6 +706,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def update_group(self, group_id, group):
         """Updates an existing group.
 
@@ -696,6 +716,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def delete_group(self, group_id):
         """Deletes an existing group.
 
@@ -704,6 +725,7 @@ class Driver(object):
         """
         raise exception.NotImplemented()
 
+    @abc.abstractmethod
     def is_domain_aware(self):
         """Indicates if Driver supports domains."""
         raise exception.NotImplemented()

keystone/tests/test_drivers.py

@@ -22,7 +22,6 @@ from keystone import catalog
 from keystone.contrib import endpoint_filter
 from keystone.contrib import oauth1
 from keystone import exception
-from keystone import identity
 from keystone import policy
 from keystone import token
 
@@ -61,10 +60,6 @@ class TestDrivers(testtools.TestCase):
         interface = catalog.Driver()
         self.assertInterfaceNotImplemented(interface)
 
-    def test_identity_driver_unimplemented(self):
-        interface = identity.Driver()
-        self.assertInterfaceNotImplemented(interface)
-
     def test_policy_driver_unimplemented(self):
         interface = policy.Driver()
         self.assertInterfaceNotImplemented(interface)