exception_handling 2.5.0 → 2.7.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Invoca
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -122,6 +122,7 @@ files:
 - ".gitignore"
 - ".jenkins/Jenkinsfile"
 - ".jenkins/ruby_build_pod.yml"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - Appraisals
@@ -143,24 +144,26 @@ files:
 - lib/exception_handling/exception_info.rb
 - lib/exception_handling/honeybadger_callbacks.rb
 - lib/exception_handling/log_stub_error.rb
+- lib/exception_handling/logging_methods.rb
 - lib/exception_handling/mailer.rb
 - lib/exception_handling/methods.rb
 - lib/exception_handling/sensu.rb
 - lib/exception_handling/testing.rb
 - lib/exception_handling/version.rb
-- test/helpers/controller_helpers.rb
-- test/helpers/exception_helpers.rb
-- test/rake_test_warning_false.rb
-- test/test_helper.rb
-- test/unit/exception_handling/exception_catalog_test.rb
-- test/unit/exception_handling/exception_description_test.rb
-- test/unit/exception_handling/exception_info_test.rb
-- test/unit/exception_handling/honeybadger_callbacks_test.rb
-- test/unit/exception_handling/log_error_stub_test.rb
-- test/unit/exception_handling/mailer_test.rb
-- test/unit/exception_handling/methods_test.rb
-- test/unit/exception_handling/sensu_test.rb
-- test/unit/exception_handling_test.rb
+- spec/helpers/controller_helpers.rb
+- spec/helpers/exception_helpers.rb
+- spec/rake_test_warning_false.rb
+- spec/spec_helper.rb
+- spec/unit/exception_handling/exception_catalog_spec.rb
+- spec/unit/exception_handling/exception_description_spec.rb
+- spec/unit/exception_handling/exception_info_spec.rb
+- spec/unit/exception_handling/honeybadger_callbacks_spec.rb
+- spec/unit/exception_handling/log_error_stub_spec.rb
+- spec/unit/exception_handling/logging_methods_spec.rb
+- spec/unit/exception_handling/mailer_spec.rb
+- spec/unit/exception_handling/methods_spec.rb
+- spec/unit/exception_handling/sensu_spec.rb
+- spec/unit/exception_handling_spec.rb
 - views/exception_handling/mailer/escalate_custom.html.erb
 - views/exception_handling/mailer/escalation_notification.html.erb
 - views/exception_handling/mailer/log_parser_exception_notification.html.erb
@@ -169,7 +172,7 @@ licenses: []
 metadata:
   source_code_uri: https://github.com/Invoca/exception_handling
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -185,21 +188,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Invoca's exception handling logger/emailer layer, based on exception_notifier.
   Works with Rails or EventMachine or EventMachine+Synchrony.
 test_files:
-- test/helpers/controller_helpers.rb
-- test/helpers/exception_helpers.rb
-- test/rake_test_warning_false.rb
-- test/test_helper.rb
-- test/unit/exception_handling/exception_catalog_test.rb
-- test/unit/exception_handling/exception_description_test.rb
-- test/unit/exception_handling/exception_info_test.rb
-- test/unit/exception_handling/honeybadger_callbacks_test.rb
-- test/unit/exception_handling/log_error_stub_test.rb
-- test/unit/exception_handling/mailer_test.rb
-- test/unit/exception_handling/methods_test.rb
-- test/unit/exception_handling/sensu_test.rb
-- test/unit/exception_handling_test.rb
+- spec/helpers/controller_helpers.rb
+- spec/helpers/exception_helpers.rb
+- spec/rake_test_warning_false.rb
+- spec/spec_helper.rb
+- spec/unit/exception_handling/exception_catalog_spec.rb
+- spec/unit/exception_handling/exception_description_spec.rb
+- spec/unit/exception_handling/exception_info_spec.rb
+- spec/unit/exception_handling/honeybadger_callbacks_spec.rb
+- spec/unit/exception_handling/log_error_stub_spec.rb
+- spec/unit/exception_handling/logging_methods_spec.rb
+- spec/unit/exception_handling/mailer_spec.rb
+- spec/unit/exception_handling/methods_spec.rb
+- spec/unit/exception_handling/sensu_spec.rb
+- spec/unit/exception_handling_spec.rb

data/test/unit/exception_handling/exception_catalog_test.rb

@@ -1,85 +0,0 @@
-# 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 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

@@ -1,82 +0,0 @@
-# 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

data/test/unit/exception_handling/methods_test.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../test_helper',  __dir__)
-
-require "exception_handling/testing"
-
-module ExceptionHandling
-  class MethodsTest < ActiveSupport::TestCase
-    include ExceptionHelpers
-
-    def dont_stub_log_error
-      true
-    end
-
-    context "ExceptionHandling.Methods" do
-      setup do
-        @controller = Testing::ControllerStub.new
-        ExceptionHandling.stub_handler = nil
-      end
-
-      should "set the around filter" do
-        assert_equal :set_current_controller, Testing::ControllerStub.around_filter_method
-        assert_nil ExceptionHandling.current_controller
-        @controller.simulate_around_filter do
-          assert_equal @controller, ExceptionHandling.current_controller
-        end
-        assert_nil ExceptionHandling.current_controller
-      end
-
-      should "use the current_controller when available" do
-        capture_notifications
-
-        mock(ExceptionHandling.logger).fatal(/blah/, anything)
-        @controller.simulate_around_filter do
-          ExceptionHandling.log_error(ArgumentError.new("blah"))
-          assert_equal 1, sent_notifications.size, sent_notifications.inspect
-          assert_match(@controller.request.request_uri, sent_notifications.last.enhanced_data['request'].to_s)
-        end
-      end
-
-      should "report long running controller action" do
-        assert_equal 2, @controller.send(:long_controller_action_timeout)
-        mock(ExceptionHandling).log_error(/Long controller action detected in #{@controller.class.name.split("::").last}::test_action/, anything, anything)
-        @controller.simulate_around_filter do
-          sleep(3)
-        end
-      end
-
-      should "not report long running controller actions if it is less than the timeout" do
-        assert_equal 2, @controller.send(:long_controller_action_timeout)
-        stub(ExceptionHandling).log_error { flunk "Should not timeout" }
-        @controller.simulate_around_filter do
-          sleep(1)
-        end
-      end
-
-      should "default long running controller action(300/30 for test/prod)" do
-        class DummyController
-          include ExceptionHandling::Methods
-        end
-
-        controller = DummyController.new
-
-        Rails.env = 'production'
-        assert_equal 30, controller.send(:long_controller_action_timeout)
-
-        Rails.env = 'test'
-        assert_equal 300, controller.send(:long_controller_action_timeout)
-      end
-
-      context "#log_warning" do
-        should "be available to the controller" do
-          assert_equal true, @controller.methods.include?(:log_warning)
-        end
-
-        should "call ExceptionHandling#log_warning" do
-          mock(ExceptionHandling).log_warning("Hi mom")
-          @controller.send(:log_warning, "Hi mom")
-        end
-      end
-    end
-
-  end
-end

data/test/unit/exception_handling/sensu_test.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../test_helper',  __dir__)
-
-module ExceptionHandling
-  class SensuTest < ActiveSupport::TestCase
-    context "#generate_event" do
-      should "create an event" do
-        mock(ExceptionHandling::Sensu).send_event(name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1)
-
-        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
-      end
-
-      should "add the sensu prefix" do
-        ExceptionHandling.sensu_prefix = "cnn_"
-
-        mock(ExceptionHandling::Sensu).send_event(name: "cnn_world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1)
-
-        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
-      end
-
-      should "allow the level to be set to critical" do
-        mock(ExceptionHandling::Sensu).send_event(name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 2)
-
-        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye", :critical)
-      end
-
-      should "error if an invalid level is supplied" do
-        dont_allow(ExceptionHandling::Sensu).send_event
-
-        assert_raise(RuntimeError, "Invalid alert level") do
-          ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye", :hair_on_fire)
-        end
-      end
-    end
-
-    context "#send_event" do
-      setup do
-        @event = { name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 }
-        @socket = SocketStub.new
-      end
-
-      should "send event json to sensu client" do
-        mock.any_instance_of(Addrinfo).connect.with_any_args { @socket }
-
-        ExceptionHandling::Sensu.send_event(@event)
-
-        assert_equal @event.to_json, @socket.sent.first
-      end
-    end
-  end
-end