Cleanup use of test helpers (#501)

* Cleanup use of test helpers

* Update ubuntu in github actions workflow

* Events too

* Use just one helper for all event types

* cleanup

Author: binaryseed

.github/workflows/elixir.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   unit_test:
     name: Unit Tests - Elixir ${{matrix.elixir}} / OTP ${{matrix.otp}}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     continue-on-error: true
 
     strategy:

examples/apps/absinthe_example/test/absinthe_example_test.exs

@@ -27,39 +27,16 @@ defmodule AbsintheExampleTest do
     [%{spans: spans}] = TestHelper.gather_harvest(TelemetrySdk.Spans.Harvester)
 
     spansaction =
-      Enum.find(spans, fn %{attributes: attr} ->
-        attr[:name] == "Absinthe/AbsintheExample.Schema/query/one.two.three"
-      end)
-
-    tx_root_process =
-      Enum.find(spans, fn %{attributes: attr} ->
-        attr[:name] == "Transaction Root Process"
-      end)
-
-    process =
-      Enum.find(spans, fn %{attributes: attr} ->
-        attr[:name] == "Process"
-      end)
-
-    operation =
-      Enum.find(spans, fn %{attributes: attr} ->
-        attr[:name] == "Absinthe/Operation/query:TestQuery"
-      end)
-
-    one_resolver =
-      Enum.find(spans, fn %{attributes: attr} ->
-        attr[:name] == "&AbsintheExample.Resolvers.one/3"
-      end)
-
-    three_resolver =
-      Enum.find(spans, fn %{attributes: attr} ->
-        attr[:name] == "&AbsintheExample.Resolvers.three/3"
-      end)
+      TestHelper.find_event(spans, "Absinthe/AbsintheExample.Schema/query/one.two.three")
+
+    tx_root_process = TestHelper.find_event(spans, "Transaction Root Process")
+    process = TestHelper.find_event(spans, "Process")
+    operation = TestHelper.find_event(spans, "Absinthe/Operation/query:TestQuery")
+    one_resolver = TestHelper.find_event(spans, "&AbsintheExample.Resolvers.one/3")
+    three_resolver = TestHelper.find_event(spans, "&AbsintheExample.Resolvers.three/3")
 
     do_three_fn_trace =
-      Enum.find(spans, fn %{attributes: attr} ->
-        attr[:name] == "AbsintheExample.Resolvers.do_three/1"
-      end)
+      TestHelper.find_event(spans, "AbsintheExample.Resolvers.do_three/1")
 
     assert operation.attributes[:"absinthe.operation.name"] == "TestQuery"
     assert operation.attributes[:"absinthe.operation.type"] == "query"

examples/apps/oban_example/test/oban_example_test.exs

@@ -16,31 +16,25 @@ defmodule ObanExampleTest do
     |> Oban.insert()
 
     metrics = TestHelper.gather_harvest(Collector.Metric.Harvester)
-    [event | _] = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+    events = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
 
     assert TestHelper.find_metric(
              metrics,
              "OtherTransaction/Oban/default/ObanExample.Worker/perform",
              1
            )
 
-    assert [
-             %{
-               :name => "OtherTransaction/Oban/default/ObanExample.Worker/perform",
-               :timestamp => timestamp,
-               :duration => duration
-             },
-             %{
-               :"oban.worker" => "ObanExample.Worker",
-               :"oban.queue" => "default",
-               :"oban.job.result" => "success",
-               :"oban.job.tags" => "foo,bar"
-             }
-           ] = event
+    event =
+      TestHelper.find_event(events, "OtherTransaction/Oban/default/ObanExample.Worker/perform")
 
-    assert timestamp |> is_number
-    assert duration >= 0.015
-    assert duration <= 0.065
+    assert event[:timestamp] |> is_number
+    assert event[:duration] >= 0.015
+    assert event[:duration] <= 0.065
+    assert event[:duration] <= 0.065
+    assert event[:"oban.worker"] == "ObanExample.Worker"
+    assert event[:"oban.queue"] == "default"
+    assert event[:"oban.job.result"] == "success"
+    assert event[:"oban.job.tags"] == "foo,bar"
   end
 
   test "instruments a failed job" do
@@ -51,24 +45,23 @@ defmodule ObanExampleTest do
     |> Oban.insert()
 
     metrics = TestHelper.gather_harvest(Collector.Metric.Harvester)
-    [event | _] = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+    events = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
 
     assert TestHelper.find_metric(
              metrics,
              "OtherTransaction/Oban/default/ObanExample.Worker/perform",
              1
            )
 
-    assert [
-             %{:name => "OtherTransaction/Oban/default/ObanExample.Worker/perform"},
-             %{
-               :error => true,
-               :error_kind => :error,
-               :"oban.worker" => "ObanExample.Worker",
-               :"oban.queue" => "default",
-               :"oban.job.result" => "failure",
-               :"oban.job.tags" => "foo,bar"
-             }
-           ] = event
+    event =
+      TestHelper.find_event(events, "OtherTransaction/Oban/default/ObanExample.Worker/perform")
+
+    assert event[:timestamp] |> is_number
+    assert event[:error] == true
+    assert event[:error_kind] == :error
+    assert event[:"oban.worker"] == "ObanExample.Worker"
+    assert event[:"oban.queue"] == "default"
+    assert event[:"oban.job.result"] == "failure"
+    assert event[:"oban.job.tags"] == "foo,bar"
   end
 end

examples/apps/phx_example/test/phx_example_test.exs

@@ -29,7 +29,13 @@ defmodule PhxExampleTest do
                  "WebTransaction/Phoenix/PhxExampleWeb.PageController/index"
                )
 
-        [[_, event]] = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+        events = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+
+        event =
+          TestHelper.find_event(
+            events,
+            "WebTransaction/Phoenix/PhxExampleWeb.PageController/index"
+          )
 
         if event[:"bandit.resp_duration_ms"] do
           assert event[:"bandit.resp_duration_ms"] > 0
@@ -64,7 +70,10 @@ defmodule PhxExampleTest do
                  "WebTransaction/Phoenix/PhxExampleWeb.HomeLive/index"
                )
 
-        [[_, event]] = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+        events = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+
+        event =
+          TestHelper.find_event(events, "WebTransaction/Phoenix/PhxExampleWeb.HomeLive/index")
 
         assert event[:"phoenix.endpoint"] =~ "PhxExampleWeb"
         assert event[:"phoenix.router"] == "PhxExampleWeb.Router"
@@ -79,9 +88,9 @@ defmodule PhxExampleTest do
 
         span_events = TestHelper.gather_harvest(Collector.SpanEvent.Harvester)
 
-        tx_span = TestHelper.find_span(span_events, "/Phoenix/PhxExampleWeb.HomeLive/index")
-        process_span = TestHelper.find_span(span_events, "Transaction Root Process")
-        mount_span = TestHelper.find_span(span_events, "PhxExampleWeb.HomeLive:index.mount")
+        tx_span = TestHelper.find_event(span_events, "/Phoenix/PhxExampleWeb.HomeLive/index")
+        process_span = TestHelper.find_event(span_events, "Transaction Root Process")
+        mount_span = TestHelper.find_event(span_events, "PhxExampleWeb.HomeLive:index.mount")
 
         assert process_span[:parentId] == tx_span[:guid]
         assert mount_span[:"live_view.params"]
@@ -104,11 +113,14 @@ defmodule PhxExampleTest do
         span_events = TestHelper.gather_harvest(Collector.SpanEvent.Harvester)
 
         tx_span =
-          TestHelper.find_span(span_events, "/Phoenix.LiveView/Live/PhxExampleWeb.HomeLive/index")
+          TestHelper.find_event(
+            span_events,
+            "/Phoenix.LiveView/Live/PhxExampleWeb.HomeLive/index"
+          )
 
-        process_span = TestHelper.find_span(span_events, "Transaction Root Process")
-        mount_span = TestHelper.find_span(span_events, "PhxExampleWeb.HomeLive:index.mount")
-        render_span = TestHelper.find_span(span_events, "PhxExampleWeb.HomeLive:index.render")
+        process_span = TestHelper.find_event(span_events, "Transaction Root Process")
+        mount_span = TestHelper.find_event(span_events, "PhxExampleWeb.HomeLive:index.mount")
+        render_span = TestHelper.find_event(span_events, "PhxExampleWeb.HomeLive:index.render")
 
         assert tx_span[:"live_view.endpoint"] == "PhxExampleWeb.Endpoint"
 
@@ -130,7 +142,13 @@ defmodule PhxExampleTest do
                  "WebTransaction/Phoenix/PhxExampleWeb.PageController/error"
                )
 
-        [[_, event]] = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+        events = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+
+        event =
+          TestHelper.find_event(
+            events,
+            "WebTransaction/Phoenix/PhxExampleWeb.PageController/error"
+          )
 
         assert event[:status] == 500
         assert event[:"phoenix.endpoint"] =~ "PhxExampleWeb"
@@ -153,7 +171,10 @@ defmodule PhxExampleTest do
                  "WebTransaction/Phoenix/PhxExampleWeb.ErrorLive/index"
                )
 
-        [[_, event]] = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+        events = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+
+        event =
+          TestHelper.find_event(events, "WebTransaction/Phoenix/PhxExampleWeb.ErrorLive/index")
 
         assert event[:status] == 500
         assert event[:"phoenix.endpoint"] =~ "PhxExampleWeb"
@@ -177,7 +198,8 @@ defmodule PhxExampleTest do
 
         assert TestHelper.find_metric(metrics, metric)
 
-        [[_, event]] = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+        events = TestHelper.gather_harvest(Collector.TransactionEvent.Harvester)
+        event = TestHelper.find_event(events, metric)
 
         assert event[:status] == 404
         assert event[:"phoenix.endpoint"] =~ "PhxExampleWeb"

examples/apps/redix_example/test/redix_example_test.exs

@@ -55,8 +55,7 @@ defmodule RedixExampleTest do
 
     span_events = TestHelper.gather_harvest(Collector.SpanEvent.Harvester)
 
-    [get_event, _, _] =
-      Enum.find(span_events, fn [ev, _, _] -> ev[:name] == "Datastore/operation/Redis/GET" end)
+    get_event = TestHelper.find_event(span_events, "Datastore/operation/Redis/GET")
 
     assert get_event[:"peer.address"] == "localhost:6379"
     assert get_event[:"db.statement"] == "GET mykey"
@@ -65,18 +64,14 @@ defmodule RedixExampleTest do
     assert get_event[:timestamp] |> is_number
     assert get_event[:duration] > 0.0
 
-    [pipeline_event, _, _] =
-      Enum.find(span_events, fn [ev, _, _] ->
-        ev[:name] == "Datastore/operation/Redis/PIPELINE"
-      end)
+    pipeline_event = TestHelper.find_event(span_events, "Datastore/operation/Redis/PIPELINE")
 
     assert pipeline_event[:"peer.address"] == "localhost:6379"
 
     assert pipeline_event[:"db.statement"] ==
              "DEL counter; INCR counter; INCR counter; GET counter"
 
-    [hset_event, _, _] =
-      Enum.find(span_events, fn [ev, _, _] -> ev[:name] == "Datastore/operation/Redis/HSET" end)
+    hset_event = TestHelper.find_event(span_events, "Datastore/operation/Redis/HSET")
 
     assert hset_event[:"peer.address"] == "localhost:6379"
   end
@@ -89,10 +84,7 @@ defmodule RedixExampleTest do
 
     span_events = TestHelper.gather_harvest(Collector.SpanEvent.Harvester)
 
-    [err_event, _, _] =
-      Enum.find(span_events, fn [ev, _, _] ->
-        ev[:name] == "Datastore/operation/Redis/PIPELINE"
-      end)
+    err_event = TestHelper.find_event(span_events, "Datastore/operation/Redis/PIPELINE")
 
     assert err_event[:"peer.address"] == "localhost:6379"
     # On elixir 1.14 OTP 26, the error message is "unknown POSIX error: timeout"

test/aggregate_test.exs

@@ -43,8 +43,6 @@ defmodule AggregateTest do
 
     events = TestHelper.gather_harvest(Collector.CustomEvent.Harvester)
 
-    assert Enum.find(events, fn [_, event, _] ->
-             event[:category] == "Metric" && event[:meta] == "data" && event[:duration] == 15
-           end)
+    assert TestHelper.find_event(events, %{category: "Metric", meta: "data", duration: 15})
   end
 end

test/backoff_sampler_test.exs

@@ -97,9 +97,9 @@ defmodule BackoffSamplerTest do
            })
   end
 
-  @sampling_target 100
+  @sampling_target_period 100
   test "cycles trigger" do
-    TestHelper.run_with(:application_config, sampling_target_period: @sampling_target)
+    TestHelper.run_with(:application_config, sampling_target_period: @sampling_target_period)
 
     BackoffSampler.reset()
     BackoffSampler.trigger_next_cycle()
@@ -123,7 +123,7 @@ defmodule BackoffSamplerTest do
     refute BackoffSampler.sample?()
 
     # Wait until the next cycle
-    Process.sleep(@sampling_target + 10)
+    Process.sleep(@sampling_target_period + 10)
 
     # Next cycle it will adjust and take some, but not all
     decisions = [

test/custom_event_test.exs

@@ -60,10 +60,11 @@ defmodule CustomEventTest do
   test "user attributes can be truncated" do
     TestHelper.restart_harvest_cycle(Collector.CustomEvent.HarvestCycle)
 
-    NewRelic.report_custom_event("CustomEventTest", %{long_entry: String.duplicate("1", 5000)})
+    NewRelic.report_custom_event("CustomEventTest", %{name: "long", long_entry: String.duplicate("1", 5000)})
 
-    [[_, attrs, _]] = TestHelper.gather_harvest(Collector.CustomEvent.Harvester)
-    assert String.length(attrs.long_entry) == 4095
+    events = TestHelper.gather_harvest(Collector.CustomEvent.Harvester)
+    event = TestHelper.find_event(events, "long")
+    assert String.length(event.long_entry) == 4095
 
     TestHelper.pause_harvest_cycle(Collector.CustomEvent.HarvestCycle)
   end
@@ -140,9 +141,7 @@ defmodule CustomEventTest do
     events = TestHelper.gather_harvest(Collector.CustomEvent.Harvester)
     NewRelic.JSON.encode!(events)
 
-    [[_, attrs, _]] = events
-    assert attrs[:bad_value] == "[BAD_VALUE]"
-    assert attrs[:good_value] == "A string"
+    assert TestHelper.find_event(events, %{good_value: "A string", bad_value: "[BAD_VALUE]"})
 
     TestHelper.pause_harvest_cycle(Collector.CustomEvent.HarvestCycle)
   end
@@ -169,9 +168,7 @@ defmodule CustomEventTest do
 
     events = TestHelper.gather_harvest(Collector.CustomEvent.Harvester)
 
-    assert Enum.find(events, fn [_, event, _] ->
-             event[:key] == "TestEvent" && event[:test_attribute] == "test_value"
-           end)
+    assert TestHelper.find_event(events, %{key: "TestEvent", test_attribute: "test_value"})
   end
 
   test "Respect the reservoir_size" do