exception_handling 2.6.0 → 2.8.0

data/lib/exception_handling/log_stub_error.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 #
-# Used by functional tests to track exceptions.
+# Test Helper that supports Minitest::Test and Test::Unit
+# Used by tests in the consumers of this gem to track exceptions.
 #
 
 module LogErrorStub

data/lib/exception_handling/logging_methods.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation.rb'
+
+module ExceptionHandling
+  module LoggingMethods # included on models and controllers
+    extend ActiveSupport::Concern
+
+    protected
+
+    delegate :log_error_rack, :log_warning, :log_info, :log_debug, :escalate_error, :escalate_warning, :ensure_escalation, :alert_warning, :log_error, to: ExceptionHandling
+
+    def ensure_safe(exception_context = "")
+      yield
+    rescue => ex
+      log_error ex, exception_context
+      nil
+    end
+
+    def ensure_alert(*args)
+      ExceptionHandling.ensure_alert(*args) do
+        yield
+      end
+    end
+  end
+end

data/lib/exception_handling/methods.rb

@@ -1,65 +1,15 @@
 # frozen_string_literal: true
 
 require 'active_support/concern'
+require_relative 'logging_methods'
 
 module ExceptionHandling
   module Methods # included on models and controllers
     extend ActiveSupport::Concern
+    include ExceptionHandling::LoggingMethods
 
     protected
 
-    def log_error(exception_or_string, exception_context = '')
-      controller = self if respond_to?(:request) && respond_to?(:session)
-      ExceptionHandling.log_error(exception_or_string, exception_context, controller)
-    end
-
-    def log_error_rack(exception_or_string, exception_context = '', rack_filter = '')
-      ExceptionHandling.log_error_rack(exception_or_string, exception_context, rack_filter)
-    end
-
-    def log_warning(message)
-      ExceptionHandling.log_warning(message)
-    end
-
-    def log_info(message)
-      ExceptionHandling.logger.info(message)
-    end
-
-    def log_debug(message)
-      ExceptionHandling.logger.debug(message)
-    end
-
-    def ensure_safe(exception_context = "")
-      yield
-    rescue => ex
-      log_error ex, exception_context
-      nil
-    end
-
-    def escalate_error(exception_or_string, email_subject)
-      ExceptionHandling.escalate_error(exception_or_string, email_subject)
-    end
-
-    def escalate_warning(message, email_subject)
-      ExceptionHandling.escalate_warning(message, email_subject)
-    end
-
-    def ensure_escalation(*args)
-      ExceptionHandling.ensure_escalation(*args) do
-        yield
-      end
-    end
-
-    def alert_warning(*args)
-      ExceptionHandling.alert_warning(*args)
-    end
-
-    def ensure_alert(*args)
-      ExceptionHandling.ensure_alert(*args) do
-        yield
-      end
-    end
-
     def long_controller_action_timeout
       if defined?(Rails) && Rails.respond_to?(:env) && Rails.env == 'test'
         300
@@ -88,7 +38,10 @@ module ExceptionHandling
     end
 
     included do
-      around_filter :set_current_controller if respond_to? :around_filter
+      Deprecation3_0.deprecation_warning('ExceptionHandling::Methods', 'include LoggingMethods; in controllers, set your own around_filter to set logging context')
+      if respond_to? :around_filter
+        around_filter :set_current_controller
+      end
     end
 
     class_methods do

data/lib/exception_handling/testing.rb

@@ -4,7 +4,7 @@
 
 module ExceptionHandling
   module Testing
-    class ControllerStub
+    class ControllerStubBase
 
       class Request
         attr_accessor :parameters, :protocol, :host, :request_uri, :env, :session_options
@@ -25,7 +25,7 @@ module ExceptionHandling
         attr_accessor :around_filter_method
 
         def around_filter(method)
-          ControllerStub.around_filter_method = method
+          self.around_filter_method = method
         end
       end
 
@@ -44,14 +44,6 @@ module ExceptionHandling
           end
       end
 
-      def simulate_around_filter(&block)
-        set_current_controller(&block)
-      end
-
-      def controller_name
-        "ControllerStub"
-      end
-
       def action_name
         "test_action"
       end
@@ -59,9 +51,27 @@ module ExceptionHandling
       def complete_request_uri
         "#{@request.protocol}#{@request.host}#{@request.request_uri}"
       end
+    end
+
+    class LoggingMethodsControllerStub < ControllerStubBase
+      include ExceptionHandling::LoggingMethods
+
+      def controller_name
+        "LoggingMethodsControllerStub"
+      end
+    end
 
+    class MethodsControllerStub < ControllerStubBase
       include ExceptionHandling::Methods
       set_long_controller_action_timeout 2
+
+      def simulate_around_filter(&block)
+        set_current_controller(&block)
+      end
+
+      def controller_name
+        "MethodsControllerStub"
+      end
     end
   end
 end

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.6.0'
+  VERSION = '2.8.0'
 end

data/{test → spec}/helpers/exception_helpers.rb

@@ -7,7 +7,7 @@ module ExceptionHelpers
 
   def exception_with_nil_message
     exception_with_nil_message = RuntimeError.new(nil)
-    stub(exception_with_nil_message).message { nil }
+    allow(exception_with_nil_message).to receive(:message).and_return(nil)
     exception_with_nil_message
   end
 
@@ -15,6 +15,6 @@ module ExceptionHelpers
 
   def capture_notifications
     @sent_notifications = []
-    stub(ExceptionHandling).send_exception_to_honeybadger(anything) { |exception_info| @sent_notifications << exception_info }
+    allow(ExceptionHandling).to receive(:send_exception_to_honeybadger).with(anything) { |exception_info| @sent_notifications << exception_info }
   end
 end

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

@@ -1,17 +1,8 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/time'
-require 'active_support/test_case'
-require 'action_mailer'
-require 'action_dispatch'
-require 'shoulda'
-require 'rr'
-require 'minitest/autorun'
-require "minitest/reporters"
-
-junit_ouptut_dir = ENV["JUNIT_OUTPUT_DIR"].presence || "test/reports"
-Minitest::Reporters.use!([Minitest::Reporters::DefaultReporter.new, Minitest::Reporters::JUnitReporter.new(junit_ouptut_dir)])
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec_junit_formatter'
 
 require 'pry'
 require 'honeybadger'
@@ -20,8 +11,6 @@ require 'contextual_logger'
 require 'exception_handling'
 require 'exception_handling/testing'
 
-ActiveSupport::TestCase.test_order = :sorted
-
 class LoggerStub
   include ContextualLogger::LoggerMixin
   attr_accessor :logged, :level
@@ -87,27 +76,17 @@ end
 
 ActionMailer::Base.delivery_method = :test
 
-_ = ActiveSupport
-_ = ActiveSupport::TestCase
 
-class ActiveSupport::TestCase
-  @@constant_overrides = []
+module TestHelper
+  @constant_overrides = []
+  class << self
+    attr_accessor :constant_overrides
+  end
 
-  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
-
-          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
@@ -127,8 +106,8 @@ class ActiveSupport::TestCase
     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
@@ -139,7 +118,7 @@ class ActiveSupport::TestCase
         end
       end
     end
-    @@constant_overrides = []
+    TestHelper.constant_overrides = []
   end
 
   def set_test_const(const_name, value)
@@ -159,7 +138,7 @@ 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
@@ -171,15 +150,15 @@ class ActiveSupport::TestCase
     else
       original_count = 0
     end
-    assert_equal expected, ActionMailer::Base.deliveries.size - original_count, "wrong number of emails#{': ' + message.to_s if message}"
+    expect(ActionMailer::Base.deliveries.size - original_count).to eq(expected), "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
 
@@ -210,3 +189,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/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", anything)
+        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