12794 change User ref to get_user_model (#12905)

* 12794 change User ref to get_user_model

* 12794 call get_user_model once in tests

* 12794 call get_user_model once in tests

* 12794 use settings.AUTH_USER_MODEL for FK reference

netbox/users/api/nested_serializers.py

@@ -1,4 +1,5 @@
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from django.contrib.contenttypes.models import ContentType
 from drf_spectacular.utils import extend_schema_field
 from drf_spectacular.types import OpenApiTypes
@@ -28,7 +29,7 @@ class NestedUserSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(view_name='users-api:user-detail')
 
     class Meta:
-        model = User
+        model = get_user_model()
         fields = ['id', 'url', 'display', 'username']
 
     @extend_schema_field(OpenApiTypes.STR)

netbox/users/api/serializers.py

@@ -1,5 +1,6 @@
 from django.conf import settings
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from django.contrib.contenttypes.models import ContentType
 from drf_spectacular.utils import extend_schema_field
 from drf_spectacular.types import OpenApiTypes
@@ -30,7 +31,7 @@ class UserSerializer(ValidatedModelSerializer):
     )
 
     class Meta:
-        model = User
+        model = get_user_model()
         fields = (
             'id', 'url', 'display', 'username', 'password', 'first_name', 'last_name', 'email', 'is_staff', 'is_active',
             'date_joined', 'groups',
@@ -124,7 +125,7 @@ class ObjectPermissionSerializer(ValidatedModelSerializer):
         many=True
     )
     users = SerializedPKRelatedField(
-        queryset=User.objects.all(),
+        queryset=get_user_model().objects.all(),
         serializer=NestedUserSerializer,
         required=False,
         many=True

netbox/users/api/views.py

@@ -1,5 +1,6 @@
 from django.contrib.auth import authenticate
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from django.db.models import Count
 from drf_spectacular.utils import extend_schema
 from drf_spectacular.types import OpenApiTypes
@@ -32,7 +33,7 @@ class UsersRootView(APIRootView):
 #
 
 class UserViewSet(NetBoxModelViewSet):
-    queryset = RestrictedQuerySet(model=User).prefetch_related('groups').order_by('username')
+    queryset = RestrictedQuerySet(model=get_user_model()).prefetch_related('groups').order_by('username')
     serializer_class = serializers.UserSerializer
     filterset_class = filtersets.UserFilterSet
 

netbox/users/filtersets.py

@@ -1,5 +1,6 @@
 import django_filters
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from django.db.models import Q
 from django.utils.translation import gettext as _
 
@@ -47,7 +48,7 @@ class UserFilterSet(BaseFilterSet):
     )
 
     class Meta:
-        model = User
+        model = get_user_model()
         fields = ['id', 'username', 'first_name', 'last_name', 'email', 'is_staff', 'is_active']
 
     def search(self, queryset, name, value):
@@ -68,12 +69,12 @@ class TokenFilterSet(BaseFilterSet):
     )
     user_id = django_filters.ModelMultipleChoiceFilter(
         field_name='user',
-        queryset=User.objects.all(),
+        queryset=get_user_model().objects.all(),
         label=_('User'),
     )
     user = django_filters.ModelMultipleChoiceFilter(
         field_name='user__username',
-        queryset=User.objects.all(),
+        queryset=get_user_model().objects.all(),
         to_field_name='username',
         label=_('User (name)'),
     )
@@ -116,12 +117,12 @@ class ObjectPermissionFilterSet(BaseFilterSet):
     )
     user_id = django_filters.ModelMultipleChoiceFilter(
         field_name='users',
-        queryset=User.objects.all(),
+        queryset=get_user_model().objects.all(),
         label=_('User'),
     )
     user = django_filters.ModelMultipleChoiceFilter(
         field_name='users__username',
-        queryset=User.objects.all(),
+        queryset=get_user_model().objects.all(),
         to_field_name='username',
         label=_('User (name)'),
     )

netbox/users/graphql/schema.py

@@ -1,6 +1,7 @@
 import graphene
 
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from netbox.graphql.fields import ObjectField, ObjectListField
 from .types import *
 from utilities.graphql_optimizer import gql_query_optimizer
@@ -17,4 +18,4 @@ class UsersQuery(graphene.ObjectType):
     user_list = ObjectListField(UserType)
 
     def resolve_user_list(root, info, **kwargs):
-        return gql_query_optimizer(User.objects.all(), info)
+        return gql_query_optimizer(get_user_model().objects.all(), info)

netbox/users/graphql/types.py

@@ -1,4 +1,5 @@
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from graphene_django import DjangoObjectType
 
 from users import filtersets
@@ -25,7 +26,7 @@ class GroupType(DjangoObjectType):
 class UserType(DjangoObjectType):
 
     class Meta:
-        model = User
+        model = get_user_model()
         fields = (
             'id', 'username', 'password', 'first_name', 'last_name', 'email', 'is_staff', 'is_active', 'date_joined',
             'groups',
@@ -34,4 +35,4 @@ class UserType(DjangoObjectType):
 
     @classmethod
     def get_queryset(cls, queryset, info):
-        return RestrictedQuerySet(model=User).restrict(info.context.user, 'view')
+        return RestrictedQuerySet(model=get_user_model()).restrict(info.context.user, 'view')

netbox/users/tests/test_api.py

@@ -1,4 +1,5 @@
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from django.contrib.contenttypes.models import ContentType
 from django.urls import reverse
 
@@ -7,6 +8,9 @@ from utilities.testing import APIViewTestCases, APITestCase
 from utilities.utils import deepmerge
 
 
+User = get_user_model()
+
+
 class AppTest(APITestCase):
 
     def test_root(self):

netbox/users/tests/test_filtersets.py

@@ -1,6 +1,7 @@
 import datetime
 
-from django.contrib.auth.models import Group, User
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from django.contrib.contenttypes.models import ContentType
 from django.test import TestCase
 from django.utils.timezone import make_aware
@@ -10,6 +11,9 @@ from users.models import ObjectPermission, Token
 from utilities.testing import BaseFilterSetTests
 
 
+User = get_user_model()
+
+
 class UserTestCase(TestCase, BaseFilterSetTests):
     queryset = User.objects.all()
     filterset = filtersets.UserFilterSet

netbox/users/tests/test_models.py

@@ -1,7 +1,10 @@
-from django.contrib.auth.models import User
+from django.contrib.auth import get_user_model
 from django.test import TestCase
 
 
+User = get_user_model()
+
+
 class UserConfigTest(TestCase):
 
     @classmethod

netbox/users/tests/test_preferences.py

@@ -1,4 +1,4 @@
-from django.contrib.auth.models import User
+from django.contrib.auth import get_user_model
 from django.test import override_settings
 from django.test.client import RequestFactory
 from django.urls import reverse
@@ -16,6 +16,9 @@ DEFAULT_USER_PREFERENCES = {
 }
 
 
+User = get_user_model()
+
+
 class UserPreferencesTest(TestCase):
     user_permissions = ['dcim.view_site']