raygun4ruby 3.2.6 → 4.0.0

data/test/unit/configuration_test.rb

@@ -1,206 +1,202 @@
-require_relative "../test_helper.rb"
-
-class ConfigurationTest < Raygun::UnitTest
-
-  class TestException < StandardError; end
-  class Test2Exception < StandardError; end
-
-  def setup
-    Raygun.setup do |config|
-      config.api_key = "a test api key"
-      config.version = 9.9
-    end
-  end
-
-  def teardown
-    Raygun.reset_configuration
-  end
-
-  def test_setting_api_key_and_version
-    assert_equal 9.9,              Raygun.configuration.version
-    assert_equal "a test api key", Raygun.configuration.api_key
-  end
-
-  def test_hash_style_access
-    assert_equal 9.9, Raygun.configuration[:version]
-  end
-
-  def test_set_js_api_key
-    Raygun.configuration.js_api_key = "a test js api key"
-
-    assert_equal "a test js api key", Raygun.configuration.js_api_key
-  end
-
-  def test_set_js_api_version
-    Raygun.configuration.js_api_version = "a test js api version"
-
-    assert_equal "a test js api version", Raygun.configuration.js_api_version
-  end
-
-  def test_enable_reporting
-    Raygun.configuration.enable_reporting = false
-
-    # should be no API call
-    assert_nil Raygun.track_exception(TestException.new)
-  end
-
-  def test_silence_reporting
-    Raygun.configuration.silence_reporting = true
-
-    # nothing returned as there's no HTTP call
-    assert_nil Raygun.track_exception(TestException.new)
-  end
-
-  def test_ignoring_exceptions
-    Raygun.configuration.ignore << TestException.to_s
-
-    assert_nil Raygun.track_exception(TestException.new)
-  end
-
-  def test_ignoring_multiple_exceptions
-    Raygun.configuration.ignore << [TestException.to_s, Test2Exception.to_s]
-
-    assert_nil Raygun.track_exception(TestException.new)
-    assert_nil Raygun.track_exception(Test2Exception.new)
-  end
-
-  def test_default_values
-    assert_equal({}, Raygun.configuration.custom_data)
-  end
-
-  def test_default_tags_set
-    assert_equal([], Raygun.configuration.tags)
-  end
-
-  def test_overriding_defaults
-    Raygun.default_configuration.custom_data = { robby: "robot" }
-    assert_equal({ robby: "robot" }, Raygun.configuration.custom_data)
-
-    Raygun.configuration.custom_data = { sally: "stegosaurus" }
-    assert_equal({ sally: "stegosaurus" }, Raygun.configuration.custom_data)
-  end
-
-  def test_debug
-    Raygun.setup do |config|
-      config.debug = true
-    end
-
-    assert_equal Raygun.configuration.debug, true
-  end
-
-  def test_debug_default_set
-    assert_equal false, Raygun.configuration.debug
-  end
-
-  def test_setting_filter_paramters_to_proc
-    Raygun.setup do |config|
-      config.filter_parameters do |hash|
-        # Don't need to do anything :)
-      end
-    end
-
-    assert Raygun.configuration.filter_parameters.is_a?(Proc)
-  ensure
-    Raygun.configuration.filter_parameters = nil
-  end
-
-  def test_filter_payload_with_whitelist_default
-    assert_equal(false, Raygun.configuration.filter_payload_with_whitelist)
-  end
-
-  def test_setting_whitelist_payload_keys_to_proc
-    Raygun.setup do |config|
-      config.whitelist_payload_shape do |hash|
-        # No-op
-      end
-    end
-
-    assert Raygun.configuration.whitelist_payload_shape.is_a?(Proc)
-    ensure
-      Raygun.configuration.whitelist_payload_shape = nil
-  end
-
-  def test_setting_custom_data_to_proc
-    Raygun.setup do |config|
-      config.custom_data do |exception, env|
-        # No-op
-      end
-    end
-
-    assert Raygun.configuration.custom_data.is_a?(Proc)
-  ensure
-      Raygun.configuration.custom_data = nil
-  end
-
-  def test_setting_custom_data_to_hash
-    Raygun.setup do |config|
-      config.custom_data = {}
-    end
-
-    assert Raygun.configuration.custom_data.is_a?(Hash)
-  ensure
-      Raygun.configuration.custom_data = nil
-  end
-
-  def test_setting_tags_to_array
-    Raygun.setup do |c|
-      c.tags = ['test']
-    end
-
-    assert_equal Raygun.configuration.tags, ['test']
-  end
-
-  def test_setting_tags_to_proc
-    Raygun.setup do |c|
-      c.tags = ->(exception, env) {}
-    end
-
-    assert Raygun.configuration.tags.is_a?(Proc)
-  end
-
-  def test_api_url_default
-    assert_equal "https://api.raygun.com/", Raygun.configuration.api_url
-  end
-
-  def test_setting_breadcrumb_level
-    Raygun.setup do |config|
-      config.breadcrumb_level = :info
-    end
-
-    assert_equal :info, Raygun.configuration.breadcrumb_level
-  end
-
-  def test_setting_breadcrumb_level_to_bad_value
-    logger = setup_logging
-
-    Raygun.setup do |config|
-      config.breadcrumb_level = :invalid
-    end
-
-    assert_equal :info, Raygun.configuration.breadcrumb_level
-    assert(
-      logger.get.include?("unknown breadcrumb level"),
-      "unknown breadcrumb level message was not logged"
-    )
-  end
-
-  def test_breadcrumb_level_default
-    assert_equal :info, Raygun.configuration.breadcrumb_level
-  end
-
-  def test_record_raw_data_default
-    assert_equal false, Raygun.configuration.record_raw_data
-  end
-
-  def test_send_in_background_default
-    assert_equal false, Raygun.configuration.send_in_background
-  end
-
-  def test_error_report_send_timeout_default
-    assert_equal 10, Raygun.configuration.error_report_send_timeout
-  end
-
-  def test_enable_reporting_default
-    assert_equal true, Raygun.configuration.enable_reporting
-  end
-end
+require_relative "../test_helper.rb"
+
+class ConfigurationTest < Raygun::UnitTest
+
+  class TestException < StandardError; end
+  class Test2Exception < StandardError; end
+
+  def setup
+    Raygun.setup do |config|
+      config.api_key = "a test api key"
+      config.version = 9.9
+    end
+  end
+
+  def test_setting_api_key_and_version
+    assert_equal 9.9,              Raygun.configuration.version
+    assert_equal "a test api key", Raygun.configuration.api_key
+  end
+
+  def test_hash_style_access
+    assert_equal 9.9, Raygun.configuration[:version]
+  end
+
+  def test_set_js_api_key
+    Raygun.configuration.js_api_key = "a test js api key"
+
+    assert_equal "a test js api key", Raygun.configuration.js_api_key
+  end
+
+  def test_set_js_api_version
+    Raygun.configuration.js_api_version = "a test js api version"
+
+    assert_equal "a test js api version", Raygun.configuration.js_api_version
+  end
+
+  def test_enable_reporting
+    Raygun.configuration.enable_reporting = false
+
+    # should be no API call
+    assert_nil Raygun.track_exception(TestException.new)
+  end
+
+  def test_silence_reporting
+    Raygun.configuration.silence_reporting = true
+
+    # nothing returned as there's no HTTP call
+    assert_nil Raygun.track_exception(TestException.new)
+  end
+
+  def test_ignoring_exceptions
+    Raygun.configuration.ignore << TestException.to_s
+
+    assert_nil Raygun.track_exception(TestException.new)
+  end
+
+  def test_ignoring_multiple_exceptions
+    Raygun.configuration.ignore << [TestException.to_s, Test2Exception.to_s]
+
+    assert_nil Raygun.track_exception(TestException.new)
+    assert_nil Raygun.track_exception(Test2Exception.new)
+  end
+
+  def test_default_values
+    assert_equal({}, Raygun.configuration.custom_data)
+  end
+
+  def test_default_tags_set
+    assert_equal([], Raygun.configuration.tags)
+  end
+
+  def test_overriding_defaults
+    Raygun.default_configuration.custom_data = { robby: "robot" }
+    assert_equal({ robby: "robot" }, Raygun.configuration.custom_data)
+
+    Raygun.configuration.custom_data = { sally: "stegosaurus" }
+    assert_equal({ sally: "stegosaurus" }, Raygun.configuration.custom_data)
+  end
+
+  def test_debug
+    Raygun.setup do |config|
+      config.debug = true
+    end
+
+    assert_equal Raygun.configuration.debug, true
+  end
+
+  def test_debug_default_set
+    assert_equal false, Raygun.configuration.debug
+  end
+
+  def test_setting_filter_paramters_to_proc
+    Raygun.setup do |config|
+      config.filter_parameters do |hash|
+        # Don't need to do anything :)
+      end
+    end
+
+    assert Raygun.configuration.filter_parameters.is_a?(Proc)
+  ensure
+    Raygun.configuration.filter_parameters = nil
+  end
+
+  def test_filter_payload_with_whitelist_default
+    assert_equal(false, Raygun.configuration.filter_payload_with_whitelist)
+  end
+
+  def test_setting_whitelist_payload_keys_to_proc
+    Raygun.setup do |config|
+      config.whitelist_payload_shape do |hash|
+        # No-op
+      end
+    end
+
+    assert Raygun.configuration.whitelist_payload_shape.is_a?(Proc)
+  ensure
+    Raygun.configuration.whitelist_payload_shape = nil
+  end
+
+  def test_setting_custom_data_to_proc
+    Raygun.setup do |config|
+      config.custom_data do |exception, env|
+        # No-op
+      end
+    end
+
+    assert Raygun.configuration.custom_data.is_a?(Proc)
+  ensure
+      Raygun.configuration.custom_data = nil
+  end
+
+  def test_setting_custom_data_to_hash
+    Raygun.setup do |config|
+      config.custom_data = {}
+    end
+
+    assert Raygun.configuration.custom_data.is_a?(Hash)
+  ensure
+      Raygun.configuration.custom_data = nil
+  end
+
+  def test_setting_tags_to_array
+    Raygun.setup do |c|
+      c.tags = ['test']
+    end
+
+    assert_equal Raygun.configuration.tags, ['test']
+  end
+
+  def test_setting_tags_to_proc
+    Raygun.setup do |c|
+      c.tags = ->(exception, env) {}
+    end
+
+    assert Raygun.configuration.tags.is_a?(Proc)
+  end
+
+  def test_api_url_default
+    assert_equal "https://api.raygun.com/", Raygun.configuration.api_url
+  end
+
+  def test_setting_breadcrumb_level
+    Raygun.setup do |config|
+      config.breadcrumb_level = :info
+    end
+
+    assert_equal :info, Raygun.configuration.breadcrumb_level
+  end
+
+  def test_setting_breadcrumb_level_to_bad_value
+    logger = setup_logging
+
+    Raygun.setup do |config|
+      config.breadcrumb_level = :invalid
+    end
+
+    assert_equal :info, Raygun.configuration.breadcrumb_level
+    assert(
+      logger.get.include?("unknown breadcrumb level"),
+      "unknown breadcrumb level message was not logged"
+    )
+  end
+
+  def test_breadcrumb_level_default
+    assert_equal :info, Raygun.configuration.breadcrumb_level
+  end
+
+  def test_record_raw_data_default
+    assert_equal false, Raygun.configuration.record_raw_data
+  end
+
+  def test_send_in_background_default
+    assert_equal false, Raygun.configuration.send_in_background
+  end
+
+  def test_error_report_send_timeout_default
+    assert_equal 10, Raygun.configuration.error_report_send_timeout
+  end
+
+  def test_enable_reporting_default
+    assert_equal true, Raygun.configuration.enable_reporting
+  end
+end

data/test/unit/error_subscriber_test.rb

@@ -0,0 +1,43 @@
+require_relative "../test_helper.rb"
+
+class ErrorSubscriberTest < Raygun::UnitTest
+
+  def setup
+    super
+    Raygun.configuration.send_in_background = false
+  end
+
+
+  def test_tracking_exception_via_subscriber
+    body_matcher = lambda do |body|
+      json = JSON.parse(body)
+      details = json["details"]
+
+      details["userCustomData"] && 
+        details["userCustomData"]["rails.error"] &&
+        details["userCustomData"]["rails.error"]["handled"] == true &&
+        details["tags"] == ["rails_error_reporter", "test_tag", "test"]
+    end
+
+    request_stub = stub_request(:post, 'https://api.raygun.com/entries')
+      .with(
+        body: body_matcher
+      )
+      .to_return(status: 202).times(1)
+
+    result = Raygun::ErrorSubscriber.new.report(
+      StandardError.new("test error"),
+      handled: true,
+      severity: "warning",
+      context: {
+        tags: ["test_tag"]
+      },
+      source: "application"
+    )
+
+    assert result && result.success?, "Expected success, got #{result.class}, #{result.inspect}"
+
+    assert_requested request_stub
+  end
+
+end

data/test/unit/raygun_test.rb

@@ -1,25 +1,106 @@
-# -*- coding: utf-8 -*-
-require_relative "../test_helper.rb"
-
-class RaygunTest < Raygun::UnitTest
-  def test_raygun_is_not_configured_with_no_api_key
-    Raygun.configuration.api_key = nil
-    assert !Raygun.configured?
-  end
-
-  def test_should_report_logs_silence_reporting_when_debug_is_on
-    logger = setup_logging
-    Raygun.configuration.silence_reporting = true
-    Raygun.send(:should_report?, Exception.new)
-
-    assert logger.get.include?("silence_reporting"), "silence_reporting was not logged"
-  end
-
-  def test_should_report_logs_ignored_exceptions_when_debug_is_on
-    logger = setup_logging
-    Raygun.configuration.ignore = ["Exception"]
-    Raygun.send(:should_report?, Exception.new)
-
-    assert logger.get =~ /skipping reporting of.*Exception.*/, "ignored exception was not logged"
-  end
-end
+# -*- coding: utf-8 -*-
+require_relative "../test_helper.rb"
+
+class RaygunTest < Raygun::UnitTest
+  def test_raygun_is_not_configured_with_no_api_key
+    Raygun.configuration.api_key = nil
+    assert !Raygun.configured?
+  end
+
+  def test_should_report_logs_silence_reporting_when_debug_is_on
+    logger = setup_logging
+    Raygun.configuration.silence_reporting = true
+    Raygun.send(:should_report?, Exception.new)
+
+    assert logger.get.include?("silence_reporting"), "silence_reporting was not logged"
+  end
+
+  def test_should_report_logs_ignored_exceptions_when_debug_is_on
+    logger = setup_logging
+    Raygun.configuration.ignore = ["Exception"]
+    Raygun.send(:should_report?, Exception.new)
+
+    assert logger.get =~ /skipping reporting of.*Exception.*/, "ignored exception was not logged"
+  end
+
+  class BackgroundSendTest < Raygun::UnitTest
+    def setup
+      @failsafe_logger = FakeLogger.new
+      Raygun.setup do |c|
+        c.silence_reporting = false
+        c.send_in_background = true
+        c.api_url = "http://example.api"
+        c.api_key = "foo"
+        c.debug = false
+        c.failsafe_logger = @failsafe_logger
+      end
+    end
+
+    def test_breadcrumb_context_passed
+      Raygun::Breadcrumbs::Store.initialize      
+      Raygun.record_breadcrumb(message: "mmm crumbly")
+      assert Raygun::Breadcrumbs::Store.any?
+
+      stub_request(:post, "http://example.api/entries")
+        .with(body: hash_including(breadcrumbs: [ hash_including(message: "mmm crumbly") ]))
+        .to_return(status: 202)
+
+      Raygun.track_exception(StandardError.new)
+      Raygun.wait_for_futures
+    ensure
+      Raygun::Breadcrumbs::Store.clear
+    end
+
+    def test_failsafe_reported_on_timeout
+      stub_request(:post, "http://example.api/entries").to_timeout
+
+      error = StandardError.new
+
+      Raygun.track_exception(error)
+
+      Raygun.wait_for_futures
+      assert_match(/Problem reporting exception to Raygun/, @failsafe_logger.get)
+    end
+
+  end
+
+  class ErrorSubscriberTest < Raygun::UnitTest
+    def setup
+      Raygun.setup do |c|
+        c.api_key = "test"
+        c.silence_reporting = false
+        c.debug = true
+        c.register_rails_error_handler = true
+      end
+
+      Raygun::Railtie.setup_error_subscriber
+    end
+
+    def test_registers_with_rails
+      if ::Rails.version.to_f >= 7.0
+        assert Rails.error.instance_variable_get("@subscribers").any? { |s| s.is_a?(Raygun::ErrorSubscriber) }
+      end
+    end
+
+    def test_reports_exceptions
+      if ::Rails.version.to_f >= 7.0
+        stub_request(:post, "https://api.raygun.com/entries").to_return(status: 202)
+
+        Rails.error.handle do
+          raise StandardError.new("test rails handling")
+        end
+      end
+    end
+  end
+
+  def test_reset_configuration
+    Raygun.setup do |c|
+      c.api_url = "http://test.api"
+    end
+
+    original_api_url = Raygun.configuration.api_url
+    Raygun.reset_configuration
+    assert_equal Raygun.default_configuration.api_url, Raygun.configuration.api_url
+    refute_equal original_api_url, Raygun.configuration.api_url
+  end
+end

data/test/unit/resque_failure_test.rb

@@ -1,24 +1,27 @@
-require_relative "../test_helper.rb"
-
-# Very simple test
-class ResqueFailureTest < Raygun::UnitTest
-
-  require "resque/failure/raygun"
-
-  def setup
-    super
-
-    stub_request(:post, 'https://api.raygun.com/entries').to_return(status: 202)
-    fake_successful_entry
-  end
-
-  def test_failure_backend_appears_to_work
-    assert Resque::Failure::Raygun.new(
-      StandardError.new("Worker Problem"),
-      "TestWorker PID 123",
-      "super_important_jobs",
-      class: "SendCookies", args: [ "nik" ]
-    ).save.success?
-  end
-
-end
+require_relative "../test_helper.rb"
+
+# Very simple test
+class ResqueFailureTest < Raygun::UnitTest
+
+  require "resque/failure/raygun"
+
+  def setup
+    super
+    Raygun.configuration.send_in_background = false
+
+    stub_request(:post, 'https://api.raygun.com/entries').to_return(status: 202)
+    fake_successful_entry
+  end
+
+  def test_failure_backend_appears_to_work
+    result = Resque::Failure::Raygun.new(
+      StandardError.new("Worker Problem"),
+      "TestWorker PID 123",
+      "super_important_jobs",
+      class: "SendCookies", args: [ "nik" ]
+    ).save
+    
+    assert result && result.success?, "Expected success, got #{result.inspect}"
+  end
+
+end