exception_handling 2.17.0.pre.tstarck.1 → 3.0.pre.1

data/test/unit/exception_handling_test.rb

@@ -0,0 +1,1109 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper',  __dir__)
+require_test_helper 'controller_helpers'
+require_test_helper 'exception_helpers'
+
+class ExceptionHandlingTest < ActiveSupport::TestCase
+  include ControllerHelpers
+  include ExceptionHelpers
+
+  def dont_stub_log_error
+    true
+  end
+
+  def append_organization_info_config(data)
+    data[:user_details]                = {}
+    data[:user_details][:username]     = "CaryP"
+    data[:user_details][:organization] = "Invoca Engineering Dept."
+  rescue StandardError
+    # don't let these out!
+  end
+
+  def custom_data_callback_returns_nil_message_exception(_data)
+    raise_exception_with_nil_message
+  end
+
+  def log_error_callback(_data, _ex, _treat_like_warning, _honeybadger_status)
+    @fail_count += 1
+  end
+
+  def log_error_callback_config(data, _ex, treat_like_warning, honeybadger_status)
+    @callback_data = data
+    @treat_like_warning = treat_like_warning
+    @fail_count += 1
+    @honeybadger_status = honeybadger_status
+  end
+
+  def log_error_callback_with_failure(_data, _ex)
+    raise "this should be rescued"
+  end
+
+  def log_error_callback_returns_nil_message_exception(_data, _ex)
+    raise_exception_with_nil_message
+  end
+
+  module EventMachineStub
+    class << self
+      attr_accessor :block
+
+      def schedule(&block)
+        @block = block
+      end
+    end
+  end
+
+  class DNSResolvStub
+    class << self
+      attr_accessor :callback_block
+      attr_accessor :errback_block
+
+      def resolve(_hostname)
+        self
+      end
+
+      def callback(&block)
+        @callback_block = block
+      end
+
+      def errback(&block)
+        @errback_block = block
+      end
+    end
+  end
+
+  class SmtpClientStub
+    class << self
+      attr_reader :block
+      attr_reader :last_method
+
+      def errback(&block)
+        @block = block
+      end
+
+      def send_hash
+        @send_hash ||= {}
+      end
+
+      def send(hash)
+        @last_method = :send
+        send_hash.clear
+        send_hash.merge!(hash)
+        self
+      end
+
+      def asend(hash)
+        send(hash)
+        @last_method = :asend
+        self
+      end
+    end
+  end
+
+  class SmtpClientErrbackStub < SmtpClientStub
+  end
+
+  context "with warn and honeybadger notify stubbed" do
+    setup do
+      stub(ExceptionHandling).warn(anything)
+      stub(Honeybadger).notify(anything)
+    end
+
+    context "#log_error" do
+      should "take in additional keyword args as logging context and pass them to the logger (using preferrred log_context:)" do
+        ExceptionHandling.log_error('This is an Error', 'This is the prefix context', service_name: 'exception_handling')
+        assert_match(/This is an Error/, logged_excluding_reload_filter.last[:message])
+        assert_not_empty logged_excluding_reload_filter.last[:context]
+        assert_equal({ service_name: 'exception_handling' }, logged_excluding_reload_filter.last[:context])
+      end
+
+      should "take in additional keyword args as logging context and pass them to the logger (using **)" do
+        ExceptionHandling.log_error('This is an Error', 'This is the prefix context', service_name: 'exception_handling')
+        assert_match(/This is an Error/, logged_excluding_reload_filter.last[:message])
+        assert_not_empty logged_excluding_reload_filter.last[:context]
+        assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
+      end
+    end
+
+    context "#log_warning" do
+      should "have empty array as a backtrace" do
+        mock(ExceptionHandling).log_error(is_a(ExceptionHandling::Warning), anything) do |error|
+          assert_equal [], error.backtrace
+        end
+        ExceptionHandling.log_warning('Now with empty array as a backtrace!')
+      end
+
+      should "take in additional key word args as logging context and pass them to the logger" do
+        ExceptionHandling.log_warning('This is a Warning', service_name: 'exception_handling')
+        assert_match(/This is a Warning/, logged_excluding_reload_filter.last[:message])
+        assert_not_empty logged_excluding_reload_filter.last[:context]
+        assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
+      end
+    end
+
+    context "#log_info" do
+      should "take in additional key word args as logging context and pass them to the logger" do
+        ExceptionHandling.log_warning('This is an Info', service_name: 'exception_handling')
+        assert_match(/This is an Info/, logged_excluding_reload_filter.last[:message])
+        assert_not_empty logged_excluding_reload_filter.last[:context]
+        assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
+      end
+    end
+
+    context "#log_debug" do
+      should "take in additional key word args as logging context and pass them to the logger" do
+        ExceptionHandling.log_warning('This is a Debug', service_name: 'exception_handling')
+        assert_match(/This is a Debug/, logged_excluding_reload_filter.last[:message])
+        assert_not_empty logged_excluding_reload_filter.last[:context]
+        assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
+      end
+    end
+
+    context "configuration with custom_data_hook or post_log_error_hook" do
+      teardown do
+        ExceptionHandling.custom_data_hook = nil
+        ExceptionHandling.post_log_error_hook = nil
+      end
+
+      should "support a custom_data_hook" do
+        capture_notifications
+
+        ExceptionHandling.custom_data_hook = method(:append_organization_info_config)
+        ExceptionHandling.ensure_safe("context") { raise "Some Exception" }
+
+        assert_match(/Invoca Engineering Dept./, sent_notifications.last.enhanced_data['user_details'].to_s)
+      end
+
+      should "support a log_error hook, and pass exception_data, treat_like_warning, and logged_to_honeybadger to it" do
+        @fail_count = 0
+        @honeybadger_status = nil
+        ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
+
+        notify_args = []
+        mock(Honeybadger).notify.with_any_args { |info| notify_args << info; '06220c5a-b471-41e5-baeb-de247da45a56' }
+        ExceptionHandling.ensure_safe("context") { raise "Some Exception" }
+        assert_equal 1, @fail_count
+        assert_equal false, @treat_like_warning
+        assert_equal :success, @honeybadger_status
+
+        assert_equal "this is used by a test", @callback_data["notes"]
+        assert_equal 1, notify_args.size, notify_args.inspect
+        assert_match(/this is used by a test/, notify_args.last[:context].to_s)
+      end
+
+      should "plumb treat_like_warning and logged_to_honeybadger to log error hook" do
+        @fail_count = 0
+        @honeybadger_status = nil
+        ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
+        ExceptionHandling.log_error(StandardError.new("Some Exception"), "mooo", treat_like_warning: true)
+        assert_equal 1, @fail_count
+        assert_equal true, @treat_like_warning
+        assert_equal :skipped, @honeybadger_status
+      end
+
+      should "include logging context in the exception data" do
+        ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
+        ExceptionHandling.log_error(StandardError.new("Some Exception"), "mooo", treat_like_warning: true, log_context_test: "contextual_logging")
+
+        expected_log_context = {
+          "log_context_test" => "contextual_logging"
+        }
+        assert_equal expected_log_context, @callback_data[:log_context]
+      end
+
+      should "support rescue exceptions from a log_error hook" do
+        ExceptionHandling.post_log_error_hook = method(:log_error_callback_with_failure)
+        log_info_messages = []
+        stub(ExceptionHandling.logger).info.with_any_args do |message, _|
+          log_info_messages << message
+        end
+        assert_nothing_raised { ExceptionHandling.ensure_safe("mooo") { raise "Some Exception" } }
+        assert log_info_messages.find { |message| message =~ /Unable to execute custom log_error callback/ }
+      end
+
+      should "handle nil message exceptions resulting from the log_error hook" do
+        ExceptionHandling.post_log_error_hook = method(:log_error_callback_returns_nil_message_exception)
+        log_info_messages = []
+        stub(ExceptionHandling.logger).info.with_any_args do |message, _|
+          log_info_messages << message
+        end
+        assert_nothing_raised { ExceptionHandling.ensure_safe("mooo") { raise "Some Exception" } }
+        assert log_info_messages.find { |message| message =~ /Unable to execute custom log_error callback/ }
+      end
+
+      should "handle nil message exceptions resulting from the custom data hook" do
+        ExceptionHandling.custom_data_hook = method(:custom_data_callback_returns_nil_message_exception)
+        log_info_messages = []
+        stub(ExceptionHandling.logger).info.with_any_args do |message, _|
+          log_info_messages << message
+        end
+        assert_nothing_raised { ExceptionHandling.ensure_safe("mooo") { raise "Some Exception" } }
+        assert log_info_messages.find { |message| message =~ /Unable to execute custom custom_data_hook callback/ }
+      end
+    end
+
+    context "Exception Handling" do
+      context "default_metric_name" do
+        context "when metric_name is present in exception_data" do
+          should "include metric_name in resulting metric name" do
+            exception = StandardError.new('this is an exception')
+            metric    = ExceptionHandling.default_metric_name({ 'metric_name' => 'special_metric' }, exception, true)
+            assert_equal 'exception_handling.special_metric', metric
+          end
+        end
+
+        context "when metric_name is not present in exception_data" do
+          should "return exception_handling.warning when using log warning" do
+            warning = ExceptionHandling::Warning.new('this is a warning')
+            metric  = ExceptionHandling.default_metric_name({}, warning, false)
+            assert_equal 'exception_handling.warning', metric
+          end
+
+          should "return exception_handling.exception when using log error" do
+            exception = StandardError.new('this is an exception')
+            metric    = ExceptionHandling.default_metric_name({}, exception, false)
+            assert_equal 'exception_handling.exception', metric
+          end
+
+          context "when using log error with treat_like_warning" do
+            should "return exception_handling.unforwarded_exception when exception not present" do
+              metric = ExceptionHandling.default_metric_name({}, nil, true)
+              assert_equal 'exception_handling.unforwarded_exception', metric
+            end
+
+            should "return exception_handling.unforwarded_exception with exception classname when exception is present" do
+              module SomeModule
+                class SomeException < StandardError
+                end
+              end
+
+              exception = SomeModule::SomeException.new('this is an exception')
+              metric    = ExceptionHandling.default_metric_name({}, exception, true)
+              assert_equal 'exception_handling.unforwarded_exception_SomeException', metric
+            end
+          end
+        end
+      end
+
+      context "default_honeybadger_metric_name" do
+        should "return exception_handling.honeybadger.success when status is :success" do
+          metric = ExceptionHandling.default_honeybadger_metric_name(:success)
+          assert_equal 'exception_handling.honeybadger.success', metric
+        end
+
+        should "return exception_handling.honeybadger.failure when status is :failure" do
+          metric = ExceptionHandling.default_honeybadger_metric_name(:failure)
+          assert_equal 'exception_handling.honeybadger.failure', metric
+        end
+
+        should "return exception_handling.honeybadger.skipped when status is :skipped" do
+          metric = ExceptionHandling.default_honeybadger_metric_name(:skipped)
+          assert_equal 'exception_handling.honeybadger.skipped', metric
+        end
+
+        should "return exception_handling.honeybadger.unknown_status when status is not recognized" do
+          metric = ExceptionHandling.default_honeybadger_metric_name(nil)
+          assert_equal 'exception_handling.honeybadger.unknown_status', metric
+        end
+      end
+
+      context "ExceptionHandling.ensure_safe" do
+        should "log an exception with call stack if an exception is raised." do
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything)
+          ExceptionHandling.ensure_safe { raise ArgumentError, "blah" }
+        end
+
+        should "log an exception with call stack if an ActionView template exception is raised." do
+          mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
+          ExceptionHandling.ensure_safe { raise ActionView::TemplateError.new({}, ArgumentError.new("blah")) }
+        end
+
+        should "should not log an exception if an exception is not raised." do
+          dont_allow(ExceptionHandling.logger).fatal
+          ExceptionHandling.ensure_safe { ; }
+        end
+
+        should "return its value if used during an assignment" do
+          dont_allow(ExceptionHandling.logger).fatal
+          b = ExceptionHandling.ensure_safe { 5 }
+          assert_equal 5, b
+        end
+
+        should "return nil if an exception is raised during an assignment" do
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything)
+          b = ExceptionHandling.ensure_safe { raise ArgumentError, "blah" }
+          assert_nil b
+        end
+
+        should "allow a message to be appended to the error when logged." do
+          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          b = ExceptionHandling.ensure_safe("mooo") { raise ArgumentError, "blah" }
+          assert_nil b
+        end
+
+        should "only rescue StandardError and descendents" do
+          assert_raise(Exception) { ExceptionHandling.ensure_safe("mooo") { raise Exception } }
+
+          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+
+          b = ExceptionHandling.ensure_safe("mooo") { raise StandardError, "blah" }
+          assert_nil b
+        end
+      end
+
+      context "ExceptionHandling.ensure_completely_safe" do
+        should "log an exception if an exception is raised." do
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything)
+          ExceptionHandling.ensure_completely_safe { raise ArgumentError, "blah" }
+        end
+
+        should "should not log an exception if an exception is not raised." do
+          mock(ExceptionHandling.logger).fatal.times(0)
+          ExceptionHandling.ensure_completely_safe { ; }
+        end
+
+        should "return its value if used during an assignment" do
+          mock(ExceptionHandling.logger).fatal.times(0)
+          b = ExceptionHandling.ensure_completely_safe { 5 }
+          assert_equal 5, b
+        end
+
+        should "return nil if an exception is raised during an assignment" do
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything) { nil }
+          b = ExceptionHandling.ensure_completely_safe { raise ArgumentError, "blah" }
+          assert_nil b
+        end
+
+        should "allow a message to be appended to the error when logged." do
+          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          b = ExceptionHandling.ensure_completely_safe("mooo") { raise ArgumentError, "blah" }
+          assert_nil b
+        end
+
+        should "rescue any instance or child of Exception" do
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything)
+          ExceptionHandling.ensure_completely_safe { raise Exception, "blah" }
+        end
+
+        should "not rescue the special exceptions that Ruby uses" do
+          [SystemExit, SystemStackError, NoMemoryError, SecurityError].each do |exception|
+            assert_raise exception do
+              ExceptionHandling.ensure_completely_safe do
+                raise exception
+              end
+            end
+          end
+        end
+      end
+
+      context "ExceptionHandling.ensure_escalation" do
+        setup do
+          capture_notifications
+          ActionMailer::Base.deliveries.clear
+        end
+
+        should "log the exception as usual and send the proper email" do
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything)
+          ExceptionHandling.ensure_escalation("Favorite Feature") { raise ArgumentError, "blah" }
+          assert_equal 1, ActionMailer::Base.deliveries.count
+          assert_equal 1, sent_notifications.size, sent_notifications.inspect
+
+          email = ActionMailer::Base.deliveries.last
+          assert_equal "#{ExceptionHandling.email_environment} Escalation: Favorite Feature", email.subject
+          assert_match 'ArgumentError: blah', email.body.to_s
+          assert_match ExceptionHandling.last_exception_timestamp.to_s, email.body.to_s
+        end
+
+        should "should not escalate if an exception is not raised." do
+          dont_allow(ExceptionHandling.logger).fatal
+          ExceptionHandling.ensure_escalation('Ignored') { ; }
+          assert_equal 0, ActionMailer::Base.deliveries.count
+        end
+
+        should "log if the escalation email cannot be sent" do
+          any_instance_of(Mail::Message) do |message|
+            mock(message).deliver { raise RuntimeError.new, "Delivery Error" }
+          end
+          log_fatals = []
+          stub(ExceptionHandling.logger) do |logger|
+            logger.fatal.with_any_args { |*args| log_fatals << args }
+          end
+
+          ExceptionHandling.ensure_escalation("ensure context") { raise ArgumentError, "first_test_exception" }
+
+          assert_match /ArgumentError.*first_test_exception/, log_fatals[0].first
+          assert_match /safe_email_deliver.*Delivery Error/, log_fatals[1].first
+
+          assert_equal 2, log_fatals.size, log_fatals.inspect
+
+          assert_equal 1, sent_notifications.size, sent_notifications.inspect # still sent to honeybadger
+        end
+
+        should "allow the caller to specify custom recipients" do
+          custom_recipients = ['something@invoca.com']
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything)
+          ExceptionHandling.ensure_escalation("Favorite Feature", custom_recipients) { raise ArgumentError, "blah" }
+          assert_equal 1, ActionMailer::Base.deliveries.count
+          assert_equal 1, sent_notifications.size, sent_notifications.inspect
+
+          email = ActionMailer::Base.deliveries.last
+          assert_equal "#{ExceptionHandling.email_environment} Escalation: Favorite Feature", email.subject
+          assert_match 'ArgumentError: blah', email.body.to_s
+          assert_match ExceptionHandling.last_exception_timestamp.to_s, email.body.to_s
+          assert_equal custom_recipients, email.to
+        end
+      end
+
+      context "ExceptionHandling.ensure_alert" do
+        should "log the exception as usual and fire a sensu event" do
+          mock(ExceptionHandling::Sensu).generate_event("Favorite Feature", "test context\nblah")
+          mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/, anything)
+          ExceptionHandling.ensure_alert('Favorite Feature', 'test context') { raise ArgumentError, "blah" }
+        end
+
+        should "should not send sensu event if an exception is not raised." do
+          dont_allow(ExceptionHandling.logger).fatal
+          dont_allow(ExceptionHandling::Sensu).generate_event
+          ExceptionHandling.ensure_alert('Ignored', 'test context') { ; }
+        end
+
+        should "log if the sensu event could not be sent" do
+          mock(ExceptionHandling::Sensu).send_event(anything) { raise "Failed to send" }
+          mock(ExceptionHandling.logger) do |logger|
+            logger.fatal(/first_test_exception/, anything)
+            logger.fatal(/Failed to send/, anything)
+          end
+          ExceptionHandling.ensure_alert("Not Used", 'test context') { raise ArgumentError, "first_test_exception" }
+        end
+
+        should "log if the exception message is nil" do
+          mock(ExceptionHandling::Sensu).generate_event("some alert", "test context\n")
+          ExceptionHandling.ensure_alert('some alert', 'test context') { raise_exception_with_nil_message }
+        end
+      end
+
+      context "ExceptionHandling.escalate_to_production_support" do
+        should "notify production support" do
+          subject = "Runtime Error found!"
+          exception = RuntimeError.new("Test")
+          recipients = ["prodsupport@example.com"]
+
+          mock(ExceptionHandling).production_support_recipients { recipients }.times(2)
+          mock(ExceptionHandling).escalate(subject, exception, ExceptionHandling.last_exception_timestamp, recipients)
+          ExceptionHandling.escalate_to_production_support(exception, subject)
+        end
+      end
+
+      context "exception timestamp" do
+        setup do
+          Time.now_override = Time.parse('1986-5-21 4:17 am UTC')
+        end
+
+        should "include the timestamp when the exception is logged" do
+          capture_notifications
+
+          mock(ExceptionHandling.logger).fatal(/\(Error:517033020\) ArgumentError context \(blah\):\n.*exception_handling_test\.rb/, anything)
+          b = ExceptionHandling.ensure_safe("context") { raise ArgumentError, "blah" }
+          assert_nil b
+
+          assert_equal 517_033_020, ExceptionHandling.last_exception_timestamp
+
+          assert_equal 1, sent_notifications.size, sent_notifications.inspect
+
+          assert_equal 517_033_020, sent_notifications.last.enhanced_data['timestamp']
+        end
+      end
+
+      should "log the error if the exception message is nil" do
+        capture_notifications
+
+        ExceptionHandling.log_error(exception_with_nil_message)
+
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+        assert_equal 'RuntimeError: ', sent_notifications.last.enhanced_data['error_string']
+      end
+
+      should "log the error if the exception message is nil and the exception context is a hash" do
+        capture_notifications
+
+        ExceptionHandling.log_error(exception_with_nil_message, "SERVER_NAME" => "exceptional.com")
+
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+        assert_equal 'RuntimeError: ', sent_notifications.last.enhanced_data['error_string']
+      end
+
+      context "Honeybadger integration" do
+        context "with Honeybadger not defined" do
+          setup do
+            stub(ExceptionHandling).honeybadger_defined? { false }
+          end
+
+          should "not invoke send_exception_to_honeybadger when log_error is executed" do
+            dont_allow(ExceptionHandling).send_exception_to_honeybadger
+            ExceptionHandling.log_error(exception_1)
+          end
+
+          should "not invoke send_exception_to_honeybadger when ensure_safe is executed" do
+            dont_allow(ExceptionHandling).send_exception_to_honeybadger
+            ExceptionHandling.ensure_safe { raise exception_1 }
+          end
+        end
+
+        context "with Honeybadger defined" do
+          teardown do
+            ExceptionHandling.current_controller = nil
+          end
+
+          should "not send_exception_to_honeybadger when log_warning is executed" do
+            dont_allow(ExceptionHandling).send_exception_to_honeybadger
+            ExceptionHandling.log_warning("This should not go to honeybadger")
+          end
+
+          should "not send_exception_to_honeybadger when log_error is called with a Warning" do
+            dont_allow(ExceptionHandling).send_exception_to_honeybadger
+            ExceptionHandling.log_error(ExceptionHandling::Warning.new("This should not go to honeybadger"))
+          end
+
+          should "invoke send_exception_to_honeybadger when log_error is executed" do
+            mock.proxy(ExceptionHandling).send_exception_to_honeybadger.with_any_args
+            ExceptionHandling.log_error(exception_1)
+          end
+
+          should "invoke send_exception_to_honeybadger when log_error_rack is executed" do
+            mock.proxy(ExceptionHandling).send_exception_to_honeybadger.with_any_args
+            ExceptionHandling.log_error_rack(exception_1, {}, nil)
+          end
+
+          should "invoke send_exception_to_honeybadger when ensure_safe is executed" do
+            mock.proxy(ExceptionHandling).send_exception_to_honeybadger.with_any_args
+            ExceptionHandling.ensure_safe { raise exception_1 }
+          end
+
+          should "specify error message as an empty string when notifying honeybadger if exception message is nil" do
+            mock(Honeybadger).notify.with_any_args do |args|
+              assert_equal "", args[:error_message]
+            end
+            ExceptionHandling.log_error(exception_with_nil_message)
+          end
+
+          should "send error details and relevant context data to Honeybadger" do
+            Time.now_override = Time.now
+            env = { server: "fe98" }
+            parameters = { advertiser_id: 435, controller: "some_controller" }
+            session = { username: "jsmith" }
+            request_uri = "host/path"
+            ExceptionHandling.current_controller = create_dummy_controller(env, parameters, session, request_uri)
+            stub(ExceptionHandling).server_name { "invoca_fe98" }
+
+            exception = StandardError.new("Some Exception")
+            exception.set_backtrace([
+                                      "test/unit/exception_handling_test.rb:847:in `exception_1'",
+                                      "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
+                                    ])
+            exception_context = { "SERVER_NAME" => "exceptional.com" }
+
+            honeybadger_data = nil
+            mock(Honeybadger).notify.with_any_args do |data|
+              honeybadger_data = data
+            end
+            ExceptionHandling.log_error(exception, exception_context) do |data|
+              data[:scm_revision] = "5b24eac37aaa91f5784901e9aabcead36fd9df82"
+              data[:user_details] = { username: "jsmith" }
+              data[:event_response] = "Event successfully received"
+              data[:other_section] = "This should not be included in the response"
+            end
+
+            expected_data = {
+              error_class: :"Test Exception",
+              error_message: "Some Exception",
+              controller: "some_controller",
+              exception: exception,
+              context: {
+                timestamp: Time.now.to_i,
+                error_class: "StandardError",
+                server: "invoca_fe98",
+                exception_context: { "SERVER_NAME" => "exceptional.com" },
+                scm_revision: "5b24eac37aaa91f5784901e9aabcead36fd9df82",
+                notes: "this is used by a test",
+                user_details: { "username" => "jsmith" },
+                request: {
+                  "params" => { "advertiser_id" => 435, "controller" => "some_controller" },
+                  "rails_root" => "Rails.root not defined. Is this a test environment?",
+                  "url" => "host/path"
+                },
+                session: {
+                  "key" => nil,
+                  "data" => { "username" => "jsmith" }
+                },
+                environment: {
+                  "SERVER_NAME" => "exceptional.com"
+                },
+                backtrace: [
+                  "test/unit/exception_handling_test.rb:847:in `exception_1'",
+                  "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
+                ],
+                event_response: "Event successfully received"
+              }
+            }
+            assert_equal_with_diff expected_data, honeybadger_data
+          end
+
+          context "with post_log_error_hook set" do
+            teardown do
+              ExceptionHandling.post_log_error_hook = nil
+            end
+
+            should "not send notification to honeybadger when exception description has the flag turned off and call log error callback with logged_to_honeybadger set to nil" do
+              @fail_count = 0
+              @honeybadger_status = nil
+              ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
+              filter_list = {
+                NoHoneybadger: {
+                  error: "suppress Honeybadger notification",
+                  send_to_honeybadger: false
+                }
+              }
+              stub(File).mtime { incrementing_mtime }
+              mock(YAML).load_file.with_any_args { ActiveSupport::HashWithIndifferentAccess.new(filter_list) }.at_least(1)
+
+              mock.proxy(ExceptionHandling).send_exception_to_honeybadger_unless_filtered.with_any_args.once
+              dont_allow(Honeybadger).notify
+              ExceptionHandling.log_error(StandardError.new("suppress Honeybadger notification"))
+              assert_equal :skipped, @honeybadger_status
+            end
+
+            should "call log error callback with logged_to_honeybadger set to false if an error occurs while attempting to notify honeybadger" do
+              @fail_count = 0
+              @honeybadger_status = nil
+              ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
+              mock(Honeybadger).notify.with_any_args { raise "Honeybadger Notification Failure" }
+              ExceptionHandling.log_error(exception_1)
+              assert_equal :failure, @honeybadger_status
+            end
+
+            should "call log error callback with logged_to_honeybadger set to false on unsuccessful honeybadger notification" do
+              @fail_count = 0
+              @honeybadger_status = nil
+              ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
+              mock(Honeybadger).notify.with_any_args { false }
+              ExceptionHandling.log_error(exception_1)
+              assert_equal :failure, @honeybadger_status
+            end
+
+            should "call log error callback with logged_to_honeybadger set to true on successful honeybadger notification" do
+              @fail_count = 0
+              @honeybadger_status = nil
+              ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
+              mock(Honeybadger).notify.with_any_args { '06220c5a-b471-41e5-baeb-de247da45a56' }
+              ExceptionHandling.log_error(exception_1)
+              assert_equal :success, @honeybadger_status
+            end
+          end
+        end
+      end
+
+      class EventResponse
+        def to_s
+          "message from to_s!"
+        end
+      end
+
+      should "allow sections to have data with just a to_s method" do
+        capture_notifications
+
+        ExceptionHandling.log_error("This is my RingSwitch example.") do |data|
+          data.merge!(event_response: EventResponse.new)
+        end
+
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+        assert_match(/message from to_s!/, sent_notifications.last.enhanced_data['event_response'].to_s)
+      end
+    end
+
+    should "return the error ID (timestamp)" do
+      result = ExceptionHandling.log_error(RuntimeError.new("A runtime error"), "Runtime message")
+      assert_equal ExceptionHandling.last_exception_timestamp, result
+    end
+
+    should "rescue exceptions that happen in log_error" do
+      stub(ExceptionHandling).make_exception { raise ArgumentError, "Bad argument" }
+      mock(ExceptionHandling).write_exception_to_log(satisfy { |ex| ex.to_s['Bad argument'] },
+                                                     satisfy { |context| context['ExceptionHandlingError: log_error rescued exception while logging Runtime message'] },
+                                                     anything)
+      ExceptionHandling.log_error(RuntimeError.new("A runtime error"), "Runtime message")
+    end
+
+    should "rescue exceptions that happen when log_error yields" do
+      mock(ExceptionHandling).write_exception_to_log(satisfy { |ex| ex.to_s['Bad argument'] },
+                                                     satisfy { |context| context['Context message'] },
+                                                     anything,
+                                                     anything)
+      ExceptionHandling.log_error(ArgumentError.new("Bad argument"), "Context message") { |_data| raise 'Error!!!' }
+    end
+
+    context "Exception Filtering" do
+      setup do
+        filter_list = { exception1: { 'error' => "my error message" },
+                        exception2: { 'error' => "some other message", :session => "misc data" } }
+        stub(YAML).load_file { ActiveSupport::HashWithIndifferentAccess.new(filter_list) }
+
+        # bump modified time up to get the above filter loaded
+        stub(File).mtime { incrementing_mtime }
+      end
+
+      should "handle case where filter list is not found" do
+        stub(YAML).load_file { raise Errno::ENOENT, "File not found" }
+
+        capture_notifications
+
+        ExceptionHandling.log_error("My error message is in list")
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+      end
+
+      should "log exception and suppress email when exception is on filter list" do
+        capture_notifications
+
+        ExceptionHandling.log_error("Error message is not in list")
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+
+        sent_notifications.clear
+        ExceptionHandling.log_error("My error message is in list")
+        assert_equal 0, sent_notifications.size, sent_notifications.inspect
+      end
+
+      should "allow filtering exception on any text in exception data" do
+        filters = { exception1: { session: "data: my extra session data" } }
+        stub(YAML).load_file { ActiveSupport::HashWithIndifferentAccess.new(filters) }
+
+        capture_notifications
+
+        ExceptionHandling.log_error("No match here") do |data|
+          data[:session] = {
+            key: "@session_id",
+            data: "my extra session data"
+          }
+        end
+        assert_equal 0, sent_notifications.size, sent_notifications.inspect
+
+        ExceptionHandling.log_error("No match here") do |data|
+          data[:session] = {
+            key: "@session_id",
+            data: "my extra session <no match!> data"
+          }
+        end
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+      end
+
+      should "reload filter list on the next exception if file was modified" do
+        capture_notifications
+
+        ExceptionHandling.log_error("Error message is not in list")
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+
+        filter_list = { exception1: { 'error' => "Error message is not in list" } }
+        stub(YAML).load_file { ActiveSupport::HashWithIndifferentAccess.new(filter_list) }
+        stub(File).mtime { incrementing_mtime }
+
+        sent_notifications.clear
+        ExceptionHandling.log_error("Error message is not in list")
+        assert_equal 0, sent_notifications.size, sent_notifications.inspect
+      end
+
+      should "not consider filter if both error message and body do not match" do
+        capture_notifications
+
+        # error message matches, but not full text
+        ExceptionHandling.log_error("some other message")
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+
+        # now both match
+        sent_notifications.clear
+        ExceptionHandling.log_error("some other message") do |data|
+          data[:session] = { some_random_key: "misc data" }
+        end
+        assert_equal 0, sent_notifications.size, sent_notifications.inspect
+      end
+
+      should "skip environment keys not on whitelist" do
+        capture_notifications
+
+        ExceptionHandling.log_error("some message") do |data|
+          data[:environment] = { SERVER_PROTOCOL: "HTTP/1.0", RAILS_SECRETS_YML_CONTENTS: 'password: VERY_SECRET_PASSWORD' }
+        end
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+
+        mail = sent_notifications.last
+        environment = mail.enhanced_data['environment']
+
+        assert_nil environment["RAILS_SECRETS_YML_CONTENTS"], environment.inspect # this is not on whitelist
+        assert     environment["SERVER_PROTOCOL"], environment.inspect # this is
+      end
+
+      should "omit environment defaults" do
+        capture_notifications
+
+        stub(ExceptionHandling).send_exception_to_honeybadger(anything) { |exception_info| sent_notifications << exception_info }
+
+        ExceptionHandling.log_error("some message") do |data|
+          data[:environment] = { SERVER_PORT: '80', SERVER_PROTOCOL: "HTTP/1.0" }
+        end
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+        mail = sent_notifications.last
+        environment = mail.enhanced_data['environment']
+
+        assert_nil environment["SERVER_PORT"], environment.inspect # this was default
+        assert     environment["SERVER_PROTOCOL"], environment # this was not
+      end
+
+      should "reject the filter file if any contain all empty regexes" do
+        filter_list = { exception1: { 'error' => "", :session => "" },
+                        exception2: { 'error' => "is not in list", :session => "" } }
+        stub(YAML).load_file { ActiveSupport::HashWithIndifferentAccess.new(filter_list) }
+        stub(File).mtime { incrementing_mtime }
+
+        capture_notifications
+
+        ExceptionHandling.log_error("Error message is not in list")
+        assert_equal 1, sent_notifications.size, sent_notifications.inspect
+      end
+
+      should "reload filter file if filename changes" do
+        catalog = ExceptionHandling.exception_catalog
+        ExceptionHandling.filter_list_filename = "./config/other_exception_filters.yml"
+        assert_not_equal catalog, ExceptionHandling.exception_catalog
+      end
+
+      context "Exception Handling Mailer" do
+        EXPECTED_SMTP_HASH =
+          {
+            host: '127.0.0.1',
+            domain: 'localhost.localdomain',
+            from: 'server@example.com',
+            to: 'escalation@example.com'
+          }.freeze
+
+        [[true, false], [true, true]].each do |em_flag, synchrony_flag|
+          context "eventmachine_safe = #{em_flag} && eventmachine_synchrony = #{synchrony_flag}" do
+            setup do
+              ExceptionHandling.eventmachine_safe       = em_flag
+              ExceptionHandling.eventmachine_synchrony  = synchrony_flag
+              EventMachineStub.block = nil
+              set_test_const('EventMachine', EventMachineStub)
+              set_test_const('EventMachine::Protocols', Module.new)
+              set_test_const('EventMachine::DNS', Module.new)
+              set_test_const('EventMachine::DNS::Resolver', DNSResolvStub)
+            end
+
+            teardown do
+              ExceptionHandling.eventmachine_safe       = false
+              ExceptionHandling.eventmachine_synchrony  = false
+            end
+
+            should "schedule EventMachine STMP when EventMachine defined" do
+              ActionMailer::Base.deliveries.clear
+
+              set_test_const('EventMachine::Protocols::SmtpClient', SmtpClientStub)
+
+              ExceptionHandling.ensure_escalation("ensure message") { raise 'Exception to escalate!' }
+              assert EventMachineStub.block
+              EventMachineStub.block.call
+              assert DNSResolvStub.callback_block
+              DNSResolvStub.callback_block.call ['127.0.0.1']
+              assert_equal_with_diff EXPECTED_SMTP_HASH, (SmtpClientStub.send_hash & EXPECTED_SMTP_HASH.keys).map_hash { |_k, v| v.to_s }, SmtpClientStub.send_hash.inspect
+              assert_equal((synchrony_flag ? :asend : :send), SmtpClientStub.last_method)
+              assert_match(/Exception to escalate/, SmtpClientStub.send_hash[:content])
+              assert_emails 0, ActionMailer::Base.deliveries.*.to_s
+            end
+
+            should "pass the content as a proper rfc 2822 message" do
+              set_test_const('EventMachine::Protocols::SmtpClient', SmtpClientStub)
+              ExceptionHandling.ensure_escalation("ensure message") { raise 'Exception to escalate!' }
+              assert EventMachineStub.block
+              EventMachineStub.block.call
+              assert DNSResolvStub.callback_block
+              DNSResolvStub.callback_block.call ['127.0.0.1']
+              assert content = SmtpClientStub.send_hash[:content]
+              assert_match(/Content-Transfer-Encoding: 7bit/, content)
+              assert_match(/\r\n\.\r\n\z/, content)
+            end
+
+            should "log fatal on EventMachine STMP errback" do
+              ActionMailer::Base.deliveries.clear
+
+              set_test_const('EventMachine::Protocols::SmtpClient', SmtpClientErrbackStub)
+              mock(ExceptionHandling.logger).fatal(/Exception to escalate/, anything)
+              mock(ExceptionHandling.logger).fatal(/Failed to email by SMTP: "credential mismatch"/)
+
+              ExceptionHandling.ensure_escalation("ensure message") { raise 'Exception to escalate!' }
+              assert EventMachineStub.block
+              EventMachineStub.block.call
+              assert DNSResolvStub.callback_block
+              DNSResolvStub.callback_block.call(['127.0.0.1'])
+              SmtpClientErrbackStub.block.call("credential mismatch")
+              assert_equal_with_diff EXPECTED_SMTP_HASH, (SmtpClientErrbackStub.send_hash & EXPECTED_SMTP_HASH.keys).map_hash { |_k, v| v.to_s }, SmtpClientErrbackStub.send_hash.inspect
+            end
+
+            should "log fatal on EventMachine dns resolver errback" do
+              mock(ExceptionHandling.logger).fatal(/Exception to escalate/, anything)
+              mock(ExceptionHandling.logger).fatal(/Failed to resolv DNS for localhost: "softlayer sucks"/)
+
+              ExceptionHandling.ensure_escalation("ensure message") { raise 'Exception to escalate!' }
+              assert EventMachineStub.block
+              EventMachineStub.block.call
+              DNSResolvStub.errback_block.call("softlayer sucks")
+            end
+          end
+        end
+      end
+    end
+
+    context "Exception mapping" do
+      setup do
+        @data = {
+          environment: {
+            'HTTP_HOST' => "localhost",
+            'HTTP_REFERER' => "http://localhost/action/controller/instance",
+          },
+          session: {
+            data: {
+              affiliate_id: defined?(Affiliate) ? Affiliate.first.id : '1',
+              edit_mode: true,
+              advertiser_id: defined?(Advertiser) ? Advertiser.first.id : '1',
+              username_id: defined?(Username) ? Username.first.id : '1',
+              user_id: defined?(User) ? User.first.id : '1',
+              flash: {},
+              impersonated_organization_pk: 'Advertiser_1'
+            }
+          },
+          request: {},
+          backtrace: ["[GEM_ROOT]/gems/actionpack-2.1.0/lib/action_controller/filters.rb:580:in `call_filters'", "[GEM_ROOT]/gems/actionpack-2.1.0/lib/action_controller/filters.rb:601:in `run_before_filters'"],
+          api_key: "none",
+          error_class: "StandardError",
+          error: 'Some error message'
+        }
+      end
+
+      should "clean backtraces" do
+        begin
+          raise "test exception"
+        rescue => ex
+          backtrace = ex.backtrace
+        end
+        result = ExceptionHandling.send(:clean_backtrace, ex).to_s
+        assert_not_equal result, backtrace
+      end
+
+      should "return entire backtrace if cleaned is emtpy" do
+        begin
+          backtrace = ["/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/relation/finder_methods.rb:312:in `find_with_ids'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/relation/finder_methods.rb:107:in `find'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/querying.rb:5:in `__send__'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/querying.rb:5:in `find'",
+                       "/Library/Ruby/Gems/1.8/gems/shoulda-context-1.0.2/lib/shoulda/context/context.rb:398:in `call'",
+                       "/Library/Ruby/Gems/1.8/gems/shoulda-context-1.0.2/lib/shoulda/context/context.rb:398:in `test: Exception mapping should return entire backtrace if cleaned is emtpy. '",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:72:in `__send__'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:72:in `run'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:447:in `_run__1913317170__setup__4__callbacks'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:405:in `send'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:405:in `__run_callback'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:385:in `_run_setup_callbacks'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:81:in `send'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:81:in `run_callbacks'",
+                       "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:70:in `run'",
+                       "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:34:in `run'",
+                       "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:33:in `each'",
+                       "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:33:in `run'",
+                       "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnermediator.rb:46:in `old_run_suite'",
+                       "(eval):12:in `run_suite'",
+                       "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:93:in `send'",
+                       "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:93:in `start_mediator'",
+                       "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:81:in `start'",
+                       "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnerutilities.rb:29:in `run'",
+                       "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/autorunner.rb:12:in `run'",
+                       "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit.rb:279",
+                       "-e:1"]
+
+          module ::Rails
+            class BacktraceCleaner
+              def clean(_backtrace)
+                []
+              end
+            end
+          end
+
+          mock(Rails).backtrace_cleaner { Rails::BacktraceCleaner.new }
+
+          ex = Exception.new
+          ex.set_backtrace(backtrace)
+          result = ExceptionHandling.send(:clean_backtrace, ex)
+          assert_equal backtrace, result
+        ensure
+          Object.send(:remove_const, :Rails)
+        end
+      end
+    end
+
+    context "log_perodically" do
+      setup do
+        Time.now_override = Time.now # Freeze time
+        ExceptionHandling.logger.clear
+      end
+
+      teardown do
+        Time.now_override = nil
+      end
+
+      should "take in additional logging context and pass them to the logger" do
+        ExceptionHandling.log_periodically(:test_context_with_periodic, 30.minutes, "this will be written", service_name: 'exception_handling')
+        assert_not_empty logged_excluding_reload_filter.last[:context]
+        assert_equal({ service_name: 'exception_handling' }, logged_excluding_reload_filter.last[:context])
+      end
+
+      should "log immediately when we are expected to log" do
+        ExceptionHandling.log_periodically(:test_periodic_exception, 30.minutes, "this will be written")
+        assert_equal 1, logged_excluding_reload_filter.size
+
+        Time.now_override = Time.now + 5.minutes
+        ExceptionHandling.log_periodically(:test_periodic_exception, 30.minutes, "this will not be written")
+        assert_equal 1, logged_excluding_reload_filter.size
+
+        ExceptionHandling.log_periodically(:test_another_periodic_exception, 30.minutes, "this will be written")
+        assert_equal 2, logged_excluding_reload_filter.size
+
+        Time.now_override = Time.now + 26.minutes
+
+        ExceptionHandling.log_periodically(:test_periodic_exception, 30.minutes, "this will be written")
+        assert_equal 3, logged_excluding_reload_filter.size
+      end
+    end
+  end
+
+  private
+
+  def logged_excluding_reload_filter
+    ExceptionHandling.logger.logged.select { |l| l[:message] !~ /Reloading filter list/ }
+  end
+
+  def incrementing_mtime
+    @mtime ||= Time.now
+    @mtime += 1.day
+  end
+
+  def exception_1
+    @exception_1 ||=
+      begin
+        raise StandardError, "Exception 1"
+      rescue => ex
+        ex
+      end
+  end
+
+  def exception_2
+    @exception_2 ||=
+      begin
+        raise StandardError, "Exception 2"
+      rescue => ex
+        ex
+      end
+  end
+end