exception_notification 4.4.0 → 4.4.1

data/test/exception_notification/resque_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 require 'exception_notification/resque'

data/test/exception_notifier/campfire_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 # silence_warnings trick around require can be removed once
@@ -94,11 +96,16 @@ class CampfireNotifierTest < ActiveSupport::TestCase
     {
       message: {
         type: 'PasteMessage',
-        body: "A new exception occurred: 'divided by 0' on '/Users/sebastian/exception_notification/test/campfire_test.rb:45:in `/'"
+        body: fake_notification_body
       }
     }
   end
 
+  def fake_notification_body
+    "A new exception occurred: 'divided by 0' on " \
+    "/Users/sebastian/exception_notification/test/campfire_test.rb:45:in `/'"
+  end
+
   def fake_exception
     5 / 0
   rescue StandardError => e

data/test/exception_notifier/datadog_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'dogapi/common'
 require 'dogapi/event'

data/test/exception_notifier/email_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'action_mailer'
 require 'action_controller'
@@ -116,7 +118,7 @@ class EmailNotifierTest < ActiveSupport::TestCase
       env: {
         'REQUEST_METHOD' => 'GET',
         'rack.input' => '',
-        'invalid_encoding' => "R\xC3\xA9sum\xC3\xA9".force_encoding(Encoding::ASCII)
+        'invalid_encoding' => "R\xC3\xA9sum\xC3\xA9".dup.force_encoding(Encoding::ASCII)
       }
     )
 
@@ -220,8 +222,10 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
       email_headers: { 'X-Custom-Header' => 'foobar' },
       sections: %w[new_section request session environment backtrace],
       background_sections: %w[new_bkg_section backtrace data],
-      pre_callback: proc { |_opts, _notifier, _backtrace, _message, message_opts| message_opts[:pre_callback_called] = 1 },
-      post_callback: proc { |_opts, _notifier, _backtrace, _message, message_opts| message_opts[:post_callback_called] = 1 }
+      pre_callback:
+        proc { |_opts, _notifier, _backtrace, _message, message_opts| message_opts[:pre_callback_called] = 1 },
+      post_callback:
+        proc { |_opts, _notifier, _backtrace, _message, message_opts| message_opts[:post_callback_called] = 1 }
     )
 
     @controller = HomeController.new
@@ -349,3 +353,25 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
     assert_equal '[ERROR]  (ZeroDivisionError) "divided by 0"', mail.subject
   end
 end
+
+class EmailNotifierWithCustomParentClassTest < ActiveSupport::TestCase
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'infrastructure@example.com'
+  end
+
+  setup do
+    @exception = ZeroDivisionError.new('divided by 0')
+    @exception.set_backtrace(["#{__FILE__}:#{__LINE__}"])
+  end
+
+  test 'uses default from configured parent class' do
+    email_notifier = ExceptionNotifier::EmailNotifier.new(
+      mailer_parent: 'EmailNotifierWithCustomParentClassTest::ApplicationMailer',
+      exception_recipients: %w[dummyexceptions@example.com]
+    )
+    mail = email_notifier.call(@exception)
+
+    assert email_notifier.__send__(:mailer) < ApplicationMailer
+    assert_equal ['infrastructure@example.com'], mail.from
+  end
+end

data/test/exception_notifier/google_chat_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'rack'
 require 'httparty'
@@ -5,7 +7,7 @@ require 'timecop'
 require 'json'
 
 class GoogleChatNotifierTest < ActiveSupport::TestCase
-  URL = 'http://localhost:8000'.freeze
+  URL = 'http://localhost:8000'
 
   def setup
     Timecop.freeze('2018-12-09 12:07:16 UTC')
@@ -59,11 +61,7 @@ class GoogleChatNotifierTest < ActiveSupport::TestCase
       header,
       body,
       '',
-      '*Backtrace:*',
-      '```',
-      "* app/controllers/my_controller.rb:53:in `my_controller_params'",
-      "* app/controllers/my_controller.rb:34:in `update'",
-      '```'
+      backtrace
     ].join("\n")
 
     HTTParty.expects(:post).with(URL, post_opts(text))
@@ -117,11 +115,7 @@ class GoogleChatNotifierTest < ActiveSupport::TestCase
       '* timestamp : 2018-12-09 12:07:16 UTC',
       '```',
       '',
-      '*Backtrace:*',
-      '```',
-      "* app/controllers/my_controller.rb:53:in `my_controller_params'",
-      "* app/controllers/my_controller.rb:34:in `update'",
-      '```'
+      backtrace
     ].join("\n")
 
     HTTParty.expects(:post).with(URL, post_opts(text))
@@ -178,4 +172,14 @@ class GoogleChatNotifierTest < ActiveSupport::TestCase
   def app_name
     'dummy' if defined?(::Rails) && ::Rails.respond_to?(:application)
   end
+
+  def backtrace
+    [
+      '*Backtrace:*',
+      '```',
+      "* app/controllers/my_controller.rb:53:in `my_controller_params'",
+      "* app/controllers/my_controller.rb:34:in `update'",
+      '```'
+    ]
+  end
 end

data/test/exception_notifier/hipchat_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'rack'
 
@@ -33,7 +35,9 @@ class HipchatNotifierTest < ActiveSupport::TestCase
       post_callback: proc { |*| post_callback_called += 1 }
     }
 
-    HipChat::Room.any_instance.expects(:send).with('Exception', fake_body, { color: 'yellow' }.merge(options.except(:api_token, :room_name)))
+    HipChat::Room.any_instance
+                 .expects(:send)
+                 .with('Exception', fake_body, { color: 'yellow' }.merge(options.except(:api_token, :room_name)))
 
     hipchat = ExceptionNotifier::HipchatNotifier.new(options)
     hipchat.call(fake_exception)
@@ -105,7 +109,9 @@ class HipchatNotifierTest < ActiveSupport::TestCase
       message_template: ->(exception, _) { "This is custom message: '#{exception.message}'" }
     }
 
-    HipChat::Room.any_instance.expects(:send).with('Exception', "This is custom message: '#{fake_exception.message}'", color: 'yellow')
+    HipChat::Room.any_instance
+                 .expects(:send)
+                 .with('Exception', "This is custom message: '#{fake_exception.message}'", color: 'yellow')
 
     hipchat = ExceptionNotifier::HipchatNotifier.new(options)
     hipchat.call(fake_exception)

data/test/exception_notifier/irc_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'carrier-pigeon'
 

data/test/exception_notifier/mattermost_notifier_test.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'httparty'
 require 'timecop'
 require 'json'
 
 class MattermostNotifierTest < ActiveSupport::TestCase
-  URL = 'http://localhost:8000'.freeze
+  URL = 'http://localhost:8000'
 
   def setup
     Timecop.freeze('2018-12-09 12:07:16 UTC')
@@ -113,27 +115,14 @@ class MattermostNotifierTest < ActiveSupport::TestCase
   end
 
   test 'should include backtrace and request info' do
-    body = default_body.merge(
-      text: [
-        '@channel',
-        error_occurred_in,
-        'An *ArgumentError* occurred.',
-        '*foo*',
-        '### Request',
-        '```',
-        '* url : http://test.address/?id=foo',
-        '* http_method : GET',
-        '* ip_address : 127.0.0.1',
-        '* parameters : {"id"=>"foo"}',
-        '* timestamp : 2018-12-09 12:07:16 UTC',
-        '```',
-        '### Backtrace',
-        '```',
-        "* app/controllers/my_controller.rb:53:in `my_controller_params'",
-        "* app/controllers/my_controller.rb:34:in `update'",
-        '```'
-      ].join("\n")
-    )
+    body = default_body.merge(text: [
+      '@channel',
+      error_occurred_in,
+      'An *ArgumentError* occurred.',
+      '*foo*',
+      request_info,
+      backtrace_info
+    ].join("\n"))
 
     opts = {
       body: body.to_json,
@@ -151,6 +140,31 @@ class MattermostNotifierTest < ActiveSupport::TestCase
     notifier.call(exception, env: test_env)
   end
 
+  test 'should include exception_data_info' do
+    body = default_body.merge(
+      text: [
+        '@channel',
+        error_occurred_in,
+        'An *ArgumentError* occurred.',
+        '*foo*',
+        request_info,
+        exception_data_info
+      ].join("\n")
+    )
+
+    opts = {
+      body: body.to_json,
+      headers: default_headers
+    }
+
+    env = test_env.merge(
+      'exception_notifier.exception_data' => { foo: 'bar', john: 'doe' }
+    )
+
+    HTTParty.expects(:post).with(URL, opts)
+    notifier.call(ArgumentError.new('foo'), env: env)
+  end
+
   private
 
   def notifier
@@ -193,10 +207,45 @@ class MattermostNotifierTest < ActiveSupport::TestCase
 
   def github_link
     if defined?(::Rails) && ::Rails.respond_to?(:application)
-      '[Create an issue](github.com/aschen/dummy/issues/new/?issue%5Btitle%5D=%5BBUG%5D+Error+500+%3A++%28ArgumentError%29+foo)'
+      '[Create an issue]' \
+      '(github.com/aschen/dummy/issues/new/?issue%5Btitle%5D=%5BBUG%5D+Error+500+%3A++%28ArgumentError%29+foo)'
     else
       # TODO: fix missing app name
-      '[Create an issue](github.com/aschen//issues/new/?issue%5Btitle%5D=%5BBUG%5D+Error+500+%3A++%28ArgumentError%29+foo)'
+      '[Create an issue]' \
+      '(github.com/aschen//issues/new/?issue%5Btitle%5D=%5BBUG%5D+Error+500+%3A++%28ArgumentError%29+foo)'
     end
   end
+
+  def request_info
+    [
+      '### Request',
+      '```',
+      '* url : http://test.address/?id=foo',
+      '* http_method : GET',
+      '* ip_address : 127.0.0.1',
+      '* parameters : {"id"=>"foo"}',
+      '* timestamp : 2018-12-09 12:07:16 UTC',
+      '```'
+    ]
+  end
+
+  def backtrace_info
+    [
+      '### Backtrace',
+      '```',
+      "* app/controllers/my_controller.rb:53:in `my_controller_params'",
+      "* app/controllers/my_controller.rb:34:in `update'",
+      '```'
+    ]
+  end
+
+  def exception_data_info
+    [
+      '### Data',
+      '```',
+      '* foo : bar',
+      '* john : doe',
+      '```'
+    ]
+  end
 end

data/test/exception_notifier/modules/error_grouping_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class ErrorGroupTest < ActiveSupport::TestCase

data/test/exception_notifier/modules/formatter_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'timecop'
 

data/test/exception_notifier/sidekiq_test.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 # To allow sidekiq error handlers to be registered, sidekiq must be in
 # "server mode". This mode is triggered by loading sidekiq/cli. Note this
 # has to be loaded before exception_notification/sidekiq.
 require 'sidekiq/cli'
+require 'sidekiq/testing'
 
 require 'exception_notification/sidekiq'
 
@@ -12,13 +15,6 @@ class MockSidekiqServer
 end
 
 class SidekiqTest < ActiveSupport::TestCase
-  setup do
-    @_original_sidekiq_logger = Sidekiq::Logging.logger
-
-    # Silence sidekiq warning to stdout
-    Sidekiq::Logging.logger = nil
-  end
-
   test 'should call notify_exception when sidekiq raises an error' do
     server = MockSidekiqServer.new
     message = {}
@@ -31,8 +27,4 @@ class SidekiqTest < ActiveSupport::TestCase
 
     server.handle_exception(exception, message)
   end
-
-  teardown do
-    Sidekiq::Logging.logger = @_original_sidekiq_logger
-  end
 end

data/test/exception_notifier/slack_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'slack-notifier'
 
@@ -128,15 +130,17 @@ class SlackNotifierTest < ActiveSupport::TestCase
         'exception_notifier.exception_data' => { foo: 'bar', john: 'doe' }
       },
       data: {
-        'user_id'           => 5,
+        'user_id' => 5,
         'key_to_be_ignored' => 'whatever',
-        'ignore_as_well'    => { what: 'ever' }
+        'ignore_as_well' => { what: 'ever' }
       }
     }
 
     expected_data_string = "foo: bar\njohn: doe\nuser_id: 5"
 
-    Slack::Notifier.any_instance.expects(:ping).with('', fake_notification(@exception, notification_options, expected_data_string))
+    Slack::Notifier.any_instance
+                   .expects(:ping)
+                   .with('', fake_notification(@exception, notification_options, expected_data_string))
     slack_notifier = ExceptionNotifier::SlackNotifier.new(options)
     slack_notifier.call(@exception, notification_options)
   end
@@ -184,12 +188,8 @@ class SlackNotifierTest < ActiveSupport::TestCase
 
   def fake_backtrace
     [
-      'backtrace line 1',
-      'backtrace line 2',
-      'backtrace line 3',
-      'backtrace line 4',
-      'backtrace line 5',
-      'backtrace line 6'
+      'backtrace line 1', 'backtrace line 2', 'backtrace line 3',
+      'backtrace line 4', 'backtrace line 5', 'backtrace line 6'
     ]
   end
 
@@ -197,7 +197,9 @@ class SlackNotifierTest < ActiveSupport::TestCase
     fake_backtrace[2..-1]
   end
 
-  def fake_notification(exception = @exception, notification_options = {}, data_string = nil, expected_backtrace_lines = 10, additional_fields = [])
+  def fake_notification(exception = @exception, notification_options = {},
+                        data_string = nil, expected_backtrace_lines = 10, additional_fields = [])
+
     exception_name = "*#{exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A'}* `#{exception.class}`"
     if notification_options[:env].nil?
       text = "#{exception_name} *occured in background*"

data/test/exception_notifier/sns_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'aws-sdk-sns'
 
@@ -61,9 +63,9 @@ class SnsNotifierTest < ActiveSupport::TestCase
   test 'should send a sns notification in background' do
     Aws::SNS::Client.any_instance.expects(:publish).with(
       topic_arn: 'topicARN',
-      message: "3 MyException occured in background\n"\
-             "Exception: undefined method 'method=' for Empty\n"\
-             "Hostname: example.com\n"\
+      message: "3 MyException occured in background\n" \
+             "Exception: undefined method 'method=' for Empty\n" \
+             "Hostname: example.com\n" \
              "Backtrace:\n#{fake_backtrace.join("\n")}\n",
       subject: '[App Exception] - 3 MyException occurred'
     )
@@ -79,10 +81,10 @@ class SnsNotifierTest < ActiveSupport::TestCase
 
     Aws::SNS::Client.any_instance.expects(:publish).with(
       topic_arn: 'topicARN',
-      message: 'A MyException occurred while GET </examples> '\
-             "was processed by examples#index\n"\
-             "Exception: undefined method 'method=' for Empty\n"\
-             "Hostname: example.com\n"\
+      message: 'A MyException occurred while GET </examples> ' \
+             "was processed by examples#index\n" \
+             "Exception: undefined method 'method=' for Empty\n" \
+             "Hostname: example.com\n" \
              "Backtrace:\n#{fake_backtrace.join("\n")}\n",
       subject: '[App Exception] - A MyException occurred'
     )

data/test/exception_notifier/teams_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'httparty'