Merge pull request #194 from KolibriSolutions/master2

Fix for #117 post_authenticated_signal

Author: peppelinux

djangosaml2/signals.py

@@ -15,4 +15,4 @@
 import django.dispatch
 
 pre_user_save = django.dispatch.Signal(providing_args=['attributes', 'user_modified'])
-post_authenticated = django.dispatch.Signal(providing_args=['session_info'])
+post_authenticated = django.dispatch.Signal(providing_args=['session_info', 'request'])

djangosaml2/tests/__init__.py

@@ -25,13 +25,14 @@
 from django.contrib.auth import SESSION_KEY, get_user_model
 from django.contrib.auth.models import AnonymousUser
 from django.contrib.sessions.middleware import SessionMiddleware
+from django.http.request import HttpRequest
 from django.template import Context, Template
 from django.test import TestCase
 from django.test.client import RequestFactory
 from djangosaml2 import views
 from djangosaml2.cache import OutstandingQueriesCache
 from djangosaml2.conf import get_config
-from djangosaml2.signals import post_authenticated
+from djangosaml2.signals import post_authenticated, pre_user_save
 from djangosaml2.tests import conf
 from djangosaml2.tests.utils import SAMLPostFormParser
 from djangosaml2.tests.auth_response import auth_response
@@ -496,16 +497,51 @@ def _test_metadata(self):
         self.assertEqual(response.content, expected_metadata)
 
     def test_post_authenticated_signal(self):
+        self.called = []
 
-        def signal_handler(signal, user, session_info):
-            self.assertEqual(isinstance(user, User), True)
+        def signal_handler(sender, instance, session_info, request, **kwargs):
+            self.called.append({'sender': sender, 'instance': instance, 'request': request, 'session_info': session_info})
 
         post_authenticated.connect(signal_handler, dispatch_uid='test_signal')
 
         self.do_login()
 
+        # make sure the handler is only called once
+        self.assertEqual(len(self.called), 1)
+        # test 'sender', this should be User.__class__
+        self.assertEqual(self.called[0]['sender'], get_user_model(), 'post_authenticated signal sender is not a User')
+        # test 'instance', this should be User
+        self.assertIsInstance(self.called[0]['instance'], get_user_model(), 'post_authenticated signal did not send a User instance')
+        # test the request
+        self.assertIsInstance(self.called[0]['request'], HttpRequest, 'post_authenticated signal did not send a request')
+        # test the session_info
+        self.assertIsInstance(self.called[0]['session_info'], dict, 'post_authenticated signal did not send a session_info dict')
+
         post_authenticated.disconnect(dispatch_uid='test_signal')
 
+    def test_pre_user_save_signal(self):
+        self.called = []
+
+        def signal_handler(sender, instance, attributes, user_modified, **kwargs):
+            self.called.append({'sender': sender, 'instance': instance, 'attributes': attributes, 'user_modified': user_modified})
+
+        pre_user_save.connect(signal_handler, dispatch_uid='test_signal')
+
+        self.do_login()
+
+        # make sure the handler is only called once
+        self.assertEqual(len(self.called), 1)
+        # test 'sender', this should be User.__class__
+        self.assertEqual(self.called[0]['sender'], get_user_model(), 'pre_user_save signal sender is not a User')
+        # test 'instance', this should be User
+        self.assertIsInstance(self.called[0]['instance'], get_user_model(), 'pre_user_save signal did not send a User instance')
+        # test the attributes
+        self.assertIsInstance(self.called[0]['attributes'], dict, 'pre_user_save signal did not send attributes')
+        # test the user_modified
+        self.assertIsInstance(self.called[0]['user_modified'], bool, 'pre_user_save signal did not send a user_modified bool')
+
+        pre_user_save.disconnect(dispatch_uid='test_signal')
+
     def test_idplist_templatetag(self):
         settings.SAML_CONFIG = conf.create_conf(
             sp_host='sp.example.com',

djangosaml2/views.py

@@ -157,7 +157,7 @@ def login(request,
                                            'its metadata is expired.'))
         if selected_idp is None:
             selected_idp = list(idps.keys())[0]
-    
+
     # choose a binding to try first
     sign_requests = getattr(conf, '_sp_authn_requests_signed', False)
     binding = BINDING_HTTP_POST if sign_requests else BINDING_HTTP_REDIRECT
@@ -348,7 +348,12 @@ def post(self,
         logger.debug("User %s authenticated via SSO.", user)
         logger.debug('Sending the post_authenticated signal')
 
-        post_authenticated.send_robust(sender=user, session_info=session_info)
+        # post_authenticated.send_robust(sender=user, session_info=session_info)
+        # https://github.com/knaperek/djangosaml2/issues/117
+        post_authenticated.send_robust(sender=user.__class__,
+                                       instance=user,
+                                       session_info=session_info,
+                                       request=request)
         self.customize_session(user, session_info)
 
         relay_state = self.build_relay_state()