add testing

Author: mhindery

djangosaml2/backends.py

@@ -45,6 +45,8 @@ def get_saml_user_model():
 
 
 def get_django_user_lookup_attribute(userModel) -> str:
+    """ Returns the attribute on which to match the identifier with for the user lookup
+    """
     if hasattr(settings, 'SAML_DJANGO_USER_MAIN_ATTRIBUTE'):
         return settings.SAML_DJANGO_USER_MAIN_ATTRIBUTE
     return getattr(userModel, 'USERNAME_FIELD', 'username')
@@ -128,10 +130,8 @@ def get_or_create_user(self, user_lookup_key, user_lookup_value, create_unknown_
         try:
             user = UserModel.objects.get(**user_query_args)
         except MultipleObjectsReturned:
-            logger.error("Multiple users match, lookup: %s", user_query_args)
+            logger.error("Multiple users match, model: %s, lookup: %s", str(UserModel._meta), user_query_args)
         except UserModel.DoesNotExist:
-            logger.error('The user does not exist, lookup: %s', user_query_args)
-
             # Create new one if desired by settings
             if create_unknown_user:
                 try:
@@ -141,6 +141,8 @@ def get_or_create_user(self, user_lookup_key, user_lookup_value, create_unknown_
 
                 if created:
                     logger.debug('New user created: %s', user)
+            else:
+                logger.error('The user does not exist, model: %s, lookup: %s', str(UserModel._meta), user_query_args)
 
         return user, created
 

tests/testprofiles/tests.py

@@ -19,6 +19,7 @@
 from django.contrib.auth import get_user_model
 from django.contrib.auth.models import User as DjangoUserModel
 from django.test import TestCase, override_settings
+from .models import TestUser
 from djangosaml2.backends import (Saml2Backend,
                                   get_django_user_lookup_attribute,
                                   get_saml_user_model)
@@ -158,17 +159,77 @@ def test_django_user_main_attribute(self):
         with override_settings(SAML_DJANGO_USER_MAIN_ATTRIBUTE='foo'):
             self.assertEqual(get_django_user_lookup_attribute(get_saml_user_model()), 'foo')
 
-    def test_django_user_main_attribute_lookup(self):
+    def test_get_or_create_user_existing(self):
         backend = Saml2Backend()
 
-        # self.assertEqual(backend.get_django_user_main_attribute_lookup(), '')
+        TestUser.objects.create(username='john')
 
-        # TODO: test with acual user so he can be matched
-        # with override_settings(
-        #         SAML_DJANGO_USER_MAIN_ATTRIBUTE_LOOKUP='__iexact'):
-        #     self.assertEqual(
-        #         backend.get_django_user_main_attribute_lookup(),
-        #         '__iexact')
+        with override_settings(SAML_USER_MODEL='testprofiles.TestUser'):
+            john, created = backend.get_or_create_user(
+                get_django_user_lookup_attribute(get_saml_user_model()),
+                'john',
+                False,
+            )
+
+        self.assertTrue(isinstance(john, TestUser))
+        self.assertFalse(created)
+
+    def test_get_or_create_user_duplicates(self):
+        backend = Saml2Backend()
+
+        TestUser.objects.create(username='john', age=1)
+        TestUser.objects.create(username='paul', age=1)
+
+        with self.assertLogs('djangosaml2', level='DEBUG') as logs:
+            with override_settings(SAML_USER_MODEL='testprofiles.TestUser'):
+                john, created = backend.get_or_create_user(
+                    'age',
+                    1,
+                    False,
+                )
+
+        self.assertTrue(john is None)
+        self.assertFalse(created)
+        self.assertIn(
+            "ERROR:djangosaml2:Multiple users match, model: testprofiles.testuser, lookup: {'age': 1}",
+            logs.output,
+        )
+
+    def test_get_or_create_user_no_create(self):
+        backend = Saml2Backend()
+
+        with self.assertLogs('djangosaml2', level='DEBUG') as logs:
+            with override_settings(SAML_USER_MODEL='testprofiles.TestUser'):
+                john, created = backend.get_or_create_user(
+                    get_django_user_lookup_attribute(get_saml_user_model()),
+                    'john',
+                    False,
+                )
+
+        self.assertTrue(john is None)
+        self.assertFalse(created)
+        self.assertIn(
+            "ERROR:djangosaml2:The user does not exist, model: testprofiles.testuser, lookup: {'username': 'john'}",
+            logs.output,
+        )
+
+    def test_get_or_create_user_create(self):
+        backend = Saml2Backend()
+
+        with self.assertLogs('djangosaml2', level='DEBUG') as logs:
+            with override_settings(SAML_USER_MODEL='testprofiles.TestUser'):
+                john, created = backend.get_or_create_user(
+                    get_django_user_lookup_attribute(get_saml_user_model()),
+                    'john',
+                    True,
+                )
+
+        self.assertTrue(isinstance(john, TestUser))
+        self.assertTrue(created)
+        self.assertIn(
+            f"DEBUG:djangosaml2:New user created: {john}",
+            logs.output,
+        )
 
 
 class LowerCaseSaml2Backend(Saml2Backend):