Merge pull request #2321 from django-oscar/fix/auth_backend_signature

Fix EmailBackend.authenticate() signature for Django 1.11.

docs/source/releases/v1.5.rst

@@ -44,6 +44,8 @@ These methods/modules have been removed:
    alternative.
  - ``oscar.test.decorators`` module.
  - ``oscar.core.utils.compose`` function.
+ - ``oscar.apps.customer.auth_backends.Emailbackend``. Use
+   ``oscar.apps.customer.auth_backends.EmailBackend`` instead.
 
 
 .. _silk: https://github.com/django-silk/silk

src/oscar/apps/customer/auth_backends.py

@@ -1,5 +1,6 @@
 import warnings
 
+import django
 from django.contrib.auth.backends import ModelBackend
 from django.core.exceptions import ImproperlyConfigured
 
@@ -22,7 +23,7 @@ class EmailBackend(ModelBackend):
     For this to work, the User model must have an 'email' field
     """
 
-    def authenticate(self, email=None, password=None, *args, **kwargs):
+    def _authenticate(self, request, email=None, password=None, *args, **kwargs):
         if email is None:
             if 'username' not in kwargs or kwargs['username'] is None:
                 return None
@@ -55,14 +56,11 @@ class EmailBackend(ModelBackend):
                 "password")
         return None
 
-
-# Deprecated since Oscar 1.0 because of the spelling.
-class Emailbackend(EmailBackend):
-
-    def __init__(self):
-        warnings.warn(
-            "Oscar's auth backend EmailBackend has been renamed in Oscar 1.0 "
-            " and you're using the old name of Emailbackend. Please rename "
-            " all references; most likely in the AUTH_BACKENDS setting.",
-            DeprecationWarning)
-        super(Emailbackend, self).__init__()
+    # The signature of the authenticate method changed in Django 1.11 to include
+    # a mandatory `request` argument.
+    if django.VERSION < (1, 11):
+        def authenticate(self, email=None, password=None, *args, **kwargs):
+            return self._authenticate(None, email, password, *args, **kwargs)
+    else:
+        def authenticate(self, *args, **kwargs):
+            return self._authenticate(*args, **kwargs)

tests/integration/customer/test_auth_backend.py

@@ -0,0 +1,26 @@
+import unittest
+
+import django
+from django.test import TestCase
+
+from oscar.apps.customer.auth_backends import EmailBackend
+from oscar.test.factories import UserFactory
+
+
+class AuthBackendTestCase(TestCase):
+
+    def setUp(self):
+        self.user = UserFactory(email='foo@example.com', is_staff=True)
+        self.user.set_password('letmein')
+        self.user.save()
+        self.backend = EmailBackend()
+
+    @unittest.skipUnless(django.VERSION < (1, 11), "for Django <1.11 only")
+    def test_authentication_method_signature_pre_django_1_11(self):
+        auth_result = self.backend.authenticate('foo@example.com', 'letmein')
+        self.assertEqual(auth_result, self.user)
+
+    @unittest.skipUnless(django.VERSION >= (1, 11), "for Django >=1.11 only")
+    def test_authentication_method_signature_post_django_1_11(self):
+        auth_result = self.backend.authenticate(None, 'foo@example.com', 'letmein')
+        self.assertEqual(auth_result, self.user)