Relax LOGIN_DEFAULT_SESSION_AUTHENTICATION_BACKEND setting (#196)

apragacz · Sep 20, 2022 · ac43874 · ac43874
1 parent 89a42c3
commit ac43874
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 8 deletions.
diff --git a/rest_registration/settings_fields.py b/rest_registration/settings_fields.py
@@ -231,14 +231,14 @@ def __new__(
     ),
     Field(
         'LOGIN_DEFAULT_SESSION_AUTHENTICATION_BACKEND',
-        default='django.contrib.auth.backends.ModelBackend',
+        default=None,
         help=dedent("""\
             This setting allows to override the backend used in the login function.
 
             It may be useful if Django ``AUTHENTICATION_BACKENDS`` setting
             does contain multiple values.
 
-            The value must be a dotted import path string.
+            The value must be a dotted import path string or ``None``.
             """),
     )
 ]

diff --git a/rest_registration/utils/auth_backends.py b/rest_registration/utils/auth_backends.py
@@ -9,7 +9,9 @@
     from django.contrib.auth.base_user import AbstractBaseUser
 
 
-def get_login_authentication_backend(user: Optional['AbstractBaseUser'] = None) -> str:
+def get_login_authentication_backend(
+    user: Optional['AbstractBaseUser'] = None
+) -> Optional[str]:
     if user and hasattr(user, 'backend'):
         return user.backend  # type: ignore
     backends = settings.AUTHENTICATION_BACKENDS
@@ -18,7 +20,7 @@ def get_login_authentication_backend(user: Optional['AbstractBaseUser'] = None)
         raise ImproperlyConfigured("No AUTHENTICATION_BACKENDS specified")
     if len(backends) == 1:
         return backends[0]
-    if default_login_backend not in backends:
+    if default_login_backend is not None and default_login_backend not in backends:
         raise ImproperlyConfigured(
             "LOGIN_DEFAULT_SESSION_AUTHENTICATION_BACKEND"
             " is not in AUTHENTICATION_BACKENDS")

diff --git a/tests/test_checks.py b/tests/test_checks.py
@@ -353,11 +353,23 @@ def test_when_authtokenmanager_does_not_implement_methods_then_check_fails():
         'django.contrib.auth.backends.RemoteUserBackend',
     ],
 )
-def test_when_multiple_auth_backends_then_check_succeeds():
+def test_ok_when_multiple_auth_backends():
+    errors = simulate_checks()
+    assert_error_codes_match(errors, [])
+
+
+@override_rest_registration_settings({
+    'LOGIN_DEFAULT_SESSION_AUTHENTICATION_BACKEND': 'django.contrib.auth.backends.RemoteUserBackend',  # noqa: E501
+})
+@override_settings(
+    AUTHENTICATION_BACKENDS=[
+        'django.contrib.auth.backends.ModelBackend',
+        'django.contrib.auth.backends.RemoteUserBackend',
+    ],
+)
+def test_ok_when_login_auth_backend_in_multiple_auth_backends():
     errors = simulate_checks()
     assert_error_codes_match(errors, [])
-    expected_messages = set()
-    assert {e.msg for e in errors} == expected_messages
 
 
 @override_rest_registration_settings({
@@ -369,7 +381,7 @@ def test_when_multiple_auth_backends_then_check_succeeds():
         'django.contrib.auth.backends.RemoteUserBackend',
     ],
 )
-def test_when_login_auth_backend_not_in_multiple_auth_backends_then_check_fails():
+def test_fail_when_login_auth_backend_not_in_multiple_auth_backends():
     errors = simulate_checks()
     assert_error_codes_match(errors, [
         ErrorCode.INVALID_AUTH_BACKENDS_CONFIG,