refa(tests): leverage the new transaction assertion helper

Author: solnic

test/sentry/opentelemetry/span_processor_test.exs

@@ -489,7 +489,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{"trace" => %{"op" => "http.server", "description" => "GET /api/users"}}
       )
     end
@@ -509,7 +509,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{"trace" => %{"op" => "http.server", "description" => "GET"}}
       )
     end
@@ -530,7 +530,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{"trace" => %{"op" => "http.client", "description" => "GET /external/api"}}
       )
     end
@@ -552,7 +552,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{
           "trace" => %{
             "op" => "http.server",
@@ -578,7 +578,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{
           "trace" => %{"op" => "db", "description" => "SELECT * FROM users WHERE id = $1"}
         }
@@ -600,7 +600,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{"trace" => %{"op" => "db", "description" => nil}}
       )
     end
@@ -621,7 +621,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{
           "trace" => %{"op" => "queue.process", "description" => "MyApp.Workers.EmailWorker"}
         },
@@ -639,7 +639,7 @@ defmodule Sentry.Opentelemetry.SpanProcessorTest do
         Process.sleep(1)
       end
 
-      assert_sentry_report(collect_sentry_transactions(ref, 1),
+      assert_sentry_transaction(ref,
         contexts: %{"trace" => %{"op" => "custom_operation", "description" => "custom_operation"}}
       )
     end

test_integrations/phoenix_app/test/phoenix_app/repo_test.exs

@@ -4,30 +4,36 @@ defmodule PhoenixApp.RepoTest do
   alias PhoenixApp.{Repo, Accounts.User}
 
   import Sentry.TestHelpers
+  import Sentry.Test.Assertions
 
   setup do
-    setup_bypass(traces_sample_rate: 1.0)
+    Sentry.Test.setup_sentry(collect_envelopes: true, traces_sample_rate: 1.0)
   end
 
-  test "instrumented top-level ecto transaction span", %{bypass: bypass} do
-    ref = setup_bypass_envelope_collector(bypass)
-
+  test "instrumented top-level ecto transaction span", %{ref: ref} do
     Repo.all(User) |> Enum.map(& &1.id)
 
-    assert [tx] = collect_sentry_transactions(ref, 1)
-
-    assert tx["transaction_info"] == %{"source" => "custom"}
-
-    assert tx["contexts"]["trace"]["op"] == "db"
-
-    assert tx["contexts"]["trace"]["data"]["db.system"] == "sqlite"
-    assert tx["contexts"]["trace"]["data"]["db.type"] == "sql"
-    assert tx["contexts"]["trace"]["data"]["db.instance"] == "db/test.sqlite3"
-    assert tx["contexts"]["trace"]["data"]["db.name"] == "db/test.sqlite3"
-
-    assert String.starts_with?(tx["contexts"]["trace"]["description"], "SELECT")
-    assert String.starts_with?(tx["contexts"]["trace"]["data"]["db.statement"], "SELECT")
-
-    refute Map.has_key?(tx["contexts"]["trace"]["data"], "db.url")
+    tx =
+      assert_sentry_transaction(ref,
+        transaction_info: %{"source" => "custom"},
+        contexts: %{
+          trace: %{
+            op: "db",
+            data: %{
+              "db.system" => "sqlite",
+              "db.type" => "sql",
+              "db.instance" => "db/test.sqlite3",
+              "db.name" => "db/test.sqlite3"
+            }
+          }
+        }
+      )
+
+    trace = tx["contexts"]["trace"]
+
+    assert String.starts_with?(trace["description"], "SELECT")
+    assert String.starts_with?(trace["data"]["db.statement"], "SELECT")
+
+    refute Map.has_key?(trace["data"], "db.url")
   end
 end

test_integrations/phoenix_app/test/phoenix_app_web/controllers/transaction_test.exs

@@ -3,49 +3,39 @@ defmodule Sentry.Integrations.Phoenix.TransactionTest do
 
   import Phoenix.LiveViewTest
   import Sentry.TestHelpers
+  import Sentry.Test.Assertions
 
   setup do
-    setup_bypass(traces_sample_rate: 1.0)
+    Sentry.Test.setup_sentry(collect_envelopes: true, traces_sample_rate: 1.0)
   end
 
-  test "GET /transaction", %{conn: conn, bypass: bypass} do
-    ref = setup_bypass_envelope_collector(bypass)
-
+  test "GET /transaction", %{conn: conn, ref: ref} do
     get(conn, ~p"/transaction")
 
-    transactions = collect_envelopes(ref, 1) |> extract_transactions()
-
-    assert length(transactions) == 1
-
-    assert [tx] = transactions
-
-    assert tx["transaction"] == "test_span"
-    assert tx["transaction_info"] == %{"source" => "custom"}
+    tx =
+      assert_sentry_transaction(ref,
+        transaction: "test_span",
+        transaction_info: %{"source" => "custom"},
+        contexts: %{trace: %{origin: "phoenix_app", op: "test_span"}}
+      )
 
-    trace = tx["contexts"]["trace"]
-    assert trace["origin"] == "phoenix_app"
-    assert trace["op"] == "test_span"
-    assert trace["data"] == %{}
+    assert tx["contexts"]["trace"]["data"] == %{}
   end
 
-  test "GET /users", %{conn: conn, bypass: bypass} do
-    ref = setup_bypass_envelope_collector(bypass)
-
+  test "GET /users", %{conn: conn, ref: ref} do
     get(conn, ~p"/users")
 
-    transactions = collect_envelopes(ref, 2) |> extract_transactions()
-
-    assert length(transactions) == 2
-
-    assert [mount_tx, handle_params_tx] = transactions
+    assert [mount_tx, handle_params_tx] = collect_sentry_transactions(ref, 2)
 
-    assert mount_tx["transaction"] == "PhoenixAppWeb.UserLive.Index.mount"
-    assert mount_tx["transaction_info"] == %{"source" => "custom"}
+    assert_sentry_report(mount_tx,
+      transaction: "PhoenixAppWeb.UserLive.Index.mount",
+      transaction_info: %{"source" => "custom"},
+      contexts: %{
+        trace: %{origin: "opentelemetry_phoenix", op: "PhoenixAppWeb.UserLive.Index.mount"}
+      }
+    )
 
-    trace = mount_tx["contexts"]["trace"]
-    assert trace["origin"] == "opentelemetry_phoenix"
-    assert trace["op"] == "PhoenixAppWeb.UserLive.Index.mount"
-    assert trace["data"] == %{}
+    assert mount_tx["contexts"]["trace"]["data"] == %{}
 
     assert [span_ecto] = mount_tx["spans"]
 
@@ -54,33 +44,29 @@ defmodule Sentry.Integrations.Phoenix.TransactionTest do
     assert span_ecto["description"] ==
              "SELECT u0.\"id\", u0.\"name\", u0.\"age\", u0.\"inserted_at\", u0.\"updated_at\" FROM \"users\" AS u0"
 
-    assert handle_params_tx["transaction"] ==
-             "PhoenixAppWeb.UserLive.Index.handle_params"
-
-    assert handle_params_tx["transaction_info"] == %{"source" => "custom"}
-
-    trace = handle_params_tx["contexts"]["trace"]
-    assert trace["origin"] == "opentelemetry_phoenix"
-    assert trace["op"] == "PhoenixAppWeb.UserLive.Index.handle_params"
-    assert trace["data"] == %{}
+    assert_sentry_report(handle_params_tx,
+      transaction: "PhoenixAppWeb.UserLive.Index.handle_params",
+      transaction_info: %{"source" => "custom"},
+      contexts: %{
+        trace: %{
+          origin: "opentelemetry_phoenix",
+          op: "PhoenixAppWeb.UserLive.Index.handle_params"
+        }
+      }
+    )
+
+    assert handle_params_tx["contexts"]["trace"]["data"] == %{}
   end
 
-  test "GET /nested-spans includes grand-child spans", %{conn: conn, bypass: bypass} do
-    ref = setup_bypass_envelope_collector(bypass)
-
+  test "GET /nested-spans includes grand-child spans", %{conn: conn, ref: ref} do
     get(conn, ~p"/nested-spans")
 
-    transactions = collect_envelopes(ref, 1) |> extract_transactions()
-
-    assert length(transactions) == 1
-    assert [tx] = transactions
-
-    assert tx["transaction"] == "root_span"
-    assert tx["transaction_info"] == %{"source" => "custom"}
-
-    trace = tx["contexts"]["trace"]
-    assert trace["origin"] == "phoenix_app"
-    assert trace["op"] == "root_span"
+    tx =
+      assert_sentry_transaction(ref,
+        transaction: "root_span",
+        transaction_info: %{"source" => "custom"},
+        contexts: %{trace: %{origin: "phoenix_app", op: "root_span"}}
+      )
 
     assert length(tx["spans"]) == 6
 
@@ -115,16 +101,11 @@ defmodule Sentry.Integrations.Phoenix.TransactionTest do
 
   test "LiveView mount and handle_params create disconnected transactions with child spans", %{
     conn: conn,
-    bypass: bypass
+    ref: ref
   } do
-    ref = setup_bypass_envelope_collector(bypass)
-
     get(conn, ~p"/users")
 
-    transactions = collect_envelopes(ref, 2) |> extract_transactions()
-
-    assert length(transactions) == 2
-    assert [mount_tx, handle_params_tx] = transactions
+    assert [mount_tx, handle_params_tx] = collect_sentry_transactions(ref, 2)
 
     assert mount_tx["transaction"] == "PhoenixAppWeb.UserLive.Index.mount"
     assert length(mount_tx["spans"]) == 1
@@ -145,10 +126,8 @@ defmodule Sentry.Integrations.Phoenix.TransactionTest do
   describe "distributed tracing with sentry-trace header" do
     test "LiveView mount inherits trace context from sentry-trace header", %{
       conn: conn,
-      bypass: bypass
+      ref: ref
     } do
-      ref = setup_bypass_envelope_collector(bypass)
-
       trace_id = "1234567890abcdef1234567890abcdef"
       parent_span_id = "abcdef1234567890"
 
@@ -158,34 +137,23 @@ defmodule Sentry.Integrations.Phoenix.TransactionTest do
 
       get(conn, ~p"/users")
 
-      transactions = collect_envelopes(ref, 2) |> extract_transactions()
-
-      mount_tx =
-        Enum.find(transactions, fn t ->
-          t["transaction"] == "PhoenixAppWeb.UserLive.Index.mount"
-        end)
+      transactions = collect_sentry_transactions(ref, 2)
 
-      handle_params_tx =
-        Enum.find(transactions, fn t ->
-          t["transaction"] == "PhoenixAppWeb.UserLive.Index.handle_params"
-        end)
+      find_sentry_report!(transactions,
+        transaction: "PhoenixAppWeb.UserLive.Index.mount",
+        contexts: %{trace: %{trace_id: trace_id, parent_span_id: parent_span_id}}
+      )
 
-      assert mount_tx != nil
-      assert handle_params_tx != nil
-
-      assert mount_tx["contexts"]["trace"]["trace_id"] == trace_id
-      assert handle_params_tx["contexts"]["trace"]["trace_id"] == trace_id
-
-      assert mount_tx["contexts"]["trace"]["parent_span_id"] == parent_span_id
-      assert handle_params_tx["contexts"]["trace"]["parent_span_id"] == parent_span_id
+      find_sentry_report!(transactions,
+        transaction: "PhoenixAppWeb.UserLive.Index.handle_params",
+        contexts: %{trace: %{trace_id: trace_id, parent_span_id: parent_span_id}}
+      )
     end
 
     test "LiveView handle_event in WebSocket shares trace context with initial request", %{
       conn: conn,
-      bypass: bypass
+      ref: ref
     } do
-      ref = setup_bypass_envelope_collector(bypass)
-
       trace_id = "fedcba0987654321fedcba0987654321"
       parent_span_id = "1234567890fedcba"
 
@@ -197,23 +165,15 @@ defmodule Sentry.Integrations.Phoenix.TransactionTest do
 
       view |> element("#increment-btn") |> render_click()
 
-      transactions = collect_envelopes(ref, 5, timeout: 2000) |> extract_transactions()
-
-      handle_event_tx =
-        Enum.find(transactions, fn t ->
-          String.contains?(t["transaction"], "handle_event#increment")
-        end)
-
-      assert handle_event_tx != nil,
-             "Expected handle_event transaction, got: #{inspect(Enum.map(transactions, & &1["transaction"]))}"
-
-      assert handle_event_tx["contexts"]["trace"]["trace_id"] == trace_id,
-             "Expected trace_id #{trace_id}, got #{handle_event_tx["contexts"]["trace"]["trace_id"]}"
+      find_sentry_transaction!(ref,
+        count: 5,
+        timeout: 2000,
+        transaction: ~r/handle_event#increment/,
+        contexts: %{trace: %{trace_id: trace_id}}
+      )
     end
 
-    test "baggage header is preserved through LiveView lifecycle", %{conn: conn, bypass: bypass} do
-      ref = setup_bypass_envelope_collector(bypass)
-
+    test "baggage header is preserved through LiveView lifecycle", %{conn: conn, ref: ref} do
       trace_id = "abababababababababababababababab"
       parent_span_id = "cdcdcdcdcdcdcdcd"
       baggage = "sentry-environment=production,sentry-release=1.0.0"
@@ -225,15 +185,11 @@ defmodule Sentry.Integrations.Phoenix.TransactionTest do
 
       get(conn, ~p"/users")
 
-      transactions = collect_envelopes(ref, 2) |> extract_transactions()
-
-      mount_tx =
-        Enum.find(transactions, fn t ->
-          t["transaction"] == "PhoenixAppWeb.UserLive.Index.mount"
-        end)
-
-      assert mount_tx != nil
-      assert mount_tx["contexts"]["trace"]["trace_id"] == trace_id
+      find_sentry_transaction!(ref,
+        count: 2,
+        transaction: "PhoenixAppWeb.UserLive.Index.mount",
+        contexts: %{trace: %{trace_id: trace_id}}
+      )
     end
   end
 end