exception_handling 2.5.0.pre.1 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267155818260bd0971adcfb3f325ce559c70b47fd362a8f80a2f92fc81117bf7
-  data.tar.gz: 52532fdf7184f79c85bbd384340ce99d753cd3b964ea9e1808da77091c5827b1
+  metadata.gz: e775cff5b73e955140fcc3a5492564e565567e8de147424da3602b83ad2e3b55
+  data.tar.gz: 35fa446e469e356ae600c5b24860ec8ff73dda25a72df59d5954be0748aac6bd
 SHA512:
-  metadata.gz: cf6315b8cf9c5bf2d1bae4732571ee0cc4609e57179c0935775b2b7435ebc44739ed3f61eb84f35adc22a59a7f643892f392f4d2e069ef672a17aa23c1753a67
-  data.tar.gz: d61c96173c88073a5be405480aeadd9a997749bc0b811534abe9b549c281f07b64e096123822a8268c0deb78f8eff139debd4ed93f78576305ae3ebc9e533cc8
+  metadata.gz: d3486a507210596be078ae1953105859d9d2e556b5794f9e1b01bbee21b34e6cd04be115429548a02cce1c6fec80ea680f990ba8b83d07c9594fed5c7de712d5
+  data.tar.gz: e19c845b8d8332f5118c0668c4520cabf00bf88c94117111ee2801d5320f2af2cc620224d79e3dc2e4daef62c4c7cb4115e3cc010cf56e8292cf9dcfef49f974

data/.gitignore

@@ -1,6 +1,6 @@
 .idea
 .DS_Store
 .rubocop-http*
-test/reports/*
+spec/reports/*
 gemfiles/*.lock
 pkg/

data/.jenkins/Jenkinsfile

@@ -36,42 +36,58 @@ pipeline {
     stage('Appraisals') {
       parallel {
         stage('Current') {
+          environment {
+            JUNIT_OUTPUT = 'spec/reports/current'
+          }
+
           steps {
-            sh 'JUNIT_OUTPUT_DIR=test/reports/current bundle exec rake'
+            sh "bundle exec rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
           }
 
           post {
-            always { junit '*/reports/current/*.xml' }
+            always { junit "${JUNIT_OUTPUT}/*.xml" }
           }
         }
 
         stage('Rails 4') {
+          environment {
+            JUNIT_OUTPUT = 'spec/reports/rails-4'
+          }
+
           steps {
-            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-4 bundle exec appraisal rails-4 rake'
+            sh "bundle exec appraisal rails-4 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
           }
 
           post {
-            always { junit '*/reports/rails-4/*.xml' }
+            always { junit "${JUNIT_OUTPUT}/*.xml" }
           }
         }
 
         stage('Rails 5') {
+          environment {
+            JUNIT_OUTPUT = 'spec/reports/rails-5'
+          }
+
           steps {
-            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-5 bundle exec appraisal rails-5 rake'
+            sh "bundle exec appraisal rails-5 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
           }
 
           post {
-            always { junit '*/reports/rails-5/*.xml' }
+            always { junit "${JUNIT_OUTPUT}/*.xml" }
           }
         }
 
         stage('Rails 6') {
+          environment {
+            JUNIT_OUTPUT = 'spec/reports/rails-6'
+          }
+
           steps {
-            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-6 bundle exec appraisal rails-6 rake'
+            sh "bundle exec appraisal rails-6 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
           }
 
           post {
-            always { junit '*/reports/rails-6/*.xml' }
+            always { junit "${JUNIT_OUTPUT}/*.xml" }
           }
         }
       }

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format progress
+--color

data/CHANGELOG.md

@@ -4,11 +4,28 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.5.0] - Unreleased
+## [2.6.1] - 2020-10-14
+### Fixed
+- Fixed honeybadger_context_data to always merge `current_context_for_thread`, even if `log_context:` is passed as `nil`.
+
+## [2.6.0] - 2020-08-26
+### Changed
+- Calling `log_warning` will now log with Severity::WARNING rather than FATAL.
+- Reordered the logging to put the exception class next to the message.
+
+## [2.5.0] - 2020-08-19
 ### Added
 - The `**log_context` passed to `log_error`/`log_warning`/`log_info` is now
   passed into `Honeybadger.notify()`, in `context: { log_context: ... }`.
 
+### Fixed
+- Silenced test warning noise by no longer running ruby -w.
+- Renamed a constant to ALLOWLIST.
+
+## [2.4.4] - 2020-08-10
+### Fixed
+- `ExceptionHandling.logger = nil` no longer displays an "implicit extend" deprecation warning.
+
 ## [2.4.3] - 2020-05-14
 ### Deprecated
 - In `ExceptionHandling.logger=`, implicit `logger.extend ContextualLogger::LoggerMixin` is now deprecated.
@@ -29,7 +46,10 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
-[2.5.0]: https://github.com/Invoca/exception_handling/compare/v2.4.3...v2.5.0
+[2.6.1]: https://github.com/Invoca/exception_handling/compare/v2.6.0...v2.6.1
+[2.6.0]: https://github.com/Invoca/exception_handling/compare/v2.5.0...v2.6.0
+[2.5.0]: https://github.com/Invoca/exception_handling/compare/v2.4.4...v2.5.0
+[2.4.4]: https://github.com/Invoca/exception_handling/compare/v2.4.3...v2.4.4
 [2.4.3]: https://github.com/Invoca/exception_handling/compare/v2.4.2...v2.4.3
 [2.4.2]: https://github.com/Invoca/exception_handling/compare/v2.4.1...v2.4.2
 [2.4.1]: https://github.com/Invoca/exception_handling/compare/v2.4.0...v2.4.1

data/Gemfile

@@ -6,10 +6,10 @@ gemspec
 
 gem 'appraisal', '~> 2.2'
 gem 'honeybadger', '3.3.1-1', git: 'git@github.com:Invoca/honeybadger-ruby', ref: 'bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6'
-gem "minitest"
-gem "minitest-reporters"
 gem 'pry'
+gem 'pry-byebug'
 gem 'rake'
-gem 'rr'
+gem 'rspec'
+gem 'rspec_junit_formatter'
 gem 'rubocop'
-gem 'shoulda'
+gem 'test-unit'

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.5.0.pre.1)
+    exception_handling (2.6.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)
@@ -46,19 +46,20 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    ansi (1.5.0)
     appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.0)
     builder (3.2.3)
+    byebug (11.1.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    contextual_logger (0.8.0)
+    contextual_logger (0.10.0)
       activesupport
       json
     crass (1.0.6)
+    diff-lcs (1.4.4)
     erubis (2.7.0)
     eventmachine (1.2.7)
     globalid (0.4.2)
@@ -68,7 +69,7 @@ GEM
     invoca-utils (0.4.1)
     jaro_winkler (1.5.3)
     json (2.3.1)
-    loofah (2.6.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -77,19 +78,18 @@ GEM
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
-    minitest-reporters (1.0.20)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
+    power_assert (1.2.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     rack (1.6.13)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -103,7 +103,21 @@ GEM
       loofah (~> 2.3)
     rainbow (3.0.0)
     rake (13.0.1)
-    rr (1.2.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -112,12 +126,8 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    shoulda (3.6.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (~> 3.0)
-    shoulda-context (1.2.2)
-    shoulda-matchers (3.1.3)
-      activesupport (>= 4.0.0)
+    test-unit (3.3.6)
+      power_assert
     thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
@@ -131,13 +141,13 @@ DEPENDENCIES
   appraisal (~> 2.2)
   exception_handling!
   honeybadger (= 3.3.1.pre.1)!
-  minitest
-  minitest-reporters
   pry
+  pry-byebug
   rake
-  rr
+  rspec
+  rspec_junit_formatter
   rubocop
-  shoulda
+  test-unit
 
 BUNDLED WITH
    1.17.3

data/Rakefile

@@ -1,14 +1,15 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
 require 'rake/testtask'
+require "bundler/gem_tasks"
 
-require_relative 'test/rake_test_warning_false'
-
-task default: :test
+require_relative 'spec/rake_test_warning_false'
 
-Rake::TestTask.new do |t|
-  t.pattern = "test/**/*_test.rb"
+desc "run rspec unit tests"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:rspec)
 end
 
+task default: :rspec

data/lib/exception_handling.rb

@@ -57,7 +57,7 @@ module ExceptionHandling # never included
     Deprecation3_0 = ActiveSupport::Deprecation.new('3.0', 'exception_handling')
 
     def logger=(logger)
-      @logger = if logger.is_a?(ContextualLogger::LoggerMixin)
+      @logger = if logger.nil? || logger.is_a?(ContextualLogger::LoggerMixin)
                   logger
                 else
                   Deprecation3_0.deprecation_warning('implicit extend with ContextualLogger::LoggerMixin', 'extend your logger instance or include into your logger class first')
@@ -222,7 +222,13 @@ module ExceptionHandling # never included
     #
     def write_exception_to_log(ex, exception_context, timestamp, log_context = {})
       ActiveSupport::Deprecation.silence do
-        ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{ex.class} #{exception_context} (#{encode_utf8(ex.message.to_s)}):\n  " + clean_backtrace(ex).join("\n  ") + "\n\n", log_context)
+        log_message = "#{exception_context}\n#{ex.class}: (#{encode_utf8(ex.message.to_s)}):\n  " + clean_backtrace(ex).join("\n  ") + "\n\n"
+
+        if ex.is_a?(Warning)
+          ExceptionHandling.logger.warn("\nExceptionHandlingWarning (Warning:#{timestamp}) #{log_message}", log_context)
+        else
+          ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{log_message}", log_context)
+        end
       end
     end
 

data/lib/exception_handling/exception_info.rb

@@ -57,7 +57,8 @@ module ExceptionHandling
       @timestamp = timestamp
       @controller = controller || controller_from_context(exception_context)
       @data_callback = data_callback
-      @log_context = log_context
+      # merge into the surrounding context just like ContextualLogger does when logging
+      @merged_log_context = ExceptionHandling.logger.current_context_for_thread.deep_merge(log_context || {})
     end
 
     def data
@@ -269,15 +270,13 @@ module ExceptionHandling
       data = enhanced_data.dup
       data[:server] = ExceptionHandling.server_name
       data[:exception_context] = deep_clean_hash(@exception_context) if @exception_context.present?
-      data[:log_context] = @log_context
+      data[:log_context] = @merged_log_context
       unstringify_sections(data)
-      context_data = HONEYBADGER_CONTEXT_SECTIONS.reduce({}) do |context, section|
+      HONEYBADGER_CONTEXT_SECTIONS.each_with_object({}) do |section, context|
         if data[section].present?
           context[section] = data[section]
         end
-        context
       end
-      context_data
     end
   end
 end

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.5.0.pre.1'
+  VERSION = '2.6.1'
 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/spec/rake_test_warning_false.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Rake 11+ has a misfeature where @warning = true by default
+# See https://github.com/ruby/rake/pull/97/files
+# This causes all tests to be run with `ruby -w`, causing a huge number of warnings
+# from gems we don't control and overwhelming our test output.
+# This patch reverts that.
+
+_ = Rake::TestTask
+
+class Rake::TestTask
+  module SetWarningFalseMixin
+    def initialize(*args)
+      super
+      self.warning = false
+    end
+  end
+
+  prepend SetWarningFalseMixin
+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
@@ -33,16 +22,20 @@ class LoggerStub
     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
@@ -83,27 +76,17 @@ 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
+module TestHelper
+  @constant_overrides = []
+  class << self
+    attr_accessor :constant_overrides
+  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
@@ -123,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
@@ -135,7 +118,7 @@ class ActiveSupport::TestCase
         end
       end
     end
-    @@constant_overrides = []
+    TestHelper.constant_overrides = []
   end
 
   def set_test_const(const_name, value)
@@ -155,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
@@ -167,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
 
@@ -206,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