exception_handling 3.0.pre.1 → 3.0.0

data/{test/test_helper.rb → spec/spec_helper.rb}

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/time'
-require 'active_support/test_case'
-require 'active_model'
-require 'action_mailer'
-require 'action_dispatch'
-require 'hobo_support'
-require 'shoulda'
-require 'rr'
-require 'minitest/autorun'
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec_junit_formatter'
+
 require 'pry'
 require 'honeybadger'
 require 'contextual_logger'
@@ -17,26 +11,31 @@ require 'contextual_logger'
 require 'exception_handling'
 require 'exception_handling/testing'
 
-ActiveSupport::TestCase.test_order = :sorted
-
 class LoggerStub
-  include ContextualLogger
-  attr_accessor :logged
+  include ContextualLogger::LoggerMixin
+  attr_accessor :logged, :level
 
   def initialize
+    @level = Logger::Severity::DEBUG
+    @progname = nil
+    @logdev = nil
     clear
   end
 
+  def debug(message, log_context = {})
+    logged << { message: message, context: log_context, severity: 'DEBUG' }
+  end
+
   def info(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'INFO' }
   end
 
   def warn(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'WARN' }
   end
 
   def fatal(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'FATAL' }
   end
 
   def clear
@@ -75,50 +74,26 @@ def dont_stub_log_error
   true
 end
 
-ActionMailer::Base.delivery_method = :test
-
-_ = ActiveSupport
-_ = ActiveSupport::TestCase
-
-class ActiveSupport::TestCase
-  @@constant_overrides = []
-
-  setup do
-    unless @@constant_overrides.nil? || @@constant_overrides.empty?
-      raise "Uh-oh! constant_overrides left over: #{@@constant_overrides.inspect}"
-    end
-
-    unless defined?(Rails) && defined?(Rails.env)
-      module ::Rails
-        class << self
-          attr_writer :env
+module TestHelper
+  @constant_overrides = []
+  class << self
+    attr_accessor :constant_overrides
+  end
 
-          def env
-            @env ||= 'test'
-          end
-        end
-      end
+  def setup_constant_overrides
+    unless TestHelper.constant_overrides.nil? || TestHelper.constant_overrides.empty?
+      raise "Uh-oh! constant_overrides left over: #{TestHelper.constant_overrides.inspect}"
     end
 
     Time.now_override = nil
 
-    ActionMailer::Base.deliveries.clear
-
-    ExceptionHandling.email_environment     = 'Test'
-    ExceptionHandling.sender_address        = 'server@example.com'
-    ExceptionHandling.exception_recipients  = 'exceptions@example.com'
-    ExceptionHandling.escalation_recipients = 'escalation@example.com'
+    ExceptionHandling.environment           = 'not_test'
     ExceptionHandling.server_name           = 'server'
     ExceptionHandling.filter_list_filename    = "./config/exception_filters.yml"
-    ExceptionHandling.eventmachine_safe       = false
-    ExceptionHandling.eventmachine_synchrony  = false
-    ExceptionHandling.sensu_host              = "127.0.0.1"
-    ExceptionHandling.sensu_port              = 3030
-    ExceptionHandling.sensu_prefix            = ""
   end
 
-  teardown do
-    @@constant_overrides&.reverse&.each do |parent_module, k, v|
+  def teardown_constant_overrides
+    TestHelper.constant_overrides&.reverse&.each do |parent_module, k, v|
       ExceptionHandling.ensure_safe "constant cleanup #{k.inspect}, #{parent_module}(#{parent_module.class})::#{v.inspect}(#{v.class})" do
         silence_warnings do
           if v == :never_defined
@@ -129,7 +104,7 @@ class ActiveSupport::TestCase
         end
       end
     end
-    @@constant_overrides = []
+    TestHelper.constant_overrides = []
   end
 
   def set_test_const(const_name, value)
@@ -149,27 +124,17 @@ class ActiveSupport::TestCase
         end
       end
 
-    @@constant_overrides << [final_parent_module, final_const_name, original_value]
+    TestHelper.constant_overrides << [final_parent_module, final_const_name, original_value]
 
     silence_warnings { final_parent_module.const_set(final_const_name, value) }
   end
-
-  def assert_emails(expected, message = nil)
-    if block_given?
-      original_count = ActionMailer::Base.deliveries.size
-      yield
-    else
-      original_count = 0
-    end
-    assert_equal expected, ActionMailer::Base.deliveries.size - original_count, "wrong number of emails#{': ' + message.to_s if message}"
-  end
 end
 
 def assert_equal_with_diff(arg1, arg2, msg = '')
   if arg1 == arg2
-    assert true # To keep the assertion count accurate
+    expect(true).to be_truthy # To keep the assertion count accurate
   else
-    assert_equal arg1, arg2, "#{msg}\n#{Diff.compare(arg1, arg2)}"
+    expect(arg1).to eq(arg2), "#{msg}\n#{Diff.compare(arg1, arg2)}"
   end
 end
 
@@ -200,3 +165,35 @@ class Time
     end
   end
 end
+
+RSpec.configure do |config|
+  config.add_formatter(RspecJunitFormatter, 'spec/reports/rspec.xml')
+  config.include TestHelper
+
+  config.before(:each) do
+    setup_constant_overrides
+    unless defined?(Rails) && defined?(Rails.env)
+      module Rails
+        class << self
+          attr_writer :env
+
+          def env
+            @env ||= 'test'
+          end
+        end
+      end
+    end
+  end
+
+  config.after(:each) do
+    teardown_constant_overrides
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.expect_with(:rspec, :test_unit)
+
+  RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 2_000
+end

data/spec/unit/exception_handling/escalate_callback_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'exception_handling/escalate_callback'
+require File.expand_path('../../spec_helper',  __dir__)
+
+module ExceptionHandling
+  describe EscalateCallback do
+    before do
+      class TestGem
+        class << self
+          attr_accessor :logger
+        end
+        include Escalate.mixin
+      end
+      TestGem.logger = logger
+      Escalate.clear_on_escalate_callbacks
+    end
+
+    after do
+      Escalate.clear_on_escalate_callbacks
+    end
+
+    let(:exception) do
+      raise "boom!"
+    rescue => ex
+      ex
+    end
+    let(:location_message) { "happened in TestGem" }
+    let(:context_hash) { { cuid: 'AABBCD' } }
+    let(:logger) { double("logger") }
+
+    describe '.register_if_configured!' do
+      context 'when already configured' do
+        before do
+          @original_logger = ExceptionHandling.logger
+          ExceptionHandling.logger = ::Logger.new('/dev/null').extend(ContextualLogger::LoggerMixin)
+        end
+
+        after do
+          ExceptionHandling.logger = @original_logger
+        end
+
+        it 'registers a callback' do
+          EscalateCallback.register_if_configured!
+
+          expect(logger).to_not receive(:error)
+          expect(logger).to_not receive(:fatal)
+          expect(ExceptionHandling).to receive(:log_error).with(exception, location_message, context_hash)
+
+          TestGem.escalate(exception, location_message, context: context_hash)
+        end
+      end
+
+      context 'when not yet configured' do
+        before do
+          @original_logger = ExceptionHandling.logger
+          ExceptionHandling.logger = nil
+        end
+
+        after do
+          ExceptionHandling.logger = @original_logger
+        end
+
+        it 'registers a callback once the logger is set' do
+          EscalateCallback.register_if_configured!
+
+          expect(Escalate.on_escalate_callbacks).to be_empty
+
+          ExceptionHandling.logger = ::Logger.new('/dev/null').extend(ContextualLogger::LoggerMixin)
+          expect(Escalate.on_escalate_callbacks).to_not be_empty
+
+          expect(logger).to_not receive(:error)
+          expect(logger).to_not receive(:fatal)
+          expect(ExceptionHandling).to receive(:log_error).with(exception, location_message, context_hash)
+
+          TestGem.escalate(exception, location_message, context: context_hash)
+        end
+      end
+    end
+  end
+end

data/spec/unit/exception_handling/exception_catalog_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../spec_helper',  __dir__)
+
+module ExceptionHandling
+  describe ExceptionCatalog do
+
+    context "With stubbed yaml content" do
+      before do
+        filter_list = { exception1: { error: "my error message" },
+                        exception2: { error: "some other message", session: "misc data" } }
+        allow(YAML).to receive(:load_file) { filter_list }
+
+        # bump modified time up to get the above filter loaded
+        allow(File).to receive(:mtime) { incrementing_mtime }
+      end
+
+      context "with loaded data" do
+        before do
+          allow(File).to receive(:mtime) { incrementing_mtime }
+          @exception_catalog = ExceptionCatalog.new(ExceptionHandling.filter_list_filename)
+          @exception_catalog.send :load_file
+        end
+
+        it "have loaded filters" do
+          expect(@exception_catalog.instance_eval("@filters").size).to eq(2)
+        end
+
+        it "find messages in the catalog" do
+          expect(!@exception_catalog.find(error: "Scott says unlikely to ever match")).to be_truthy
+        end
+
+        it "find matching data" do
+          exception_description = @exception_catalog.find(error: "this is my error message, which should match something")
+          expect(exception_description).to be_truthy
+          expect(exception_description.filter_name).to eq(:exception1)
+        end
+      end
+
+      it "write errors loading the yaml file directly to the log file" do
+        @exception_catalog = ExceptionCatalog.new(ExceptionHandling.filter_list_filename)
+
+        expect(ExceptionHandling).to receive(:log_error).never
+        expect(ExceptionHandling).to receive(:write_exception_to_log).with(anything, "ExceptionCatalog#refresh_filters: ./config/exception_filters.yml", any_args)
+        expect(@exception_catalog).to receive(:load_file) { raise "noooooo" }
+
+        @exception_catalog.find({})
+      end
+    end
+
+    context "with live yaml content" do
+      before do
+        @filename = File.expand_path('../../../config/exception_filters.yml',  __dir__)
+        @exception_catalog = ExceptionCatalog.new(@filename)
+        expect do
+          @exception_catalog.send :load_file
+        end.not_to raise_error
+      end
+
+      it "load the filter data" do
+        expect(!@exception_catalog.find(error: "Scott says unlikely to ever match")).to be_truthy
+        expect(!@exception_catalog.find(error: "Scott says unlikely to ever match")).to be_truthy
+      end
+    end
+
+    context "with no yaml content" do
+      before do
+        @exception_catalog = ExceptionCatalog.new(nil)
+      end
+
+      it "not load filter data" do
+        expect(ExceptionHandling).to receive(:write_exception_to_log).with(any_args).never
+        @exception_catalog.find(error: "Scott says unlikely to ever match")
+      end
+    end
+
+    private
+
+    def incrementing_mtime
+      @mtime ||= Time.now
+      @mtime += 1.day
+    end
+
+  end
+end

data/spec/unit/exception_handling/exception_description_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../spec_helper',  __dir__)
+
+module ExceptionHandling
+  describe ExceptionDescription do
+
+    context "Filter" do
+      it "allow direct matching of strings" do
+        @f = ExceptionDescription.new(:filter1, error: "my error message")
+        expect(@f.match?('error' => "my error message")).to be_truthy
+      end
+
+      it "allow direct matching of strings on with symbol keys" do
+        @f = ExceptionDescription.new(:filter1, error: "my error message")
+        expect(@f.match?(error: "my error message")).to be_truthy
+      end
+
+      it "allow wildcards to cross line boundries" do
+        @f = ExceptionDescription.new(:filter1, error: "my error message.*with multiple lines")
+        expect(@f.match?(error: "my error message\nwith more than one, with multiple lines")).to be_truthy
+      end
+
+      it "complain when no regexps have a value" do
+        expect { ExceptionDescription.new(:filter1, error: nil) }.to raise_exception(ArgumentError, /has all blank regexes/)
+      end
+
+      it "report when an invalid key is passed" do
+        expect { ExceptionDescription.new(:filter1, error: "my error message", not_a_parameter: false) }.to raise_exception(ArgumentError, "Unknown section: not_a_parameter")
+      end
+
+      it "allow send_to_honeybadger to be specified and have it disabled by default" do
+        expect(!ExceptionDescription.new(:filter1, error: "my error message", send_to_honeybadger: false).send_to_honeybadger).to be_truthy
+        expect(ExceptionDescription.new(:filter1, error: "my error message", send_to_honeybadger: true).send_to_honeybadger).to be_truthy
+        expect(!ExceptionDescription.new(:filter1, error: "my error message").send_to_honeybadger).to be_truthy
+      end
+
+      it "allow send_metric to be configured" do
+        expect(!ExceptionDescription.new(:filter1, error: "my error message", send_metric: false).send_metric).to be_truthy
+        expect(ExceptionDescription.new(:filter1, error: "my error message").send_metric).to be_truthy
+      end
+
+      it "provide metric name" do
+        expect(ExceptionDescription.new(:filter1, error: "my error message").metric_name).to eq("filter1")
+        expect(ExceptionDescription.new(:filter1, error: "my error message", metric_name: :some_other_metric_name).metric_name).to eq("some_other_metric_name")
+      end
+
+      it "replace spaces in metric name" do
+        @f = ExceptionDescription.new(:"filter has spaces", error: "my error message")
+        expect(@f.metric_name).to eq( "filter_has_spaces")
+      end
+
+      it "allow notes to be recorded" do
+        expect(ExceptionDescription.new(:filter1, error: "my error message").notes).to be_nil
+        expect(ExceptionDescription.new(:filter1, error: "my error message", notes: "a long string").notes).to eq("a long string")
+      end
+
+      it "not consider config options in the filter set" do
+        expect(ExceptionDescription.new(:filter1, error: "my error message", send_metric: false).match?(error: "my error message")).to be_truthy
+        expect(ExceptionDescription.new(:filter1, error: "my error message", metric_name: "false").match?(error: "my error message")).to be_truthy
+        expect(ExceptionDescription.new(:filter1, error: "my error message", notes: "hey").match?(error: "my error message")).to be_truthy
+      end
+
+      it "provide exception details" do
+        exception_description = ExceptionDescription.new(:filter1, error: "my error message", notes: "hey")
+
+        expected = { "send_metric" => true, "metric_name" => "filter1", "notes" => "hey" }
+
+        expect(exception_description.exception_data).to eq( expected)
+      end
+
+      it "match multiple email addresses" do
+        mobi = "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for 'mcc@mobistreak.com'"
+        credit = "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for 'damon@thecreditpros.com'"
+
+        exception_description = ExceptionDescription.new(:filter1, error: "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for '(mcc\@mobistreak|damon\@thecreditpros).com'")
+        expect(exception_description.match?(error: mobi)).to be_truthy
+        expect(exception_description.match?(error: credit)).to be_truthy
+      end
+    end
+  end
+end