test(mini-sentry): Add helper to grab and assert outcomes (#5251)

Author: Dav1dde

tests/integration/fixtures/mini_sentry.py

@@ -49,6 +49,8 @@ def __init__(self, server_address, app):
         self.project_config_simulate_pending = False
         self.project_config_ignore_revision = False
 
+        self.timeout = 5
+
     @property
     def internal_error_dsn(self):
         """DSN whose events make the test fail."""
@@ -201,7 +203,7 @@ def set_global_config_option(self, option_name, value):
         self.global_config["options"][option_name] = value
 
     def get_client_report(self, timeout=None):
-        envelope = self.captured_events.get(timeout=timeout)
+        envelope = self.captured_events.get(timeout=timeout or self.timeout)
         items = envelope.items
         assert len(items) == 1
         item = items[0]
@@ -210,7 +212,7 @@ def get_client_report(self, timeout=None):
         return json.loads(item.payload.bytes)
 
     def get_metrics(self, timeout=None):
-        envelope = self.captured_events.get(timeout=timeout)
+        envelope = self.captured_events.get(timeout=timeout or self.timeout)
         items = envelope.items
         assert len(items) == 1
         item = items[0]
@@ -225,6 +227,17 @@ def get_metrics(self, timeout=None):
             ),
         )
 
+    def get_outcomes(self, n, *, timeout=None):
+        outcomes = []
+        for _ in range(n):
+            outcomes.extend(
+                self.captured_outcomes.get(timeout=timeout or self.timeout).get(
+                    "outcomes"
+                )
+            )
+        outcomes.sort(key=lambda x: x["category"])
+        return outcomes
+
 
 def _get_project_id(public_key, project_configs):
     for project_id, project_config in project_configs.items():

tests/integration/test_client_report.py

@@ -37,15 +37,8 @@ def test_client_reports(relay, mini_sentry):
     report_payload["timestamp"] = (timestamp + timedelta(milliseconds=100)).isoformat()
     relay.send_client_report(project_id, report_payload)
 
-    outcomes = []
-    for _ in range(2):
-        outcomes.extend(mini_sentry.captured_outcomes.get(timeout=1.2)["outcomes"])
-    assert mini_sentry.captured_outcomes.qsize() == 0
-
-    outcomes.sort(key=lambda x: x["category"])
-
     timestamp_formatted = timestamp.isoformat().split(".")[0] + ".000000Z"
-    assert outcomes == [
+    assert mini_sentry.get_outcomes(2) == [
         {
             "timestamp": timestamp_formatted,
             "org_id": 1,
@@ -70,6 +63,8 @@ def test_client_reports(relay, mini_sentry):
         },
     ]
 
+    assert mini_sentry.captured_outcomes.empty()
+
 
 def test_client_reports_bad_timestamps(relay, mini_sentry):
     config = {

tests/integration/test_ourlogs.py

@@ -874,12 +874,7 @@ def test_filters_are_applied_to_logs(
 
     relay.send_envelope(project_id, envelope, headers=headers)
 
-    outcomes = []
-    for _ in range(2):
-        outcomes.extend(mini_sentry.captured_outcomes.get(timeout=5).get("outcomes"))
-    outcomes.sort(key=lambda x: x["category"])
-
-    assert outcomes == [
+    assert mini_sentry.get_outcomes(2) == [
         {
             "category": DataCategory.LOG_ITEM.value,
             "org_id": 1,

tests/integration/test_spans.py

@@ -947,12 +947,7 @@ def test_otel_endpoint_disabled(mini_sentry, relay):
         json=make_otel_span(start, end),
     )
 
-    outcomes = []
-    for _ in range(2):
-        outcomes.extend(mini_sentry.captured_outcomes.get(timeout=3).get("outcomes"))
-    outcomes.sort(key=lambda x: x["category"])
-
-    assert outcomes == [
+    assert mini_sentry.get_outcomes(2) == [
         {
             "org_id": 1,
             "key_id": 123,

tests/integration/test_spansv2.py

@@ -508,12 +508,7 @@ def test_spanv2_inbound_filters(
 
     relay.send_envelope(project_id, envelope, headers=headers)
 
-    outcomes = []
-    for _ in range(2):
-        outcomes.extend(mini_sentry.captured_outcomes.get(timeout=5).get("outcomes"))
-    outcomes.sort(key=lambda x: x["category"])
-
-    assert outcomes == [
+    assert mini_sentry.get_outcomes(2) == [
         {
             "category": DataCategory.SPAN.value,
             "org_id": 1,