Merge remote-tracking branch 'github/main' into feat/hide-code-references-querying-under-flag

Author: emyller

api/tests/integration/api_keys/test_viewset.py

@@ -5,7 +5,9 @@
 from organisations.models import Organisation
 
 
-def test_create_master_api_key_returns_key_in_response(admin_client, organisation):  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_create_master_api_key__valid_data__returns_key_in_response(  # type: ignore[no-untyped-def]
+    admin_client, organisation
+):
     # Given
     url = reverse(
         "api-v1:organisations:organisation-master-api-keys-list",
@@ -22,7 +24,7 @@ def test_create_master_api_key_returns_key_in_response(admin_client, organisatio
     assert response.json()["is_admin"] is True
 
 
-def test_creating_non_admin_master_api_key_without_rbac_returns_400(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_create_master_api_key__non_admin_without_rbac__returns_400(  # type: ignore[no-untyped-def]
     admin_client, organisation, settings
 ):
     # Given
@@ -44,7 +46,9 @@ def test_creating_non_admin_master_api_key_without_rbac_returns_400(  # type: ig
     ]
 
 
-def test_delete_master_api_key(admin_client, organisation, admin_master_api_key_prefix):  # type: ignore[no-untyped-def]  # noqa: E501,FT003
+def test_delete_master_api_key__existing_key__returns_204(  # type: ignore[no-untyped-def]
+    admin_client, organisation, admin_master_api_key_prefix
+):  # noqa: E501
     # Given
     url = reverse(
         "api-v1:organisations:organisation-master-api-keys-detail",
@@ -58,7 +62,7 @@ def test_delete_master_api_key(admin_client, organisation, admin_master_api_key_
     assert response.status_code == status.HTTP_204_NO_CONTENT
 
 
-def test_list_master_api_keys(  # noqa: FT003
+def test_list_master_api_keys__active_key_exists__returns_key(
     admin_client: APIClient,
     organisation: int,
     admin_master_api_key_prefix: str,
@@ -79,7 +83,7 @@ def test_list_master_api_keys(  # noqa: FT003
     assert response.json()["results"][0]["has_expired"] is False
 
 
-def test_list_master_api_keys__when_expired(  # noqa: FT003
+def test_list_master_api_keys__when_expired__returns_has_expired_true(
     admin_client: APIClient,
     organisation: Organisation,
     expired_api_key_prefix: str,
@@ -100,7 +104,7 @@ def test_list_master_api_keys__when_expired(  # noqa: FT003
     assert response.json()["results"][0]["has_expired"] is True
 
 
-def test_retrieve_master_api_key(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_retrieve_master_api_key__existing_key__returns_key_details(  # type: ignore[no-untyped-def]
     admin_client, organisation, admin_master_api_key_prefix
 ):
     # Given
@@ -117,7 +121,7 @@ def test_retrieve_master_api_key(  # type: ignore[no-untyped-def]  # noqa: FT003
     assert response.json()["prefix"] == admin_master_api_key_prefix
 
 
-def test_update_master_api_key(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_update_master_api_key__rbac_installed__updates_fields(  # type: ignore[no-untyped-def]
     admin_client, organisation, admin_master_api_key_prefix, settings
 ):
     # Given
@@ -147,7 +151,7 @@ def test_update_master_api_key(  # type: ignore[no-untyped-def]  # noqa: FT003
     assert response.json()["is_admin"] is False
 
 
-def test_update_master_api_key_is_admin_returns_400_if_rbac_is_not_installed(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_update_master_api_key__rbac_not_installed__returns_400(  # type: ignore[no-untyped-def]
     admin_client, organisation, admin_master_api_key_prefix, settings
 ):
     # Given
@@ -175,7 +179,9 @@ def test_update_master_api_key_is_admin_returns_400_if_rbac_is_not_installed(  #
     ]
 
 
-def test_api_returns_403_if_user_is_not_the_org_admin(non_admin_client, organisation):  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_list_master_api_keys__non_admin_user__returns_403(  # type: ignore[no-untyped-def]
+    non_admin_client, organisation
+):
     # Given
     url = reverse(
         "api-v1:organisations:organisation-master-api-keys-list",
@@ -188,7 +194,9 @@ def test_api_returns_403_if_user_is_not_the_org_admin(non_admin_client, organisa
     assert response.status_code == status.HTTP_403_FORBIDDEN
 
 
-def test_create_master_api_key_ignores_organisation_in_body(admin_client, organisation):  # type: ignore[no-untyped-def]  # noqa: E501,FT003
+def test_create_master_api_key__wrong_org_in_body__uses_url_org(  # type: ignore[no-untyped-def]
+    admin_client, organisation
+):
     # Given
     list_create_url = reverse(
         "api-v1:organisations:organisation-master-api-keys-list",
@@ -216,7 +224,7 @@ def test_create_master_api_key_ignores_organisation_in_body(admin_client, organi
     assert key.startswith(list_response_json["results"][0]["prefix"])
 
 
-def test_deleted_api_key_is_not_returned_in_list_and_cannot_be_used(  # noqa: FT003
+def test_delete_master_api_key__after_deletion__not_listed_and_unusable(
     admin_client: APIClient,
     organisation: int,
     admin_master_api_key_client: APIClient,

api/tests/integration/app_analytics/test_influx_query_throttle.py

@@ -4,7 +4,7 @@
 from rest_framework.test import APIClient
 
 
-def test_influx_data_endpoint_is_throttled(  # noqa: FT003
+def test_influx_data_endpoint__rate_limit_exceeded__returns_throttled(
     admin_client: APIClient,
     organisation: int,
     mocker: MockerFixture,

api/tests/integration/audit/test_audit_logs.py

@@ -29,24 +29,27 @@ def _subscription_metadata(mocker: MockerFixture) -> None:
     )
 
 
-def test_get_audit_logs_makes_expected_queries(  # type: ignore[no-untyped-def]  # noqa: FT003,FT004
+def test_list_audit_logs__with_project_filter__makes_expected_queries(  # type: ignore[no-untyped-def]
     admin_client,
     project,
     environment,
     feature,
     feature_state,
     django_assert_num_queries,
 ):
+    # Given
     url = reverse("api-v1:audit-list")
 
+    # When
     with django_assert_num_queries(3):
         res = admin_client.get(url, {"project": project})
 
+    # Then
     assert res.status_code == status.HTTP_200_OK
     assert res.json()["count"] == 3
 
 
-def test_retrieve_audit_log_for_environment_change(  # noqa: FT003,FT004
+def test_retrieve_audit_log__environment_change__includes_change_details(
     admin_client: APIClient,
     project: int,
     environment_api_key: str,
@@ -81,14 +84,16 @@ def test_retrieve_audit_log_for_environment_change(  # noqa: FT003,FT004
         "api-v1:audit-detail", args=[environment_update_result["id"]]
     )
     retrieve_response = admin_client.get(retrieve_audit_log_url)
+
+    # Then
     retrieve_response_json = retrieve_response.json()
     assert len(retrieve_response_json["change_details"]) == 1
     assert retrieve_response_json["change_details"][0]["field"] == "name"
     assert retrieve_response_json["change_details"][0]["new"] == new_name
     assert retrieve_response_json["change_details"][0]["old"] == environment_name
 
 
-def test_retrieve_audit_log_for_feature_state_enabled_change(  # noqa: FT003
+def test_retrieve_audit_log__feature_state_enabled_change__includes_change_details(
     admin_client: APIClient,
     environment_api_key: str,
     environment: int,
@@ -132,7 +137,7 @@ def test_retrieve_audit_log_for_feature_state_enabled_change(  # noqa: FT003
     assert retrieve_response_json["change_details"][0]["old"] is False
 
 
-def test_creates_audit_log_for_feature_state_update(  # noqa: FT003
+def test_create_audit_log_from_historical_record__feature_state_update__creates_correct_log(
     admin_client: APIClient,
     admin_user: FFAdminUser,
     environment_api_key: str,
@@ -170,7 +175,7 @@ def test_creates_audit_log_for_feature_state_update(  # noqa: FT003
         ("Asia/Tokyo", "Y年n月j日 H:i (T)", "2199年4月15日 21:30 (JST)"),
     ],
 )
-def test_creates_audit_log_for_scheduled_feature_state_update(  # noqa: FT003
+def test_create_audit_log_from_historical_record__scheduled_feature_state__includes_schedule_time(
     admin_client: APIClient,
     admin_user: FFAdminUser,
     django_datetime_format: str,
@@ -216,7 +221,7 @@ def test_creates_audit_log_for_scheduled_feature_state_update(  # noqa: FT003
     )
 
 
-def test_retrieve_audit_log_for_feature_state_value_change(  # noqa: FT003
+def test_retrieve_audit_log__feature_state_value_change__includes_change_details(
     admin_client: APIClient,
     environment_api_key: str,
     environment: int,
@@ -262,7 +267,7 @@ def test_retrieve_audit_log_for_feature_state_value_change(  # noqa: FT003
     assert retrieve_response_json["change_details"][0]["old"] == default_feature_value
 
 
-def test_retrieve_audit_log_does_not_include_change_details_for_non_update(  # noqa: FT003
+def test_retrieve_audit_log__non_update_record__returns_empty_change_details(
     admin_client: APIClient, project: int, environment: str
 ) -> None:
     # Given
@@ -288,15 +293,15 @@ def test_retrieve_audit_log_does_not_include_change_details_for_non_update(  # n
     assert retrieve_response.json()["change_details"] == []
 
 
-def test_retrieve_audit_log_includes_changes_when_segment_override_created_and_deleted_for_enabled_state(  # noqa: FT003,FT004
+def test_retrieve_audit_log__segment_override_created_and_deleted__includes_change_details(
     admin_client: APIClient,
     project: int,
     feature: int,
     environment_api_key: str,
     environment: int,
     segment: int,
 ) -> None:
-    # First, let's create a segment override
+    # Given - create a segment override
     data = {
         "feature_segment": {"segment": segment},
         "enabled": True,
@@ -316,7 +321,7 @@ def test_retrieve_audit_log_includes_changes_when_segment_override_created_and_d
         "feature_segment"
     ]["id"]
 
-    # Now, that should have created an audit log, let's check
+    # When - retrieve the audit log for the creation
     get_audit_logs_url = "%s?environment=%s" % (
         reverse("api-v1:audit-list"),
         environment,
@@ -340,7 +345,7 @@ def test_retrieve_audit_log_includes_changes_when_segment_override_created_and_d
         get_create_override_audit_log_detail_response.json()
     )
 
-    # now let's check that we have some information about the change
+    # Then - the creation audit log has the expected change details
     assert create_override_audit_log_details["change_type"] == "CREATE"
     assert create_override_audit_log_details["change_details"] == [
         {"field": "enabled", "old": None, "new": True},
@@ -380,7 +385,7 @@ def test_retrieve_audit_log_includes_changes_when_segment_override_created_and_d
     assert delete_override_audit_log_details["change_details"] == []
 
 
-def test_retrieve_audit_log_includes_changes_when_segment_override_created_for_feature_value(  # noqa: FT003,FT004
+def test_retrieve_audit_log__segment_override_created_for_feature_value__includes_change_details(
     admin_client: APIClient,
     project: int,
     feature: int,
@@ -389,7 +394,7 @@ def test_retrieve_audit_log_includes_changes_when_segment_override_created_for_f
     environment: int,
     segment: int,
 ) -> None:
-    # First, let's create a segment override
+    # Given - create a segment override with a feature value
     data = {
         "feature_segment": {"segment": segment},
         "feature_state_value": {"value_type": "unicode", "string_value": "foo"},
@@ -405,7 +410,7 @@ def test_retrieve_audit_log_includes_changes_when_segment_override_created_for_f
     )
     assert create_segment_override_response.status_code == status.HTTP_201_CREATED
 
-    # Now, that should have created an audit log, let's check
+    # When - retrieve the audit log detail
     get_audit_logs_url = "%s?environment=%s" % (
         reverse("api-v1:audit-list"),
         environment,
@@ -427,7 +432,7 @@ def test_retrieve_audit_log_includes_changes_when_segment_override_created_for_f
     assert get_audit_log_detail_response.status_code == status.HTTP_200_OK
     audit_log_details = get_audit_log_detail_response.json()
 
-    # now let's check that we have some information about the change
+    # Then - the audit log contains the expected change details
     # This is treated as an update since the FeatureStateValue is created
     # automatically when the FeatureState is created, and then updated
     # with the value in the request.

api/tests/integration/core/test_commands.py

@@ -97,7 +97,7 @@ def test_bootstrap__empty_instance__creates_expected(
     )
 
 
-def test_bootstrap__empty_instance__cli_overrides__creates_expected(  # noqa: FT003
+def test_bootstrap__cli_overrides_provided__creates_expected_entities(
     settings: SettingsWrapper,
     capsys: pytest.CaptureFixture,  # type: ignore[type-arg]
 ) -> None:
@@ -156,9 +156,12 @@ def test_bootstrap__used_instance__skip_expected(
     [*Project.objects.all()] == expected_projects
 
 
-def test_bootstrap__allow_admin_initiation_via_cli__false_by_default__skip_expected(  # noqa: FT003,FT004
+def test_bootstrap__cli_initiation_disabled__skips_creation(
     settings: SettingsWrapper,
 ) -> None:
+    # Given
+    # settings.ALLOW_ADMIN_INITIATION_VIA_CLI is False by default
+
     # When
     call_command("bootstrap")
 

api/tests/integration/core/test_user_rate_throttle.py

@@ -12,24 +12,23 @@
     "client",
     [(lazy_fixture("admin_master_api_key_client")), (lazy_fixture("admin_client"))],
 )
-def test_user_throttle_can_throttle_admin_endpoints(  # noqa: FT003,FT004
+def test_user_throttle__admin_endpoint_exceeds_rate_limit__returns_too_many_requests(
     client: APIClient, project: int, mocker: MockerFixture, reset_cache: None
 ) -> None:
     # Given
     mocker.patch("core.throttling.UserRateThrottle.get_rate", return_value="1/minute")
-
     url = reverse("api-v1:projects:project-list")
 
-    # Then - first request should be successful
+    # When - first request should be successful
     response = client.get(url, content_type="application/json")
     assert response.status_code == status.HTTP_200_OK
 
-    # Second request should be throttled
+    # Then - second request should be throttled
     response = client.get(url, content_type="application/json")
     assert response.status_code == status.HTTP_429_TOO_MANY_REQUESTS
 
 
-def test_get_flags_is_not_throttled_by_user_throttle(  # noqa: FT003
+def test_get_flags__user_throttle_enabled__is_not_throttled(
     sdk_client: APIClient,
     environment: int,
     environment_api_key: str,
@@ -48,7 +47,7 @@ def test_get_flags_is_not_throttled_by_user_throttle(  # noqa: FT003
         assert response.status_code == status.HTTP_200_OK
 
 
-def test_get_environment_document_is_not_throttled_by_user_throttle(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_get_environment_document__user_throttle_enabled__is_not_throttled(  # type: ignore[no-untyped-def]
     server_side_sdk_client: APIClient,
     environment: int,
     environment_api_key: str,
@@ -67,7 +66,7 @@ def test_get_environment_document_is_not_throttled_by_user_throttle(  # type: ig
         assert response.status_code == status.HTTP_200_OK
 
 
-def test_get_identities_is_not_throttled_by_user_throttle(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_get_identities__user_throttle_enabled__is_not_throttled(  # type: ignore[no-untyped-def]
     environment: int,
     sdk_client: APIClient,
     mocker: MockerFixture,
@@ -88,7 +87,7 @@ def test_get_identities_is_not_throttled_by_user_throttle(  # type: ignore[no-un
         assert response.status_code == status.HTTP_200_OK
 
 
-def test_set_trait_for_an_identity_is_not_throttled_by_user_throttle(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_set_trait__user_throttle_enabled__is_not_throttled(  # type: ignore[no-untyped-def]
     environment: int,
     server_side_sdk_client: APIClient,
     identity: int,
@@ -114,7 +113,7 @@ def test_set_trait_for_an_identity_is_not_throttled_by_user_throttle(  # type: i
         assert res.status_code == status.HTTP_200_OK
 
 
-def test_sdk_analytics_is_not_throttled_by_user_throttle(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_sdk_analytics__user_throttle_enabled__is_not_throttled(  # type: ignore[no-untyped-def]
     mocker: MockerFixture, environment: int, sdk_client: APIClient
 ):
     # Given
@@ -128,7 +127,7 @@ def test_sdk_analytics_is_not_throttled_by_user_throttle(  # type: ignore[no-unt
         assert response.status_code == status.HTTP_200_OK
 
 
-def test_self_hosted_telemetry_view_is_not_throttled_by_user_throttle(  # type: ignore[no-untyped-def]  # noqa: FT003
+def test_self_hosted_telemetry__user_throttle_enabled__is_not_throttled(  # type: ignore[no-untyped-def]
     mocker: MockerFixture,
 ):
     # Given