Start replacing test_user with staff_user

Author: matthewelwell

api/conftest.py

@@ -12,7 +12,7 @@
     VIEW_ENVIRONMENT,
     VIEW_IDENTITIES,
 )
-from common.projects.permissions import VIEW_PROJECT
+from common.projects.permissions import CREATE_ENVIRONMENT, VIEW_PROJECT
 from django.contrib.contenttypes.models import ContentType
 from django.core.cache import caches
 from django.db.backends.base.creation import TEST_DATABASE_PREFIX
@@ -27,7 +27,6 @@
 from pytest_django.fixtures import SettingsWrapper
 from pytest_django.plugin import blocking_manager_key
 from pytest_mock import MockerFixture
-from rest_framework.authtoken.models import Token
 from rest_framework.test import APIClient
 from task_processor.task_run_method import TaskRunMethod
 from urllib3 import BaseHTTPResponse
@@ -217,16 +216,6 @@ def urlopen_mock(  # type: ignore[no-untyped-def]
 trait_value = "value1"
 
 
-@pytest.fixture()
-def test_user(django_user_model):  # type: ignore[no-untyped-def]
-    return django_user_model.objects.create(email="user@example.com")
-
-
-@pytest.fixture()
-def auth_token(test_user):  # type: ignore[no-untyped-def]
-    return Token.objects.create(user=test_user)
-
-
 @pytest.fixture()
 def admin_client_original(admin_user):  # type: ignore[no-untyped-def]
     client = APIClient()
@@ -254,12 +243,6 @@ def admin_client(admin_client_original):  # type: ignore[no-untyped-def]
     yield admin_client_original
 
 
-@pytest.fixture()
-def test_user_client(api_client, test_user):  # type: ignore[no-untyped-def]
-    api_client.force_authenticate(test_user)
-    return api_client
-
-
 @pytest.fixture()
 def staff_user(django_user_model):  # type: ignore[no-untyped-def]
     """
@@ -804,28 +787,41 @@ def create_project_permission(db):  # type: ignore[no-untyped-def]
     return PermissionModel.objects.get(key=CREATE_PROJECT)
 
 
+@pytest.fixture()
+def create_environment_permission(db: None) -> PermissionModel:
+    return PermissionModel.objects.get(key=CREATE_ENVIRONMENT)
+
+
 @pytest.fixture()
 def manage_segment_overrides_permission(db: None) -> PermissionModel:
     return PermissionModel.objects.get(key=MANAGE_SEGMENT_OVERRIDES)
 
 
 @pytest.fixture()
-def user_environment_permission(test_user, environment):  # type: ignore[no-untyped-def]
+def user_environment_permission(
+    staff_user: FFAdminUser,
+    environment: Environment,
+) -> UserEnvironmentPermission:
     return UserEnvironmentPermission.objects.create(
-        user=test_user, environment=environment
+        user=staff_user, environment=environment
     )
 
 
 @pytest.fixture()
-def user_environment_permission_group(test_user, user_permission_group, environment):  # type: ignore[no-untyped-def]
+def user_environment_permission_group(
+    user_permission_group: UserPermissionGroup,
+    environment: Environment,
+) -> UserPermissionGroupEnvironmentPermission:
     return UserPermissionGroupEnvironmentPermission.objects.create(
         group=user_permission_group, environment=environment
     )
 
 
 @pytest.fixture()
-def user_project_permission(test_user, project):  # type: ignore[no-untyped-def]
-    return UserProjectPermission.objects.create(user=test_user, project=project)
+def user_project_permission(
+    staff_user: FFAdminUser, project: Project
+) -> UserProjectPermission:
+    return UserProjectPermission.objects.create(user=staff_user, project=project)
 
 
 @pytest.fixture()

api/tests/integration/custom_auth/end_to_end/test_custom_auth_integration.py

@@ -574,20 +574,19 @@ def test_get_user_is_not_throttled(  # type: ignore[no-untyped-def]
         assert response.status_code == status.HTTP_200_OK
 
 
-def test_delete_token(test_user, auth_token):  # type: ignore[no-untyped-def]
+def test_delete_token(staff_client: APIClient) -> None:
     # Given
     url = reverse("api-v1:custom_auth:delete-token")
-    client = APIClient(HTTP_AUTHORIZATION=f"Token {auth_token.key}")
 
     # When
-    response = client.delete(url)
+    response = staff_client.delete(url)
 
     # Then
     assert response.status_code == status.HTTP_204_NO_CONTENT
 
     # and - if we try to delete the token again(i.e: access anything that uses is_authenticated)
-    # we should will get 401
-    assert client.delete(url).status_code == status.HTTP_401_UNAUTHORIZED
+    # we will get 401
+    assert staff_client.delete(url).status_code == status.HTTP_401_UNAUTHORIZED
 
 
 def test_register_with_sign_up_type(client, db, settings):  # type: ignore[no-untyped-def]

api/tests/integration/features/feature_health/test_views.py

@@ -89,7 +89,7 @@ def test_feature_health_providers__delete__expected_response(
 def test_feature_health_events__dismiss__unauthorized__expected_response(
     project: int,
     unhealthy_feature_health_event: int,
-    test_user_client: APIClient,
+    staff_client: APIClient,
 ) -> None:
     # Given
     feature_health_events_dismiss_url = reverse(
@@ -98,7 +98,7 @@ def test_feature_health_events__dismiss__unauthorized__expected_response(
     )
 
     # When
-    response = test_user_client.post(feature_health_events_dismiss_url)
+    response = staff_client.post(feature_health_events_dismiss_url)
 
     # Then
     assert response.status_code == 403

api/tests/unit/custom_auth/test_tasks.py

@@ -1,28 +1,29 @@
 from datetime import timedelta
 
 from django.utils import timezone
+from freezegun.api import FrozenDateTimeFactory
 from pytest_django.fixtures import SettingsWrapper
 
 from custom_auth.models import UserPasswordResetRequest
 from custom_auth.tasks import clean_up_user_password_reset_request
 from users.models import FFAdminUser
 
 
-def test_clean_up_user_password_reset_request(  # type: ignore[no-untyped-def]
-    settings: SettingsWrapper, test_user: FFAdminUser, freezer
-):
+def test_clean_up_user_password_reset_request(
+    settings: SettingsWrapper, staff_user: FFAdminUser, freezer: FrozenDateTimeFactory
+) -> None:
     # Given
     settings.PASSWORD_RESET_EMAIL_COOLDOWN = 10
     now = timezone.now()
 
     # A user password reset request should be deleted
-    UserPasswordResetRequest.objects.create(user=test_user)
+    UserPasswordResetRequest.objects.create(user=staff_user)
 
     freezer.move_to(now + timedelta(seconds=11))
 
     # A user password reset request should not be deleted
     new_user_password_reset_request = UserPasswordResetRequest.objects.create(
-        user=test_user
+        user=staff_user
     )
     # When
     clean_up_user_password_reset_request()

api/tests/unit/environments/test_unit_environments_views.py

@@ -5,9 +5,6 @@
     TAG_SUPPORTED_PERMISSIONS,
     VIEW_ENVIRONMENT,
 )
-from common.projects.permissions import (
-    CREATE_ENVIRONMENT,
-)
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.urls import reverse
@@ -29,7 +26,8 @@
 from features.versioning.models import EnvironmentFeatureVersion
 from metadata.models import Metadata, MetadataModelField
 from organisations.models import Organisation
-from projects.models import Project
+from permissions.models import PermissionModel
+from projects.models import Project, UserProjectPermission
 from segments.models import Condition, Segment, SegmentRule
 from tests.types import WithEnvironmentPermissionsCallable
 from users.models import FFAdminUser
@@ -131,20 +129,20 @@ def test_user_with_view_environment_permission_can_retrieve_environment(
     assert response.status_code == status.HTTP_200_OK
 
 
-def test_can_clone_environment_with_create_environment_permission(  # type: ignore[no-untyped-def]
-    test_user,
-    test_user_client,
-    environment,
-    user_project_permission,
+def test_can_clone_environment_with_create_environment_permission(
+    staff_client: APIClient,
+    environment: Environment,
+    user_project_permission: UserProjectPermission,
+    create_environment_permission: PermissionModel,
 ) -> None:
     # Given
     env_name = "Cloned env"
-    user_project_permission.permissions.add(CREATE_ENVIRONMENT)
+    user_project_permission.permissions.add(create_environment_permission)
 
     url = reverse("api-v1:environments:environment-clone", args=[environment.api_key])
 
     # When
-    response = test_user_client.post(url, {"name": env_name})
+    response = staff_client.post(url, {"name": env_name})
 
     # Then
     assert response.status_code == status.HTTP_200_OK

api/tests/unit/integrations/launch_darkly/conftest.py

@@ -59,13 +59,13 @@ def ld_client_class_mock(
 def import_request(
     ld_client_class_mock: MagicMock,
     project: Project,
-    test_user: FFAdminUser,
+    staff_user: FFAdminUser,
     ld_project_key: str,
     ld_token: str,
 ) -> LaunchDarklyImportRequest:
     return create_import_request(
         project=project,
-        user=test_user,
+        user=staff_user,
         ld_project_key=ld_project_key,
         ld_token=ld_token,
     )

api/tests/unit/integrations/launch_darkly/test_services.py

@@ -30,18 +30,18 @@ def test_create_import_request__return_expected(
     ld_client_mock: MagicMock,
     ld_client_class_mock: MagicMock,
     project: Project,
-    test_user: FFAdminUser,
+    staff_user: FFAdminUser,
 ) -> None:
     # Given
     ld_project_key = "test-project-key"
     ld_token = "test-token"
 
-    expected_salt = f"ld_import_{test_user.id}"
+    expected_salt = f"ld_import_{staff_user.id}"
 
     # When
     result = create_import_request(
         project=project,
-        user=test_user,
+        user=staff_user,
         ld_project_key=ld_project_key,
         ld_token=ld_token,
     )
@@ -58,7 +58,7 @@ def test_create_import_request__return_expected(
     }
     assert signing.loads(result.ld_token, salt=expected_salt) == ld_token
     assert result.ld_project_key == ld_project_key
-    assert result.created_by == test_user
+    assert result.created_by == staff_user
     assert result.project == project
 
 

api/tests/unit/organisations/invites/conftest.py

@@ -1,15 +1,23 @@
 import pytest
 
 from organisations.invites.models import Invite, InviteLink
+from organisations.models import Organisation
+from users.models import FFAdminUser
 
 
 @pytest.fixture()
-def invite_link(organisation):  # type: ignore[no-untyped-def]
-    return InviteLink.objects.create(organisation=organisation)
+def invite_link(organisation: Organisation) -> InviteLink:
+    _invite_link: InviteLink = InviteLink.objects.create(organisation=organisation)
+    return _invite_link
 
 
 @pytest.fixture()
-def invite(organisation, admin_user, test_user):  # type: ignore[no-untyped-def]
-    return Invite.objects.create(
-        organisation=organisation, email=test_user.email, invited_by=admin_user
+def invite(
+    organisation: Organisation,
+    admin_user: FFAdminUser,
+    staff_user: FFAdminUser,
+) -> Invite:
+    _invite: Invite = Invite.objects.create(
+        organisation=organisation, email=staff_user.email, invited_by=admin_user
     )
+    return _invite

api/tests/unit/organisations/invites/test_unit_invites_views.py

@@ -153,11 +153,15 @@ def test_update_invite_link_returns_405(invite_link, admin_client, organisation)
     assert response.status_code == status.HTTP_405_METHOD_NOT_ALLOWED
 
 
-def test_join_organisation_with_permission_groups(  # type: ignore[no-untyped-def]
-    test_user, test_user_client, organisation, user_permission_group, subscription
-):
+def test_join_organisation_with_permission_groups(
+    staff_user: FFAdminUser,
+    staff_client: APIClient,
+    organisation: Organisation,
+    user_permission_group: UserPermissionGroup,
+    subscription: Subscription,
+) -> None:
     # Given
-    invite = Invite.objects.create(email=test_user.email, organisation=organisation)
+    invite = Invite.objects.create(email=staff_user.email, organisation=organisation)
     invite.permission_groups.add(user_permission_group)
 
     # update subscription to add another seat
@@ -168,14 +172,14 @@ def test_join_organisation_with_permission_groups(  # type: ignore[no-untyped-de
     data = {"hubspotutk": "somehubspotdata"}
 
     # When
-    response = test_user_client.post(url, data)
-    test_user.refresh_from_db()
+    response = staff_client.post(url, data)
+    staff_user.refresh_from_db()
 
     # Then
     assert response.status_code == status.HTTP_200_OK
 
-    assert organisation in test_user.organisations.all()
-    assert user_permission_group in test_user.permission_groups.all()
+    assert organisation in staff_user.organisations.all()
+    assert user_permission_group in staff_user.permission_groups.all()
     # and invite is deleted
     with pytest.raises(Invite.DoesNotExist):
         invite.refresh_from_db()