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

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

@@ -1,50 +1,42 @@
 # frozen_string_literal: true
 
-require 'rspec'
-require 'rspec/mocks'
-require 'rspec_junit_formatter'
-
+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 'pry'
-require 'pry-byebug'
 require 'honeybadger'
 require 'contextual_logger'
 
 require 'exception_handling'
 require 'exception_handling/testing'
 
+ActiveSupport::TestCase.test_order = :sorted
+
 class LoggerStub
-  include ContextualLogger::LoggerMixin
-  attr_accessor :logged, :level
+  include ContextualLogger
+  attr_accessor :logged
 
   def initialize
-    @level = Logger::Severity::DEBUG
-    @progname = nil
-    @logdev = nil
     clear
   end
 
-  def debug(message, **log_context)
-    super.tap do
-      logged << { message: message, context: log_context, severity: 'DEBUG' }
-    end
-  end
-
-  def info(message, **log_context)
-    super.tap do
-      logged << { message: message, context: log_context, severity: 'INFO' }
-    end
+  def info(message, log_context = {})
+    logged << { message: message, context: log_context }
   end
 
-  def warn(message, **log_context)
-    super.tap do
-      logged << { message: message, context: log_context, severity: 'WARN' }
-    end
+  def warn(message, log_context = {})
+    logged << { message: message, context: log_context }
   end
 
-  def fatal(message, **log_context)
-    super.tap do
-      logged << { message: message, context: log_context, severity: 'FATAL' }
-    end
+  def fatal(message, log_context = {})
+    logged << { message: message, context: log_context }
   end
 
   def clear
@@ -85,17 +77,27 @@ end
 
 ActionMailer::Base.delivery_method = :test
 
+_ = ActiveSupport
+_ = ActiveSupport::TestCase
 
-module TestHelper
-  @constant_overrides = []
-  class << self
-    attr_accessor :constant_overrides
-  end
+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
 
-  def setup_constant_overrides
-    unless TestHelper.constant_overrides.nil? || TestHelper.constant_overrides.empty?
-      raise "Uh-oh! constant_overrides left over: #{TestHelper.constant_overrides.inspect}"
+          def env
+            @env ||= 'test'
+          end
+        end
+      end
     end
 
     Time.now_override = nil
@@ -115,8 +117,8 @@ module TestHelper
     ExceptionHandling.sensu_prefix            = ""
   end
 
-  def teardown_constant_overrides
-    TestHelper.constant_overrides&.reverse&.each do |parent_module, k, v|
+  teardown do
+    @@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
@@ -127,7 +129,7 @@ module TestHelper
         end
       end
     end
-    TestHelper.constant_overrides = []
+    @@constant_overrides = []
   end
 
   def set_test_const(const_name, value)
@@ -147,7 +149,7 @@ module TestHelper
         end
       end
 
-    TestHelper.constant_overrides << [final_parent_module, final_const_name, original_value]
+    @@constant_overrides << [final_parent_module, final_const_name, original_value]
 
     silence_warnings { final_parent_module.const_set(final_const_name, value) }
   end
@@ -159,15 +161,15 @@ module TestHelper
     else
       original_count = 0
     end
-    expect(ActionMailer::Base.deliveries.size - original_count).to eq(expected), "wrong number of emails#{': ' + message.to_s if message}"
+    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
-    expect(true).to be_truthy # To keep the assertion count accurate
+    assert true # To keep the assertion count accurate
   else
-    expect(arg1).to eq(arg2), "#{msg}\n#{Diff.compare(arg1, arg2)}"
+    assert_equal arg1, arg2, "#{msg}\n#{Diff.compare(arg1, arg2)}"
   end
 end
 
@@ -198,35 +200,3 @@ 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/test/unit/exception_handling/exception_catalog_test.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../test_helper',  __dir__)
+
+module ExceptionHandling
+  class ExceptionCatalogTest < ActiveSupport::TestCase
+
+    context "With stubbed yaml content" do
+      setup do
+        filter_list = { exception1: { error: "my error message" },
+                        exception2: { error: "some other message", session: "misc data" } }
+        stub(YAML).load_file { filter_list }
+
+        # bump modified time up to get the above filter loaded
+        stub(File).mtime { incrementing_mtime }
+      end
+
+      context "with loaded data" do
+        setup do
+          stub(File).mtime { incrementing_mtime }
+          @exception_catalog = ExceptionCatalog.new(ExceptionHandling.filter_list_filename)
+          @exception_catalog.send :load_file
+        end
+
+        should "have loaded filters" do
+          assert_equal 2, @exception_catalog.instance_eval("@filters").size
+        end
+
+        should "find messages in the catalog" do
+          assert !@exception_catalog.find(error: "Scott says unlikely to ever match")
+        end
+
+        should "find matching data" do
+          exception_description = @exception_catalog.find(error: "this is my error message, which should match something")
+          assert exception_description
+          assert_equal :exception1, exception_description.filter_name
+        end
+      end
+
+      should "write errors loading the yaml file directly to the log file" do
+        @exception_catalog = ExceptionCatalog.new(ExceptionHandling.filter_list_filename)
+
+        mock(ExceptionHandling).log_error.never
+        mock(ExceptionHandling).write_exception_to_log(anything, "ExceptionCatalog#refresh_filters: ./config/exception_filters.yml", anything)
+        mock(@exception_catalog).load_file { raise "noooooo" }
+
+        @exception_catalog.find({})
+      end
+    end
+
+    context "with live yaml content" do
+      setup do
+        @filename = File.expand_path('../../../config/exception_filters.yml',  __dir__)
+        @exception_catalog = ExceptionCatalog.new(@filename)
+        assert_nothing_raised "Loading the exception filter should not raise" do
+          @exception_catalog.send :load_file
+        end
+      end
+
+      should "load the filter data" do
+        assert !@exception_catalog.find(error: "Scott says unlikely to ever match")
+        assert !@exception_catalog.find(error: "Scott says unlikely to ever match")
+      end
+    end
+
+    context "with no yaml content" do
+      setup do
+        @exception_catalog = ExceptionCatalog.new(nil)
+      end
+
+      should "not load filter data" do
+        mock(ExceptionHandling).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/test/unit/exception_handling/exception_description_test.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../test_helper',  __dir__)
+
+module ExceptionHandling
+  class ExceptionDescriptionTest < ActiveSupport::TestCase
+
+    context "Filter" do
+      should "allow direct matching of strings" do
+        @f = ExceptionDescription.new(:filter1, error: "my error message")
+        assert @f.match?('error' => "my error message")
+      end
+
+      should "allow direct matching of strings on with symbol keys" do
+        @f = ExceptionDescription.new(:filter1, error: "my error message")
+        assert @f.match?(error: "my error message")
+      end
+
+      should "allow wildcards to cross line boundries" do
+        @f = ExceptionDescription.new(:filter1, error: "my error message.*with multiple lines")
+        assert @f.match?(error: "my error message\nwith more than one, with multiple lines")
+      end
+
+      should "complain when no regexps have a value" do
+        assert_raise(ArgumentError, "has all blank regexe") { ExceptionDescription.new(:filter1, error: nil) }
+      end
+
+      should "report when an invalid key is passed" do
+        assert_raise(ArgumentError, "Unknown section: not_a_parameter") { ExceptionDescription.new(:filter1, error: "my error message", not_a_parameter: false) }
+      end
+
+      should "allow send_to_honeybadger to be specified and have it disabled by default" do
+        assert !ExceptionDescription.new(:filter1, error: "my error message", send_to_honeybadger: false).send_to_honeybadger
+        assert ExceptionDescription.new(:filter1, error: "my error message", send_to_honeybadger: true).send_to_honeybadger
+        assert !ExceptionDescription.new(:filter1, error: "my error message").send_to_honeybadger
+      end
+
+      should "allow send_metric to be configured" do
+        assert !ExceptionDescription.new(:filter1, error: "my error message", send_metric: false).send_metric
+        assert ExceptionDescription.new(:filter1, error: "my error message").send_metric
+      end
+
+      should "provide metric name" do
+        assert_equal "filter1", ExceptionDescription.new(:filter1, error: "my error message").metric_name
+        assert_equal "some_other_metric_name", ExceptionDescription.new(:filter1, error: "my error message", metric_name: :some_other_metric_name).metric_name
+      end
+
+      should "replace spaces in metric name" do
+        @f = ExceptionDescription.new(:"filter has spaces", error: "my error message")
+        assert_equal "filter_has_spaces", @f.metric_name
+      end
+
+      should "allow notes to be recorded" do
+        assert_nil ExceptionDescription.new(:filter1, error: "my error message").notes
+        assert_equal "a long string", ExceptionDescription.new(:filter1, error: "my error message", notes: "a long string").notes
+      end
+
+      should "not consider config options in the filter set" do
+        assert ExceptionDescription.new(:filter1, error: "my error message", send_metric: false).match?(error: "my error message")
+        assert ExceptionDescription.new(:filter1, error: "my error message", metric_name: "false").match?(error: "my error message")
+        assert ExceptionDescription.new(:filter1, error: "my error message", notes: "hey").match?(error: "my error message")
+      end
+
+      should "provide exception details" do
+        exception_description = ExceptionDescription.new(:filter1, error: "my error message", notes: "hey")
+
+        expected = { "send_metric" => true, "metric_name" => "filter1", "notes" => "hey" }
+
+        assert_equal expected, exception_description.exception_data
+      end
+
+      should "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'")
+        assert exception_description.match?(error: mobi), "does not match mobi"
+        assert exception_description.match?(error: credit), "does not match credit"
+      end
+    end
+  end
+end