fix(typing): Type tests.sentry.workflow_engine.endpoints (#103103)

Mostly just adding missing types / generics.

Author: thetruecpaul

pyproject.toml

@@ -863,7 +863,7 @@ module = [
     "tests.sentry.web.frontend.generic.*",
     "tests.sentry.web.frontend.test_cli",
     "tests.sentry.workflow_engine.detectors.*",
-    "tests.sentry.workflow_engine.endpoints.utils.*",
+    "tests.sentry.workflow_engine.endpoints.*",
     "tests.sentry.workflow_engine.handlers.action.*",
     "tests.sentry.workflow_engine.models.*",
     "tests.sentry.workflow_engine.processors.contexts.*",

tests/sentry/workflow_engine/endpoints/serializers/test_workflow_group_history_serializer.py

@@ -1,15 +1,17 @@
-from datetime import timedelta
+from datetime import datetime, timedelta
 from uuid import uuid4
 
 from sentry.incidents.grouptype import MetricIssue
+from sentry.models.group import Group
 from sentry.testutils.cases import TestCase
 from sentry.testutils.helpers.datetime import before_now, freeze_time
 from sentry.testutils.skips import requires_snuba
+from sentry.utils.cursors import Cursor, CursorResult
 from sentry.workflow_engine.endpoints.serializers.workflow_group_history_serializer import (
     WorkflowGroupHistory,
     fetch_workflow_groups_paginated,
 )
-from sentry.workflow_engine.models import WorkflowFireHistory
+from sentry.workflow_engine.models import Workflow, WorkflowFireHistory
 
 pytestmark = [requires_snuba]
 
@@ -108,8 +110,14 @@ def setUp(self) -> None:
         self.login_as(self.user)
 
     def assert_expected_results(
-        self, workflow, start, end, expected_results, cursor=None, per_page=25
-    ):
+        self,
+        workflow: Workflow,
+        start: datetime,
+        end: datetime,
+        expected_results: list[WorkflowGroupHistory],
+        cursor: Cursor | None = None,
+        per_page: int = 25,
+    ) -> CursorResult[Group]:
         result = fetch_workflow_groups_paginated(workflow, start, end, cursor, per_page)
         assert result.results == expected_results, (result.results, expected_results)
         return result

tests/sentry/workflow_engine/endpoints/test_organization_data_condition_index.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Any
 from unittest.mock import patch
 
 from sentry.testutils.cases import APITestCase
@@ -14,7 +15,9 @@ class OrganizationDataConditionAPITestCase(APITestCase):
     def setUp(self) -> None:
         super().setUp()
         self.login_as(user=self.user)
-        self.registry = Registry[type[DataConditionHandler]](enable_reverse_lookup=False)
+        self.registry = Registry[type[DataConditionHandler[dict[str, Any]]]](
+            enable_reverse_lookup=False
+        )
         self.registry_patcher = patch(
             "sentry.workflow_engine.endpoints.organization_data_condition_index.condition_handler_registry",
             new=self.registry,
@@ -23,13 +26,13 @@ def setUp(self) -> None:
 
         @self.registry.register(Condition.REAPPEARED_EVENT)
         @dataclass(frozen=True)
-        class TestWorkflowTrigger(DataConditionHandler):
+        class TestWorkflowTrigger(DataConditionHandler[dict[str, str]]):
             group = DataConditionHandler.Group.WORKFLOW_TRIGGER
             comparison_json_schema = {"type": "boolean"}
 
         @self.registry.register(Condition.AGE_COMPARISON)
         @dataclass(frozen=True)
-        class TestActionFilter(DataConditionHandler):
+        class TestActionFilter(DataConditionHandler[dict[str, Any]]):
             group = DataConditionHandler.Group.ACTION_FILTER
             subgroup = DataConditionHandler.Subgroup.ISSUE_ATTRIBUTES
             comparison_json_schema = {
@@ -43,20 +46,20 @@ class TestActionFilter(DataConditionHandler):
 
         @self.registry.register(Condition.ANOMALY_DETECTION)
         @dataclass(frozen=True)
-        class TestDetectorTrigger(DataConditionHandler):
+        class TestDetectorTrigger(DataConditionHandler[dict[str, str]]):
             group = DataConditionHandler.Group.DETECTOR_TRIGGER
             comparison_json_schema = {"type": "boolean"}
 
         # This legacy condition should not be included in the response
         @self.registry.register(Condition.EXISTING_HIGH_PRIORITY_ISSUE)
         @dataclass(frozen=True)
-        class TestIgnoredCondition(DataConditionHandler):
+        class TestIgnoredCondition(DataConditionHandler[dict[str, str]]):
             group = DataConditionHandler.Group.WORKFLOW_TRIGGER
             comparison_json_schema = {"type": "boolean"}
 
         @self.registry.register(Condition.ISSUE_CATEGORY)
         @dataclass(frozen=True)
-        class TestIssueCategoryCondition(DataConditionHandler):
+        class TestIssueCategoryCondition(DataConditionHandler[dict[str, Any]]):
             group = DataConditionHandler.Group.ACTION_FILTER
             subgroup = DataConditionHandler.Subgroup.ISSUE_ATTRIBUTES
             comparison_json_schema = {

tests/sentry/workflow_engine/endpoints/test_organization_detector_details.py

@@ -195,22 +195,22 @@ def setUp(self) -> None:
         }
         assert SnubaQuery.objects.get(id=self.snuba_query.id)
 
-    def assert_detector_updated(self, detector):
+    def assert_detector_updated(self, detector: Detector) -> None:
         assert detector.name == "Updated Detector"
         assert detector.type == MetricIssue.slug
         assert detector.project_id == self.project.id
 
-    def assert_condition_group_updated(self, condition_group):
+    def assert_condition_group_updated(self, condition_group: DataConditionGroup | None) -> None:
         assert condition_group
         assert condition_group.logic_type == DataConditionGroup.Type.ANY
         assert condition_group.organization_id == self.organization.id
 
-    def assert_data_condition_updated(self, condition):
+    def assert_data_condition_updated(self, condition: DataCondition) -> None:
         assert condition.type == Condition.GREATER.value
         assert condition.comparison == 100
         assert condition.condition_result == DetectorPriorityLevel.HIGH
 
-    def assert_snuba_query_updated(self, snuba_query):
+    def assert_snuba_query_updated(self, snuba_query: SnubaQuery) -> None:
         assert snuba_query.query == "updated query"
         assert snuba_query.time_window == 300
 
@@ -717,7 +717,7 @@ class OrganizationDetectorDetailsDeleteTest(OrganizationDetectorDetailsBaseTest)
     @mock.patch(
         "sentry.workflow_engine.endpoints.organization_detector_details.schedule_update_project_config"
     )
-    def test_simple(self, mock_schedule_update_project_config) -> None:
+    def test_simple(self, mock_schedule_update_project_config: mock.MagicMock) -> None:
         with outbox_runner():
             self.get_success_response(self.organization.slug, self.detector.id)
 

tests/sentry/workflow_engine/endpoints/test_organization_detector_index.py

@@ -833,7 +833,9 @@ def test_without_feature_flag(self) -> None:
     @mock.patch("sentry.incidents.metric_issue_detector.schedule_update_project_config")
     @mock.patch("sentry.workflow_engine.endpoints.validators.base.detector.create_audit_entry")
     def test_valid_creation(
-        self, mock_audit: mock.MagicMock, mock_schedule_update_project_config
+        self,
+        mock_audit: mock.MagicMock,
+        mock_schedule_update_project_config: mock.MagicMock,
     ) -> None:
         with self.tasks():
             response = self.get_success_response(

tests/sentry/workflow_engine/endpoints/test_organization_detector_types.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Never
 from unittest.mock import patch
 
 from sentry.incidents.grouptype import MetricIssue
@@ -38,22 +39,22 @@ def setUp(self) -> None:
         )
         self.registry_patcher.start()
 
-        class MockDetectorHandler(DetectorHandler[dict, bool]):
+        class MockDetectorHandler(DetectorHandler[dict[Never, Never], bool]):
             def evaluate(
-                self, data_packet: DataPacket[dict]
+                self, data_packet: DataPacket[dict[Never, Never]]
             ) -> dict[DetectorGroupKey, DetectorEvaluationResult]:
                 return {None: DetectorEvaluationResult(None, True, DetectorPriorityLevel.HIGH)}
 
-            def extract_value(self, data_packet: DataPacket[dict]) -> bool:
+            def extract_value(self, data_packet: DataPacket[dict[Never, Never]]) -> bool:
                 return True
 
-            def extract_dedupe_value(self, data_packet: DataPacket[dict]) -> int:
+            def extract_dedupe_value(self, data_packet: DataPacket[dict[Never, Never]]) -> int:
                 return 1
 
             def create_occurrence(
                 self,
                 evaluation_result: ProcessedDataConditionGroup,
-                data_packet: DataPacket[dict],
+                data_packet: DataPacket[dict[Never, Never]],
                 priority: DetectorPriorityLevel,
             ) -> tuple[DetectorOccurrence, EventData]:
                 return (

tests/sentry/workflow_engine/endpoints/test_organization_open_periods.py

@@ -42,7 +42,7 @@ def setUp(self) -> None:
             value=self.group.priority,
         )
 
-    def get_url_args(self):
+    def get_url_args(self) -> list[str]:
         return [self.organization.slug]
 
     def test_no_group_link(self) -> None:

tests/sentry/workflow_engine/endpoints/test_organization_test_fire_action.py

@@ -67,8 +67,11 @@ def setup_pd_service(self) -> PagerDutyServiceDict:
         return_value=PagerDutyIssueAlertHandler,
     )
     def test_pagerduty_action(
-        self, mock_get_issue_alert_handler, mock_get_group_type_handler, mock_send_trigger
-    ):
+        self,
+        mock_get_issue_alert_handler: mock.MagicMock,
+        mock_get_group_type_handler: mock.MagicMock,
+        mock_send_trigger: mock.MagicMock,
+    ) -> None:
         """Test a PagerDuty action"""
         service_info = self.setup_pd_service()
 
@@ -90,6 +93,7 @@ def test_pagerduty_action(
         assert response.status_code == 200
         assert mock_send_trigger.call_count == 1
         pagerduty_data = mock_send_trigger.call_args.kwargs.get("data")
+        assert pagerduty_data is not None
         assert pagerduty_data["payload"]["summary"].startswith("[Test Detector]:")
 
     @mock.patch.object(NotifyEventAction, "after")
@@ -102,8 +106,11 @@ def test_pagerduty_action(
         return_value=PluginIssueAlertHandler,
     )
     def test_plugin_notify_event_action(
-        self, mock_get_issue_alert_handler, mock_get_group_type_handler, mock_after
-    ):
+        self,
+        mock_get_issue_alert_handler: mock.MagicMock,
+        mock_get_group_type_handler: mock.MagicMock,
+        mock_after: mock.MagicMock,
+    ) -> None:
         """Test a Plugin action (NotifyEventAction)"""
         action_data = [
             {
@@ -214,8 +221,8 @@ def test_no_projects_available(self) -> None:
     )
     @mock.patch("sentry.integrations.slack.actions.form.get_channel_id")
     def test_updates_action_with_validated_data(
-        self, mock_get_channel_id, mock_send_test_notification
-    ):
+        self, mock_get_channel_id: mock.MagicMock, mock_send_test_notification: mock.MagicMock
+    ) -> None:
         self.integration, self.org_integration = self.create_provider_integration_for(
             provider="slack",
             organization=self.organization,

tests/sentry/workflow_engine/endpoints/test_organization_workflow_details.py

@@ -389,7 +389,7 @@ def test_update_detectors_no_changes(self) -> None:
 class OrganizationDeleteWorkflowTest(OrganizationWorkflowDetailsBaseTest, BaseWorkflowTest):
     method = "DELETE"
 
-    def tasks(self) -> AbstractContextManager:
+    def tasks(self) -> AbstractContextManager[None]:
         return TaskRunner()
 
     def setUp(self) -> None:

tests/sentry/workflow_engine/endpoints/test_validators.py

@@ -1,3 +1,4 @@
+from typing import Any
 from unittest import mock
 
 import pytest
@@ -67,7 +68,7 @@ class Meta:
             "field2",
         ]
 
-    def create_source(self, validated_data) -> MockModel:
+    def create_source(self, validated_data: Any) -> MockModel:
         return MockModel.objects.create()
 
 
@@ -95,7 +96,7 @@ class MockDataConditionValidator(MetricIssueComparisonConditionValidator):
 class MockConditionGroupValidator(BaseDataConditionGroupValidator):
     conditions = serializers.ListField(required=True)
 
-    def validate_conditions(self, value) -> list:
+    def validate_conditions(self, value: list[dict[str, Any]]) -> list[dict[str, Any]]:
         for condition in value:
             MockDataConditionValidator(data=condition).is_valid(raise_exception=True)