type tests.sentry.incidents.action_handlers.* (#98112)

Found a pattern where this module just needed their `run_test` methods
typed.

Author: thetruecpaul

pyproject.toml

@@ -680,6 +680,7 @@ module = [
     "tests.sentry.flags.providers.*",
     "tests.sentry.grouping.*",
     "tests.sentry.hybridcloud.*",
+    "tests.sentry.incidents.action_handlers.*",
     "tests.sentry.incidents.handlers.*",
     "tests.sentry.incidents.serializers.*",
     "tests.sentry.insights.*",

src/sentry/incidents/action_handlers.py

@@ -509,7 +509,7 @@ def generate_incident_trigger_email_context(
     trigger_threshold: float,
     user: User | RpcUser | None = None,
     notification_uuid: str | None = None,
-):
+) -> dict[str, Any]:
     from sentry.notifications.notification_action.utils import should_fire_workflow_actions
     from sentry.seer.anomaly_detection.types import AnomalyDetectionThresholdType
 

tests/relay_integration/test_integration.py

@@ -4,7 +4,7 @@
 
 import pytest
 import requests
-from sentry_relay.auth import generate_key_pair
+from sentry_relay.auth import SecretKey, generate_key_pair
 
 from sentry.models.eventattachment import EventAttachment
 from sentry.tasks.relay import invalidate_project_config
@@ -17,7 +17,7 @@
 pytestmark = [requires_kafka]
 
 
-def create_trusted_relay_signature(secret_key):
+def create_trusted_relay_signature(secret_key: SecretKey) -> str | bytes:
     """
     Mimics how the trusted relay signature is built so we can test communication.
     """
@@ -33,7 +33,7 @@ def create_trusted_relay_signature(secret_key):
 
 
 class SentryRemoteTest(RelayStoreHelper, TransactionTestCase):
-    def setup_for_trusted_relay_signature(self):
+    def setup_for_trusted_relay_signature(self) -> tuple[str, SecretKey]:
         """
         sets up project config settings and returns the relay_id and the secret key which
         can be used to create the signature if required.

tests/sentry/incidents/action_handlers/__init__.py

@@ -10,10 +10,15 @@ class FireTest(TestCase, abc.ABC):
     __test__ = Abstract(__module__, __qualname__)
 
     @abc.abstractmethod
-    def run_test(self, incident: Incident, method: str, **kwargs):
+    def run_test(self, incident: Incident, method: str, **kwargs: object) -> None:
         pass
 
-    def run_fire_test(self, method="fire", chart_url=None, status=IncidentStatus.CLOSED):
+    def run_fire_test(
+        self,
+        method: str = "fire",
+        chart_url: str | None = None,
+        status: IncidentStatus = IncidentStatus.CLOSED,
+    ) -> None:
         kwargs = {}
         if chart_url:
             kwargs = {"chart_url": chart_url}
@@ -24,4 +29,4 @@ def run_fire_test(self, method="fire", chart_url=None, status=IncidentStatus.CLO
             update_incident_status(
                 incident, IncidentStatus.CLOSED, status_method=IncidentStatusMethod.MANUAL
             )
-        return self.run_test(incident, method, **kwargs)
+        self.run_test(incident, method, **kwargs)

tests/sentry/incidents/action_handlers/test_discord.py

@@ -1,10 +1,9 @@
 from unittest.mock import MagicMock, patch
 
-import orjson
 import responses
 
 from sentry.incidents.models.alert_rule import AlertRuleTriggerAction
-from sentry.incidents.models.incident import IncidentStatus
+from sentry.incidents.models.incident import Incident, IncidentStatus
 from sentry.integrations.discord.client import CHANNEL_URL, DISCORD_BASE_URL, MESSAGE_URL
 from sentry.integrations.discord.spec import DiscordMessagingSpec
 from sentry.integrations.messaging.spec import MessagingActionHandler
@@ -51,7 +50,7 @@ def setUp(self) -> None:
         )
 
     @responses.activate
-    def run_test(self, incident, method):
+    def run_test(self, incident: Incident, method: str) -> None:
         responses.add(
             method=responses.POST,
             url=f"{DISCORD_BASE_URL}{MESSAGE_URL.format(channel_id=self.channel_id)}",
@@ -69,9 +68,6 @@ def run_test(self, incident, method):
                 metric_value=metric_value,
             )
 
-        data = orjson.loads(responses.calls[0].request.body)
-        return data
-
     def test_fire_metric_alert(self) -> None:
         self.run_fire_test()
 

tests/sentry/incidents/action_handlers/test_email.py

@@ -1,4 +1,5 @@
 from functools import cached_property
+from typing import Any
 from unittest.mock import MagicMock, patch
 
 import orjson
@@ -27,13 +28,19 @@
 )
 from sentry.incidents.logic import CRITICAL_TRIGGER_LABEL, WARNING_TRIGGER_LABEL
 from sentry.incidents.models.alert_rule import (
+    AlertRule,
     AlertRuleDetectionType,
     AlertRuleSeasonality,
     AlertRuleSensitivity,
     AlertRuleThresholdType,
     AlertRuleTriggerAction,
 )
-from sentry.incidents.models.incident import INCIDENT_STATUS, IncidentStatus, TriggerStatus
+from sentry.incidents.models.incident import (
+    INCIDENT_STATUS,
+    Incident,
+    IncidentStatus,
+    TriggerStatus,
+)
 from sentry.incidents.typings.metric_detector import (
     AlertContext,
     MetricIssueContext,
@@ -51,8 +58,10 @@
 from sentry.testutils.helpers.datetime import freeze_time
 from sentry.testutils.helpers.features import with_feature
 from sentry.testutils.silo import assume_test_silo_mode_of
+from sentry.users.models.user import User
 from sentry.users.models.user_option import UserOption
 from sentry.users.models.useremail import UserEmail
+from sentry.users.services.user import RpcUser
 
 from . import FireTest
 
@@ -62,7 +71,7 @@
 @freeze_time()
 class EmailActionHandlerTest(FireTest):
     @responses.activate
-    def run_test(self, incident, method):
+    def run_test(self, incident: Incident, method: str) -> None:
         action = self.create_alert_rule_trigger_action(
             target_identifier=str(self.user.id),
             triggered_for_incident=incident,
@@ -111,7 +120,7 @@ def setUp(self) -> None:
         self.handler = EmailActionHandler()
 
     @cached_property
-    def incident(self):
+    def incident(self) -> Incident:
         return self.create_incident()
 
     def test_user(self) -> None:
@@ -268,20 +277,20 @@ def test_team_email_routing(self) -> None:
 
 @freeze_time()
 class EmailActionHandlerGenerateEmailContextTest(TestCase):
-    def serialize_incident(self, incident) -> DetailedIncidentSerializerResponse:
+    def serialize_incident(self, incident: Incident) -> DetailedIncidentSerializerResponse:
         return serialize(incident, None, DetailedIncidentSerializer())
 
-    def serialize_alert_rule(self, alert_rule) -> AlertRuleSerializerResponse:
+    def serialize_alert_rule(self, alert_rule: AlertRule) -> AlertRuleSerializerResponse:
         return serialize(alert_rule, None, AlertRuleSerializer())
 
     def _generate_email_context(
         self,
-        incident,
-        trigger_status,
-        trigger_threshold,
-        user=None,
-        notification_uuid=None,
-    ):
+        incident: Incident,
+        trigger_status: TriggerStatus,
+        trigger_threshold: float,
+        user: User | RpcUser | None = None,
+        notification_uuid: str | None = None,
+    ) -> dict[str, Any]:
         """
         Helper method to generate email context from an incident and trigger status.
         Encapsulates the common pattern of creating contexts and serializing models.

tests/sentry/incidents/action_handlers/test_msteams.py

@@ -14,7 +14,7 @@
     AlertRuleSensitivity,
     AlertRuleTriggerAction,
 )
-from sentry.incidents.models.incident import IncidentStatus, IncidentStatusMethod
+from sentry.incidents.models.incident import Incident, IncidentStatus, IncidentStatusMethod
 from sentry.incidents.typings.metric_detector import AlertContext, MetricIssueContext
 from sentry.integrations.messaging.spec import MessagingActionHandler
 from sentry.integrations.msteams.card_builder.block import (
@@ -77,7 +77,7 @@ def setUp(self) -> None:
 
     @responses.activate
     @patch("sentry.integrations.utils.metrics.EventLifecycle.record_event")
-    def run_test(self, incident, method, mock_record):
+    def run_test(self, incident: Incident, method: str, mock_record: MagicMock) -> None:
         from sentry.integrations.msteams.card_builder.incident_attachment import (
             build_incident_attachment,
         )

tests/sentry/incidents/action_handlers/test_opsgenie.py

@@ -13,7 +13,7 @@
     AlertRuleSensitivity,
     AlertRuleTriggerAction,
 )
-from sentry.incidents.models.incident import IncidentStatus, IncidentStatusMethod
+from sentry.incidents.models.incident import Incident, IncidentStatus, IncidentStatusMethod
 from sentry.incidents.typings.metric_detector import AlertContext, MetricIssueContext
 from sentry.integrations.models.integration import Integration
 from sentry.integrations.models.organization_integration import OrganizationIntegration
@@ -174,7 +174,7 @@ def test_build_incident_attachment_dynamic_alert(self, mock_seer_request: MagicM
         )
 
     @responses.activate
-    def run_test(self, incident, method):
+    def run_test(self, incident: Incident, method: str) -> None:
         from sentry.integrations.opsgenie.utils import (
             attach_custom_priority,
             build_incident_attachment,

tests/sentry/incidents/action_handlers/test_pagerduty.py

@@ -14,7 +14,7 @@
     AlertRuleSensitivity,
     AlertRuleTriggerAction,
 )
-from sentry.incidents.models.incident import IncidentStatus, IncidentStatusMethod
+from sentry.incidents.models.incident import Incident, IncidentStatus, IncidentStatusMethod
 from sentry.incidents.typings.metric_detector import AlertContext, MetricIssueContext
 from sentry.integrations.pagerduty.utils import add_service
 from sentry.seer.anomaly_detection.types import StoreDataResponse
@@ -161,7 +161,7 @@ def test_build_incident_attachment_dynamic_alert(self, mock_seer_request: MagicM
         )
 
     @responses.activate
-    def run_test(self, incident, method):
+    def run_test(self, incident: Incident, method: str) -> None:
         from sentry.integrations.pagerduty.utils import (
             attach_custom_severity,
             build_incident_attachment,

tests/sentry/incidents/action_handlers/test_sentry_app.py

@@ -7,7 +7,7 @@
 from sentry.incidents.action_handlers import SentryAppActionHandler
 from sentry.incidents.endpoints.serializers.incident import IncidentSerializer
 from sentry.incidents.models.alert_rule import AlertRuleTriggerAction
-from sentry.incidents.models.incident import IncidentStatus
+from sentry.incidents.models.incident import Incident, IncidentStatus
 from sentry.incidents.typings.metric_detector import AlertContext, MetricIssueContext
 from sentry.integrations.types import EventLifecycleOutcome
 from sentry.sentry_apps.metrics import SentryAppWebhookHaltReason
@@ -46,7 +46,7 @@ def setUp(self) -> None:
         self.handler = SentryAppActionHandler()
 
     @responses.activate
-    def run_test(self, incident, method):
+    def run_test(self, incident: Incident, method: str) -> None:
         from sentry.rules.actions.notify_event_service import build_incident_attachment
 
         responses.add(
@@ -210,7 +210,7 @@ def setUp(self) -> None:
         self.handler = SentryAppActionHandler()
 
     @responses.activate
-    def run_test(self, incident, method):
+    def run_test(self, incident: Incident, method: str) -> None:
         from sentry.rules.actions.notify_event_service import build_incident_attachment
 
         trigger = self.create_alert_rule_trigger(self.alert_rule, "hi", 1000)