diff options
Diffstat (limited to 'tests/auth_tests/test_models.py')
| -rw-r--r-- | tests/auth_tests/test_models.py | 330 |
1 files changed, 181 insertions, 149 deletions
diff --git a/tests/auth_tests/test_models.py b/tests/auth_tests/test_models.py index 01f523fdf2..f3fe553c66 100644 --- a/tests/auth_tests/test_models.py +++ b/tests/auth_tests/test_models.py @@ -6,73 +6,74 @@ from django.contrib.auth.backends import ModelBackend from django.contrib.auth.base_user import AbstractBaseUser from django.contrib.auth.hashers import get_hasher from django.contrib.auth.models import ( - AnonymousUser, Group, Permission, User, UserManager, + AnonymousUser, + Group, + Permission, + User, + UserManager, ) from django.contrib.contenttypes.models import ContentType from django.core import mail from django.db import connection, migrations from django.db.migrations.state import ModelState, ProjectState from django.db.models.signals import post_save -from django.test import ( - SimpleTestCase, TestCase, TransactionTestCase, override_settings, -) +from django.test import SimpleTestCase, TestCase, TransactionTestCase, override_settings from .models import CustomEmailField, IntegerUsernameUser class NaturalKeysTestCase(TestCase): - def test_user_natural_key(self): - staff_user = User.objects.create_user(username='staff') - self.assertEqual(User.objects.get_by_natural_key('staff'), staff_user) - self.assertEqual(staff_user.natural_key(), ('staff',)) + staff_user = User.objects.create_user(username="staff") + self.assertEqual(User.objects.get_by_natural_key("staff"), staff_user) + self.assertEqual(staff_user.natural_key(), ("staff",)) def test_group_natural_key(self): - users_group = Group.objects.create(name='users') - self.assertEqual(Group.objects.get_by_natural_key('users'), users_group) + users_group = Group.objects.create(name="users") + self.assertEqual(Group.objects.get_by_natural_key("users"), users_group) class LoadDataWithoutNaturalKeysTestCase(TestCase): - fixtures = ['regular.json'] + fixtures = ["regular.json"] def test_user_is_created_and_added_to_group(self): - user = User.objects.get(username='my_username') - group = Group.objects.get(name='my_group') + user = User.objects.get(username="my_username") + group = Group.objects.get(name="my_group") self.assertEqual(group, user.groups.get()) class LoadDataWithNaturalKeysTestCase(TestCase): - fixtures = ['natural.json'] + fixtures = ["natural.json"] def test_user_is_created_and_added_to_group(self): - user = User.objects.get(username='my_username') - group = Group.objects.get(name='my_group') + user = User.objects.get(username="my_username") + group = Group.objects.get(name="my_group") self.assertEqual(group, user.groups.get()) class LoadDataWithNaturalKeysAndMultipleDatabasesTestCase(TestCase): - databases = {'default', 'other'} + databases = {"default", "other"} def test_load_data_with_user_permissions(self): # Create test contenttypes for both databases default_objects = [ - ContentType.objects.db_manager('default').create( - model='examplemodela', - app_label='app_a', + ContentType.objects.db_manager("default").create( + model="examplemodela", + app_label="app_a", ), - ContentType.objects.db_manager('default').create( - model='examplemodelb', - app_label='app_b', + ContentType.objects.db_manager("default").create( + model="examplemodelb", + app_label="app_b", ), ] other_objects = [ - ContentType.objects.db_manager('other').create( - model='examplemodelb', - app_label='app_b', + ContentType.objects.db_manager("other").create( + model="examplemodelb", + app_label="app_b", ), - ContentType.objects.db_manager('other').create( - model='examplemodela', - app_label='app_a', + ContentType.objects.db_manager("other").create( + model="examplemodela", + app_label="app_a", ), ] @@ -89,15 +90,15 @@ class LoadDataWithNaturalKeysAndMultipleDatabasesTestCase(TestCase): ) perm_default = Permission.objects.get_by_natural_key( - 'delete_examplemodelb', - 'app_b', - 'examplemodelb', + "delete_examplemodelb", + "app_b", + "examplemodelb", ) - perm_other = Permission.objects.db_manager('other').get_by_natural_key( - 'delete_examplemodelb', - 'app_b', - 'examplemodelb', + perm_other = Permission.objects.db_manager("other").get_by_natural_key( + "delete_examplemodelb", + "app_b", + "examplemodelb", ) self.assertEqual(perm_default.content_type_id, default_objects[1].id) @@ -106,59 +107,65 @@ class LoadDataWithNaturalKeysAndMultipleDatabasesTestCase(TestCase): class UserManagerTestCase(TransactionTestCase): available_apps = [ - 'auth_tests', - 'django.contrib.auth', - 'django.contrib.contenttypes', + "auth_tests", + "django.contrib.auth", + "django.contrib.contenttypes", ] def test_create_user(self): - email_lowercase = 'normal@normal.com' - user = User.objects.create_user('user', email_lowercase) + email_lowercase = "normal@normal.com" + user = User.objects.create_user("user", email_lowercase) self.assertEqual(user.email, email_lowercase) - self.assertEqual(user.username, 'user') + self.assertEqual(user.username, "user") self.assertFalse(user.has_usable_password()) def test_create_user_email_domain_normalize_rfc3696(self): # According to https://tools.ietf.org/html/rfc3696#section-3 # the "@" symbol can be part of the local part of an email address - returned = UserManager.normalize_email(r'Abc\@DEF@EXAMPLE.com') - self.assertEqual(returned, r'Abc\@DEF@example.com') + returned = UserManager.normalize_email(r"Abc\@DEF@EXAMPLE.com") + self.assertEqual(returned, r"Abc\@DEF@example.com") def test_create_user_email_domain_normalize(self): - returned = UserManager.normalize_email('normal@DOMAIN.COM') - self.assertEqual(returned, 'normal@domain.com') + returned = UserManager.normalize_email("normal@DOMAIN.COM") + self.assertEqual(returned, "normal@domain.com") def test_create_user_email_domain_normalize_with_whitespace(self): - returned = UserManager.normalize_email(r'email\ with_whitespace@D.COM') - self.assertEqual(returned, r'email\ with_whitespace@d.com') + returned = UserManager.normalize_email(r"email\ with_whitespace@D.COM") + self.assertEqual(returned, r"email\ with_whitespace@d.com") def test_empty_username(self): - with self.assertRaisesMessage(ValueError, 'The given username must be set'): - User.objects.create_user(username='') + with self.assertRaisesMessage(ValueError, "The given username must be set"): + User.objects.create_user(username="") def test_create_user_is_staff(self): - email = 'normal@normal.com' - user = User.objects.create_user('user', email, is_staff=True) + email = "normal@normal.com" + user = User.objects.create_user("user", email, is_staff=True) self.assertEqual(user.email, email) - self.assertEqual(user.username, 'user') + self.assertEqual(user.username, "user") self.assertTrue(user.is_staff) def test_create_super_user_raises_error_on_false_is_superuser(self): - with self.assertRaisesMessage(ValueError, 'Superuser must have is_superuser=True.'): + with self.assertRaisesMessage( + ValueError, "Superuser must have is_superuser=True." + ): User.objects.create_superuser( - username='test', email='test@test.com', - password='test', is_superuser=False, + username="test", + email="test@test.com", + password="test", + is_superuser=False, ) def test_create_superuser_raises_error_on_false_is_staff(self): - with self.assertRaisesMessage(ValueError, 'Superuser must have is_staff=True.'): + with self.assertRaisesMessage(ValueError, "Superuser must have is_staff=True."): User.objects.create_superuser( - username='test', email='test@test.com', - password='test', is_staff=False, + username="test", + email="test@test.com", + password="test", + is_staff=False, ) def test_make_random_password(self): - allowed_chars = 'abcdefg' + allowed_chars = "abcdefg" password = UserManager().make_random_password(5, allowed_chars) self.assertEqual(len(password), 5) for char in password: @@ -166,8 +173,8 @@ class UserManagerTestCase(TransactionTestCase): def test_runpython_manager_methods(self): def forwards(apps, schema_editor): - UserModel = apps.get_model('auth', 'User') - user = UserModel.objects.create_user('user1', password='secure') + UserModel = apps.get_model("auth", "User") + user = UserModel.objects.create_user("user1", password="secure") self.assertIsInstance(user, UserModel) operation = migrations.RunPython(forwards, migrations.RunPython.noop) @@ -178,47 +185,48 @@ class UserManagerTestCase(TransactionTestCase): project_state.add_model(ModelState.from_model(ContentType)) new_state = project_state.clone() with connection.schema_editor() as editor: - operation.state_forwards('test_manager_methods', new_state) + operation.state_forwards("test_manager_methods", new_state) operation.database_forwards( - 'test_manager_methods', + "test_manager_methods", editor, project_state, new_state, ) - user = User.objects.get(username='user1') - self.assertTrue(user.check_password('secure')) + user = User.objects.get(username="user1") + self.assertTrue(user.check_password("secure")) class AbstractBaseUserTests(SimpleTestCase): - def test_has_usable_password(self): """ Passwords are usable even if they don't correspond to a hasher in settings.PASSWORD_HASHERS. """ - self.assertIs(User(password='some-gibbberish').has_usable_password(), True) + self.assertIs(User(password="some-gibbberish").has_usable_password(), True) def test_normalize_username(self): self.assertEqual(IntegerUsernameUser().normalize_username(123), 123) def test_clean_normalize_username(self): # The normalization happens in AbstractBaseUser.clean() - ohm_username = 'iamtheΩ' # U+2126 OHM SIGN - for model in ('auth.User', 'auth_tests.CustomUser'): + ohm_username = "iamtheΩ" # U+2126 OHM SIGN + for model in ("auth.User", "auth_tests.CustomUser"): with self.subTest(model=model), self.settings(AUTH_USER_MODEL=model): User = get_user_model() - user = User(**{User.USERNAME_FIELD: ohm_username, 'password': 'foo'}) + user = User(**{User.USERNAME_FIELD: ohm_username, "password": "foo"}) user.clean() username = user.get_username() self.assertNotEqual(username, ohm_username) - self.assertEqual(username, 'iamtheΩ') # U+03A9 GREEK CAPITAL LETTER OMEGA + self.assertEqual( + username, "iamtheΩ" + ) # U+03A9 GREEK CAPITAL LETTER OMEGA def test_default_email(self): - self.assertEqual(AbstractBaseUser.get_email_field_name(), 'email') + self.assertEqual(AbstractBaseUser.get_email_field_name(), "email") def test_custom_email(self): user = CustomEmailField() - self.assertEqual(user.get_email_field_name(), 'email_address') + self.assertEqual(user.get_email_field_name(), "email_address") class AbstractUserTestCase(TestCase): @@ -231,12 +239,12 @@ class AbstractUserTestCase(TestCase): "connection": None, "html_message": None, } - user = User(email='foo@bar.com') + user = User(email="foo@bar.com") user.email_user( subject="Subject here", message="This is a message", from_email="from@domain.com", - **kwargs + **kwargs, ) self.assertEqual(len(mail.outbox), 1) message = mail.outbox[0] @@ -246,24 +254,26 @@ class AbstractUserTestCase(TestCase): self.assertEqual(message.to, [user.email]) def test_last_login_default(self): - user1 = User.objects.create(username='user1') + user1 = User.objects.create(username="user1") self.assertIsNone(user1.last_login) - user2 = User.objects.create_user(username='user2') + user2 = User.objects.create_user(username="user2") self.assertIsNone(user2.last_login) def test_user_clean_normalize_email(self): - user = User(username='user', password='foo', email='foo@BAR.com') + user = User(username="user", password="foo", email="foo@BAR.com") user.clean() - self.assertEqual(user.email, 'foo@bar.com') + self.assertEqual(user.email, "foo@bar.com") def test_user_double_save(self): """ Calling user.save() twice should trigger password_changed() once. """ - user = User.objects.create_user(username='user', password='foo') - user.set_password('bar') - with mock.patch('django.contrib.auth.password_validation.password_changed') as pw_changed: + user = User.objects.create_user(username="user", password="foo") + user.set_password("bar") + with mock.patch( + "django.contrib.auth.password_validation.password_changed" + ) as pw_changed: user.save() self.assertEqual(pw_changed.call_count, 1) user.save() @@ -275,18 +285,20 @@ class AbstractUserTestCase(TestCase): password_changed() shouldn't be called if User.check_password() triggers a hash iteration upgrade. """ - user = User.objects.create_user(username='user', password='foo') + user = User.objects.create_user(username="user", password="foo") initial_password = user.password - self.assertTrue(user.check_password('foo')) - hasher = get_hasher('default') - self.assertEqual('pbkdf2_sha256', hasher.algorithm) + self.assertTrue(user.check_password("foo")) + hasher = get_hasher("default") + self.assertEqual("pbkdf2_sha256", hasher.algorithm) old_iterations = hasher.iterations try: # Upgrade the password iterations hasher.iterations = old_iterations + 1 - with mock.patch('django.contrib.auth.password_validation.password_changed') as pw_changed: - user.check_password('foo') + with mock.patch( + "django.contrib.auth.password_validation.password_changed" + ) as pw_changed: + user.check_password("foo") self.assertEqual(pw_changed.call_count, 0) self.assertNotEqual(initial_password, user.password) finally: @@ -294,137 +306,154 @@ class AbstractUserTestCase(TestCase): class CustomModelBackend(ModelBackend): - def with_perm(self, perm, is_active=True, include_superusers=True, backend=None, obj=None): - if obj is not None and obj.username == 'charliebrown': + def with_perm( + self, perm, is_active=True, include_superusers=True, backend=None, obj=None + ): + if obj is not None and obj.username == "charliebrown": return User.objects.filter(pk=obj.pk) - return User.objects.filter(username__startswith='charlie') + return User.objects.filter(username__startswith="charlie") class UserWithPermTestCase(TestCase): - @classmethod def setUpTestData(cls): content_type = ContentType.objects.get_for_model(Group) cls.permission = Permission.objects.create( - name='test', content_type=content_type, codename='test', + name="test", + content_type=content_type, + codename="test", ) # User with permission. - cls.user1 = User.objects.create_user('user 1', 'foo@example.com') + cls.user1 = User.objects.create_user("user 1", "foo@example.com") cls.user1.user_permissions.add(cls.permission) # User with group permission. - group1 = Group.objects.create(name='group 1') + group1 = Group.objects.create(name="group 1") group1.permissions.add(cls.permission) - group2 = Group.objects.create(name='group 2') + group2 = Group.objects.create(name="group 2") group2.permissions.add(cls.permission) - cls.user2 = User.objects.create_user('user 2', 'bar@example.com') + cls.user2 = User.objects.create_user("user 2", "bar@example.com") cls.user2.groups.add(group1, group2) # Users without permissions. - cls.user_charlie = User.objects.create_user('charlie', 'charlie@example.com') - cls.user_charlie_b = User.objects.create_user('charliebrown', 'charlie@brown.com') + cls.user_charlie = User.objects.create_user("charlie", "charlie@example.com") + cls.user_charlie_b = User.objects.create_user( + "charliebrown", "charlie@brown.com" + ) # Superuser. cls.superuser = User.objects.create_superuser( - 'superuser', 'superuser@example.com', 'superpassword', + "superuser", + "superuser@example.com", + "superpassword", ) # Inactive user with permission. cls.inactive_user = User.objects.create_user( - 'inactive_user', 'baz@example.com', is_active=False, + "inactive_user", + "baz@example.com", + is_active=False, ) cls.inactive_user.user_permissions.add(cls.permission) def test_invalid_permission_name(self): - msg = 'Permission name should be in the form app_label.permission_codename.' - for perm in ('nodots', 'too.many.dots', '...', ''): + msg = "Permission name should be in the form app_label.permission_codename." + for perm in ("nodots", "too.many.dots", "...", ""): with self.subTest(perm), self.assertRaisesMessage(ValueError, msg): User.objects.with_perm(perm) def test_invalid_permission_type(self): - msg = 'The `perm` argument must be a string or a permission instance.' - for perm in (b'auth.test', object(), None): + msg = "The `perm` argument must be a string or a permission instance." + for perm in (b"auth.test", object(), None): with self.subTest(perm), self.assertRaisesMessage(TypeError, msg): User.objects.with_perm(perm) def test_invalid_backend_type(self): - msg = 'backend must be a dotted import path string (got %r).' - for backend in (b'auth_tests.CustomModelBackend', object()): + msg = "backend must be a dotted import path string (got %r)." + for backend in (b"auth_tests.CustomModelBackend", object()): with self.subTest(backend): with self.assertRaisesMessage(TypeError, msg % backend): - User.objects.with_perm('auth.test', backend=backend) + User.objects.with_perm("auth.test", backend=backend) def test_basic(self): active_users = [self.user1, self.user2] tests = [ ({}, [*active_users, self.superuser]), - ({'obj': self.user1}, []), + ({"obj": self.user1}, []), # Only inactive users. - ({'is_active': False}, [self.inactive_user]), + ({"is_active": False}, [self.inactive_user]), # All users. - ({'is_active': None}, [*active_users, self.superuser, self.inactive_user]), + ({"is_active": None}, [*active_users, self.superuser, self.inactive_user]), # Exclude superusers. - ({'include_superusers': False}, active_users), + ({"include_superusers": False}, active_users), ( - {'include_superusers': False, 'is_active': False}, + {"include_superusers": False, "is_active": False}, [self.inactive_user], ), ( - {'include_superusers': False, 'is_active': None}, + {"include_superusers": False, "is_active": None}, [*active_users, self.inactive_user], ), ] for kwargs, expected_users in tests: - for perm in ('auth.test', self.permission): + for perm in ("auth.test", self.permission): with self.subTest(perm=perm, **kwargs): self.assertCountEqual( User.objects.with_perm(perm, **kwargs), expected_users, ) - @override_settings(AUTHENTICATION_BACKENDS=['django.contrib.auth.backends.BaseBackend']) + @override_settings( + AUTHENTICATION_BACKENDS=["django.contrib.auth.backends.BaseBackend"] + ) def test_backend_without_with_perm(self): - self.assertSequenceEqual(User.objects.with_perm('auth.test'), []) + self.assertSequenceEqual(User.objects.with_perm("auth.test"), []) def test_nonexistent_permission(self): - self.assertSequenceEqual(User.objects.with_perm('auth.perm'), [self.superuser]) + self.assertSequenceEqual(User.objects.with_perm("auth.perm"), [self.superuser]) def test_nonexistent_backend(self): with self.assertRaises(ImportError): User.objects.with_perm( - 'auth.test', - backend='invalid.backend.CustomModelBackend', + "auth.test", + backend="invalid.backend.CustomModelBackend", ) - @override_settings(AUTHENTICATION_BACKENDS=['auth_tests.test_models.CustomModelBackend']) + @override_settings( + AUTHENTICATION_BACKENDS=["auth_tests.test_models.CustomModelBackend"] + ) def test_custom_backend(self): - for perm in ('auth.test', self.permission): + for perm in ("auth.test", self.permission): with self.subTest(perm): self.assertCountEqual( User.objects.with_perm(perm), [self.user_charlie, self.user_charlie_b], ) - @override_settings(AUTHENTICATION_BACKENDS=['auth_tests.test_models.CustomModelBackend']) + @override_settings( + AUTHENTICATION_BACKENDS=["auth_tests.test_models.CustomModelBackend"] + ) def test_custom_backend_pass_obj(self): - for perm in ('auth.test', self.permission): + for perm in ("auth.test", self.permission): with self.subTest(perm): self.assertSequenceEqual( User.objects.with_perm(perm, obj=self.user_charlie_b), [self.user_charlie_b], ) - @override_settings(AUTHENTICATION_BACKENDS=[ - 'auth_tests.test_models.CustomModelBackend', - 'django.contrib.auth.backends.ModelBackend', - ]) + @override_settings( + AUTHENTICATION_BACKENDS=[ + "auth_tests.test_models.CustomModelBackend", + "django.contrib.auth.backends.ModelBackend", + ] + ) def test_multiple_backends(self): msg = ( - 'You have multiple authentication backends configured and ' - 'therefore must provide the `backend` argument.' + "You have multiple authentication backends configured and " + "therefore must provide the `backend` argument." ) with self.assertRaisesMessage(ValueError, msg): - User.objects.with_perm('auth.test') + User.objects.with_perm("auth.test") - backend = 'auth_tests.test_models.CustomModelBackend' + backend = "auth_tests.test_models.CustomModelBackend" self.assertCountEqual( - User.objects.with_perm('auth.test', backend=backend), + User.objects.with_perm("auth.test", backend=backend), [self.user_charlie, self.user_charlie_b], ) @@ -435,7 +464,7 @@ class IsActiveTestCase(TestCase): """ def test_builtin_user_isactive(self): - user = User.objects.create(username='foo', email='foo@bar.com') + user = User.objects.create(username="foo", email="foo@bar.com") # is_active is true by default self.assertIs(user.is_active, True) user.is_active = False @@ -444,13 +473,13 @@ class IsActiveTestCase(TestCase): # the is_active flag is saved self.assertFalse(user_fetched.is_active) - @override_settings(AUTH_USER_MODEL='auth_tests.IsActiveTestUser1') + @override_settings(AUTH_USER_MODEL="auth_tests.IsActiveTestUser1") def test_is_active_field_default(self): """ tests that the default value for is_active is provided """ UserModel = get_user_model() - user = UserModel(username='foo') + user = UserModel(username="foo") self.assertIs(user.is_active, True) # you can set the attribute - but it will not save user.is_active = False @@ -465,6 +494,7 @@ class TestCreateSuperUserSignals(TestCase): """ Simple test case for ticket #20541 """ + def post_save_listener(self, *args, **kwargs): self.signals_count += 1 @@ -492,8 +522,8 @@ class AnonymousUserTests(SimpleTestCase): def test_properties(self): self.assertIsNone(self.user.pk) - self.assertEqual(self.user.username, '') - self.assertEqual(self.user.get_username(), '') + self.assertEqual(self.user.username, "") + self.assertEqual(self.user.get_username(), "") self.assertIs(self.user.is_anonymous, True) self.assertIs(self.user.is_authenticated, False) self.assertIs(self.user.is_staff, False) @@ -505,19 +535,19 @@ class AnonymousUserTests(SimpleTestCase): self.assertEqual(self.user.get_group_permissions(), set()) def test_str(self): - self.assertEqual(str(self.user), 'AnonymousUser') + self.assertEqual(str(self.user), "AnonymousUser") def test_eq(self): self.assertEqual(self.user, AnonymousUser()) - self.assertNotEqual(self.user, User('super', 'super@example.com', 'super')) + self.assertNotEqual(self.user, User("super", "super@example.com", "super")) def test_hash(self): self.assertEqual(hash(self.user), 1) def test_int(self): msg = ( - 'Cannot cast AnonymousUser to int. Are you trying to use it in ' - 'place of User?' + "Cannot cast AnonymousUser to int. Are you trying to use it in " + "place of User?" ) with self.assertRaisesMessage(TypeError, msg): int(self.user) @@ -532,20 +562,22 @@ class AnonymousUserTests(SimpleTestCase): def test_set_password(self): with self.assertRaisesMessage(NotImplementedError, self.no_repr_msg): - self.user.set_password('password') + self.user.set_password("password") def test_check_password(self): with self.assertRaisesMessage(NotImplementedError, self.no_repr_msg): - self.user.check_password('password') + self.user.check_password("password") class GroupTests(SimpleTestCase): def test_str(self): - g = Group(name='Users') - self.assertEqual(str(g), 'Users') + g = Group(name="Users") + self.assertEqual(str(g), "Users") class PermissionTests(TestCase): def test_str(self): - p = Permission.objects.get(codename='view_customemailfield') - self.assertEqual(str(p), 'auth_tests | custom email field | Can view custom email field') + p = Permission.objects.get(codename="view_customemailfield") + self.assertEqual( + str(p), "auth_tests | custom email field | Can view custom email field" + ) |