Make admin_user & admin_client fixtures compatible with custom user models #843
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jnns
force-pushed
the
admin-client-fix
branch
2 times, most recently
from
d1b4335 to
dcf4202
Compare
The previous test setup inherited from AbstractUser thus MyCustomUser still had a username field. The problems people are having when using the admin_client fixture in combination with a custom user model are due to the username field not being present. This change accounts for the more realistic scenario. See these tickets: pytest-dev#246 pytest-dev#484 pytest-dev#748
Relying on `User.USERNAME_FIELD` is enough for light customization and doesn't require `extra_arguments`. Esoteric user models probably need a specially tailored manager anyway and most likely a custom `django_user` fixture that goes with that. See this ticket: pytest-dev#457
"1 passed, 1 warning" wasn't matched before when there was a deprecation warning. Newer Django versions warn about the removal of `django.conf.urls.url` in favor of `django.urls.re_path` but Django 1.11 is also tested against and doesn't support `re_path` yet.
bluetech
requested changes
Oct 9, 2020
There was a problem hiding this comment.
Thanks @jnns! This looks good to me and fixes what seems to be a long-standing issue.
If you could do the following that would be great:
- Fix my one tiny comment.
- Rebase the PR on latest master.
- Add an entry to the changelog (
docs/changelog.rst). - Edit the PR to say "Closes #XXX" on old the old PRs/issues that this fixes, so they're automatically closed once merged.
Comment on lines
+296
to
+298
| username_field: username, | ||
| "email": "admin@example.com", | ||
| "password": "password", |
There was a problem hiding this comment.
In case username_field is email, it should override the email below, so should come after it (even though the values are the same, but just for good measure).
Suggested change
| username_field: username, | |
| "email": "admin@example.com", | |
| "password": "password", | |
| "email": "admin@example.com", | |
| "password": "password", | |
| username_field: username, |
There was a problem hiding this comment.
Thanks for taking the time to review! I will add the requested changes and push again.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using the
admin_clientfixture with a custom user model that doesn't have a username field doesn't work currently. The fixture assumes that the user model always has ausernamefield present. For this case, Django hasUser.USERNAME_FIELDandUser.get_username().Unfortunately, the existing test didn't catch this issue because a custom user model with
User.usernameis used.This pull request changes the test setup to use a custom user without
usernameand makesadmin_clientuseUser.get_username().There are a few merge requests and issues about this problem already. I hope this one meets the requirements to be merged. If not, please let me know and I see what I can do.