Helpers for e2e tests

Author: solnic

spec/features/tracing_spec.rb

@@ -11,17 +11,17 @@
 
     events_data = get_rails_events
 
-    expect(events_data["event_count"]).to be > 0
+    expect(events_data[:event_count]).to be > 0
 
-    error_events = events_data["events"].select { |event| event["exception"] }
+    error_events = events_data[:events].select { |event| event["exception"] }
     expect(error_events).not_to be_empty
 
     error_event = error_events.first
     exception_values = error_event.dig("exception", "values")
     expect(exception_values).not_to be_empty
     expect(exception_values.first["type"]).to eq("ZeroDivisionError")
 
-    transaction_events = events_data["events"].select { |event| event["type"] == "transaction" }
+    transaction_events = events_data[:events].select { |event| event["type"] == "transaction" }
 
     expect(error_event.dig("contexts", "trace")).not_to be_nil
     error_trace_id = error_event.dig("contexts", "trace", "trace_id")
@@ -47,7 +47,7 @@
       end
     end
 
-    events_data["envelopes"].each do |envelope|
+    events_data[:envelopes].each do |envelope|
       envelope["items"].each do |item|
         if item["payload"] && item["payload"]["_meta"] && item["payload"]["_meta"]["dsc"]
           dsc = item["payload"]["_meta"]["dsc"]
@@ -59,54 +59,4 @@
       end
     end
   end
-
-  private
-
-  def get_rails_events
-    log_file_path = File.join(Dir.pwd, "log", "sentry_debug_events.log")
-
-    return { "events" => [], "envelopes" => [], "event_count" => 0, "envelope_count" => 0 } unless File.exist?(log_file_path)
-
-    events = []
-    File.readlines(log_file_path).each do |line|
-      line = line.strip
-      next if line.empty?
-
-      begin
-        events << JSON.parse(line)
-      rescue JSON::ParserError => e
-        puts "Failed to parse line: #{line}, error: #{e.message}"
-      end
-    end
-
-    extracted_events = []
-    envelopes = []
-
-    events.each do |event_data|
-      envelopes << {
-        "headers" => event_data["envelope_headers"],
-        "items" => event_data["items"]
-      }
-
-      # Extract actual events from envelope items
-      event_data["items"].each do |item|
-        if item["headers"]["type"] == "event"
-          extracted_events << item["payload"]
-        end
-      end
-    end
-
-    {
-      "events" => extracted_events,
-      "envelopes" => envelopes,
-      "event_count" => extracted_events.length,
-      "envelope_count" => envelopes.length,
-      "raw_events" => events
-    }
-  end
-
-  def clear_rails_events
-    log_file_path = File.join(Dir.pwd, "log", "sentry_debug_events.log")
-    File.write(log_file_path, "") if File.exist?(log_file_path)
-  end
 end

spec/spec_helper.rb

@@ -8,6 +8,8 @@
 require "capybara"
 require "capybara/rspec"
 
+require_relative "support/test_helper"
+
 Capybara.configure do |config|
   config.default_driver = :selenium_headless_chrome
   config.javascript_driver = :selenium_headless_chrome
@@ -29,4 +31,12 @@
 
 RSpec.configure do |config|
   config.include(Capybara::DSL, type: :e2e)
+
+  config.include(Test::Helper)
+
+  config.before(:suite) do
+    Test::Helper.perform_basic_setup do |config|
+      config.transport.transport_class = Sentry::DebugTransport
+    end
+  end
 end

spec/support/test_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Test
+  module Helper
+    module_function
+
+    def get_rails_events
+      extracted_events = []
+      envelopes = []
+
+      logged_envelopes.each do |event_data|
+        envelopes << {
+          "headers" => event_data["envelope_headers"],
+          "items" => event_data["items"]
+        }
+
+        event_data["items"].each do |item|
+          if item["headers"]["type"] == "event"
+            extracted_events << item["payload"]
+          end
+        end
+      end
+
+      {
+        events: extracted_events,
+        envelopes: envelopes,
+        event_count: extracted_events.length,
+        envelope_count: envelopes.length
+      }
+    end
+
+    def logged_envelopes
+      Sentry.get_current_client.transport.logged_envelopes
+    end
+
+    # TODO: move this to a shared helper for all gems
+    def perform_basic_setup
+      Sentry.init do |config|
+        config.sdk_logger = Logger.new(nil)
+        config.dsn = Sentry::TestHelper::DUMMY_DSN
+        config.transport.transport_class = Sentry::DummyTransport
+        # so the events will be sent synchronously for testing
+        config.background_worker_threads = 0
+        yield(config) if block_given?
+      end
+    end
+  end
+end