exception_notification 3.0.1 → 4.0.0.rc1

data/test/dummy/config/environment.rb

@@ -1,13 +1,15 @@
 # Load the rails application
 require File.expand_path('../application', __FILE__)
 
-Dummy::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix => "[Dummy ERROR] ",
-  :sender_address => %{"Dummy Notifier" <dummynotifier@example.com>},
-  :exception_recipients => %w{dummyexceptions@example.com},
-  :email_headers => { "X-Custom-Header" => "foobar" },
-  :sections => ['new_section', 'request', 'session', 'environment', 'backtrace'],
-  :background_sections => %w(new_bkg_section) + ExceptionNotifier::Notifier.default_background_sections
+Dummy::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Dummy ERROR] ",
+    :sender_address => %{"Dummy Notifier" <dummynotifier@example.com>},
+    :exception_recipients => %w{dummyexceptions@example.com},
+    :email_headers => { "X-Custom-Header" => "foobar" },
+    :sections => ['new_section', 'request', 'session', 'environment', 'backtrace'],
+    :background_sections => %w(new_bkg_section backtrace data)
+  }
 
 # Initialize the rails application
 Dummy::Application.initialize!

data/test/dummy/test/functional/posts_controller_test.rb

@@ -2,12 +2,14 @@ require 'test_helper'
 
 class PostsControllerTest < ActionController::TestCase
   setup do
+    Time.stubs(:current).returns('Sat, 20 Apr 2013 20:58:55 UTC +00:00')
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
     begin
       @post = posts(:one)
       post :create, :post => @post.attributes
     rescue => e
       @exception = e
-      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception, {:data => {:message => 'My Custom Message'}})
+      @mail = @email_notifier.create_email(@exception, {:env => request.env, :data => {:message => 'My Custom Message'}})
     end
   end
 
@@ -72,8 +74,8 @@ class PostsControllerTest < ActionController::TestCase
       get :show, :id => @post.to_param + "10"
     rescue => e
       @ignored_exception = e
-      unless ExceptionNotifier.default_ignore_exceptions.include?(@ignored_exception.class.name)
-        @ignored_mail = ExceptionNotifier::Notifier.exception_notification(request.env, @ignored_exception)
+      unless ExceptionNotifier.ignored_exceptions.include?(@ignored_exception.class.name)
+        @ignored_mail = @email_notifier.create_email(@ignored_exception, {:env => request.env})
       end
     end
 
@@ -87,14 +89,14 @@ class PostsControllerTest < ActionController::TestCase
       @post = posts(:one)
       post :create, :post => @post.attributes
     rescue => e
-      @secured_mail = ExceptionNotifier::Notifier.exception_notification(request.env, e)
+      @secured_mail = @email_notifier.create_email(e, {:env => request.env})
     end
 
     assert request.ssl?
     assert @secured_mail.encoded.include? "* session id: [FILTERED]\r\n  *"
   end
 
-  test "should ignore exception if from unwanted cralwer" do
+  test "should ignore exception if from unwanted crawler" do
     request.env['HTTP_USER_AGENT'] = "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
     begin
       @post = posts(:one)
@@ -105,27 +107,8 @@ class PostsControllerTest < ActionController::TestCase
       custom_env['exception_notifier.options'] ||= {}
       custom_env['exception_notifier.options'].merge!(:ignore_crawlers => %w(Googlebot))
       ignore_array = custom_env['exception_notifier.options'][:ignore_crawlers]
-      unless ExceptionNotifier.new(Dummy::Application, custom_env['exception_notifier.options']).send(:from_crawler, ignore_array, custom_env['HTTP_USER_AGENT'])
-        @ignored_mail = ExceptionNotifier::Notifier.exception_notification(custom_env, @exception)
-      end
-    end
-
-    assert_nil @ignored_mail
-  end
-
-  test "should ignore exception if satisfies conditional ignore" do
-    request.env['IGNOREME'] = "IGNOREME"
-    begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
-    rescue => e
-      @exception = e
-      custom_env = request.env
-      custom_env['exception_notifier.options'] ||= {}
-      ignore_cond = {:ignore_if => lambda {|env, e| (env['IGNOREME'] == 'IGNOREME') && (e.message =~ /undefined method/)}}
-      custom_env['exception_notifier.options'].merge!(ignore_cond)
-      unless ExceptionNotifier.new(Dummy::Application, custom_env['exception_notifier.options']).send(:conditionally_ignored, ignore_cond[:ignore_if], custom_env, @exception)
-        @ignored_mail = ExceptionNotifier::Notifier.exception_notification(custom_env, @exception)
+      unless ExceptionNotification::Rack.new(Dummy::Application, custom_env['exception_notifier.options']).send(:from_crawler, custom_env, ignore_array)
+        @ignored_mail = @email_notifier.create_email(@exception, {:env => custom_env})
       end
     end
 
@@ -141,7 +124,7 @@ class PostsControllerTest < ActionController::TestCase
       custom_env = request.env
       custom_env['exception_notifier.options'] ||= {}
       custom_env['exception_notifier.options'].merge!({:email_format => :html})
-      @mail = ExceptionNotifier::Notifier.exception_notification(custom_env, @exception)
+      @mail = @email_notifier.create_email(@exception, {:env => custom_env})
     end
 
     assert @mail.content_type.include? "multipart/alternative"
@@ -151,13 +134,13 @@ end
 class PostsControllerTestWithoutVerboseSubject < ActionController::TestCase
   tests PostsController
   setup do
-    ExceptionNotifier::Notifier.default_verbose_subject = false
+    @email_notifier = ExceptionNotifier::EmailNotifier.new(:verbose_subject => false)
     begin
       @post = posts(:one)
       post :create, :post => @post.attributes
     rescue => e
       @exception = e
-      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception)
+      @mail = @email_notifier.create_email(@exception, {:env => request.env})
     end
   end
 
@@ -169,17 +152,17 @@ end
 class PostsControllerTestWithSmtpSettings < ActionController::TestCase
   tests PostsController
   setup do
-    ExceptionNotifier::Notifier.default_smtp_settings = {
+    @email_notifier = ExceptionNotifier::EmailNotifier.new(:smtp_settings => {
       :user_name => "Dummy user_name",
       :password => "Dummy password"
-    }
-    
+    })
+
     begin
       @post = posts(:one)
       post :create, :post => @post.attributes
     rescue => e
       @exception = e
-      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception)
+      @mail = @email_notifier.create_email(@exception, {:env => request.env})
     end
   end
 
@@ -187,9 +170,9 @@ class PostsControllerTestWithSmtpSettings < ActionController::TestCase
     assert_equal "Dummy user_name", @mail.delivery_method.settings[:user_name]
     assert_equal "Dummy password", @mail.delivery_method.settings[:password]
   end
-  
+
   test "should have overridden smtp settings with background notification" do
-    @mail = ExceptionNotifier::Notifier.background_exception_notification(@exception)
+    @mail = @email_notifier.create_email(@exception)
     assert_equal "Dummy user_name", @mail.delivery_method.settings[:user_name]
     assert_equal "Dummy password", @mail.delivery_method.settings[:password]
   end
@@ -198,6 +181,7 @@ end
 class PostsControllerTestBadRequestData < ActionController::TestCase
   tests PostsController
   setup do
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
     begin
       # This might seem synthetic, but the point is that the data used by
       # ExceptionNotification could be rendered "invalid" by e.g. a badly
@@ -213,7 +197,7 @@ class PostsControllerTestBadRequestData < ActionController::TestCase
       post :create, :post => @post.attributes
     rescue => e
       @exception = e
-      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception)
+      @mail = @email_notifier.create_email(@exception, {:env => request.env})
     end
   end
 
@@ -225,11 +209,12 @@ end
 class PostsControllerTestBackgroundNotification < ActionController::TestCase
   tests PostsController
   setup do
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
     begin
       @post = posts(:one)
       post :create, :post => @post.attributes
     rescue => exception
-      @mail = ExceptionNotifier::Notifier.background_exception_notification(exception)
+      @mail = @email_notifier.create_email(exception)
     end
   end
 

data/test/{campfire_test.rb → exception_notifier/campfire_notifier_test.rb}

@@ -6,8 +6,8 @@ class CampfireNotifierTest < ActiveSupport::TestCase
   test "should send campfire notification if properly configured" do
     ExceptionNotifier::CampfireNotifier.stubs(:new).returns(Object.new)
     campfire = ExceptionNotifier::CampfireNotifier.new({:subdomain => 'test', :token => 'test_token', :room_name => 'test_room'})
-    campfire.stubs(:exception_notification).returns(fake_notification)
-    notif = campfire.exception_notification(fake_exception)
+    campfire.stubs(:call).returns(fake_notification)
+    notif = campfire.call(fake_exception)
 
     assert !notif[:message].empty?
     assert_equal notif[:message][:type], 'PasteMessage'
@@ -22,7 +22,7 @@ class CampfireNotifierTest < ActiveSupport::TestCase
     campfire = ExceptionNotifier::CampfireNotifier.new(wrong_params)
 
     assert_nil campfire.room
-    assert_nil campfire.exception_notification(fake_exception)
+    assert_nil campfire.call(fake_exception)
   end
 
   test "should not send campfire notification if config attr missing" do
@@ -31,7 +31,7 @@ class CampfireNotifierTest < ActiveSupport::TestCase
     campfire = ExceptionNotifier::CampfireNotifier.new(wrong_params)
 
     assert_nil campfire.room
-    assert_nil campfire.exception_notification(fake_exception)
+    assert_nil campfire.call(fake_exception)
   end
 
   private

data/test/exception_notifier/email_notifier_test.rb

@@ -0,0 +1,144 @@
+require 'test_helper'
+
+class EmailNotifierTest < ActiveSupport::TestCase
+  setup do
+    Time.stubs(:current).returns('Sat, 20 Apr 2013 20:58:55 UTC +00:00')
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
+    begin
+      1/0
+    rescue => e
+      @exception = e
+      @mail = @email_notifier.create_email(@exception,
+        :data => {:job => 'DivideWorkerJob', :payload => '1/0', :message => 'My Custom Message'})
+    end
+  end
+
+  test "should have default sender address overridden" do
+    assert @email_notifier.sender_address == %("Dummy Notifier" <dummynotifier@example.com>)
+  end
+
+  test "should have default exception recipients overridden" do
+    assert @email_notifier.exception_recipients == %w(dummyexceptions@example.com)
+  end
+
+  test "should have default email prefix overridden" do
+    assert @email_notifier.email_prefix == "[Dummy ERROR] "
+  end
+
+  test "should have default email headers overridden" do
+    assert @email_notifier.email_headers == { "X-Custom-Header" => "foobar"}
+  end
+
+  test "should have default sections overridden" do
+    for section in %w(new_section request session environment backtrace)
+      assert @email_notifier.sections.include? section
+    end
+  end
+
+  test "should have default background sections" do
+    for section in %w(new_bkg_section backtrace data)
+      assert @email_notifier.background_sections.include? section
+    end
+  end
+
+  test "should have email format by default" do
+    assert @email_notifier.email_format == :text
+  end
+
+  test "should have verbose subject by default" do
+    assert @email_notifier.verbose_subject == true
+  end
+
+  test "should have normalize_subject false by default" do
+    assert @email_notifier.normalize_subject == false
+  end
+
+  test "should have delivery_method nil by default" do
+    assert @email_notifier.delivery_method == nil
+  end
+
+  test "should have mailer_settings nil by default" do
+    assert @email_notifier.mailer_settings == nil
+  end
+
+  test "should have mailer_parent by default" do
+    assert @email_notifier.mailer_parent == 'ActionMailer::Base'
+  end
+
+  test "should have template_path by default" do
+    assert @email_notifier.template_path == 'exception_notifier'
+  end
+
+  test "should normalize multiple digits into one N" do
+    assert_equal 'N foo N bar N baz N',
+      ExceptionNotifier::EmailNotifier.normalize_digits('1 foo 12 bar 123 baz 1234')
+  end
+
+  test "mail should be plain text and UTF-8 enconded by default" do
+    assert @mail.content_type == "text/plain; charset=UTF-8"
+  end
+
+  test "should have raised an exception" do
+    assert_not_nil @exception
+  end
+
+  test "should have generated a notification email" do
+    assert_not_nil @mail
+  end
+
+  test "mail should have a from address set" do
+    assert @mail.from == ["dummynotifier@example.com"]
+  end
+
+  test "mail should have a to address set" do
+    assert @mail.to == ["dummyexceptions@example.com"]
+  end
+
+  test "mail should have a descriptive subject" do
+    assert @mail.subject == "[Dummy ERROR]  (ZeroDivisionError) \"divided by 0\""
+  end
+
+  test "mail should say exception was raised in background at show timestamp" do
+    assert @mail.encoded.include? "A ZeroDivisionError occurred in background at #{Time.current}"
+  end
+
+  test "mail should prefix exception class with 'an' instead of 'a' when it starts with a vowel" do
+    begin
+      raise ActiveRecord::RecordNotFound
+    rescue => e
+      @vowel_exception = e
+      @vowel_mail = @email_notifier.create_email(@vowel_exception)
+    end
+
+    assert @vowel_mail.encoded.include? "An ActiveRecord::RecordNotFound occurred in background at #{Time.current}"
+  end
+
+  test "mail should contain backtrace in body" do
+    assert @mail.encoded.include?("test/exception_notifier/email_notifier_test.rb:8"), "\n#{@mail.inspect}"
+  end
+
+  test "mail should contain data in body" do
+    assert @mail.encoded.include? '* data:'
+    assert @mail.encoded.include? ':payload=>"1/0"'
+    assert @mail.encoded.include? ':job=>"DivideWorkerJob"'
+    assert @mail.encoded.include? "My Custom Message"
+  end
+
+  test "mail should not contain any attachments" do
+    assert @mail.attachments == []
+  end
+
+  test "should not send notification if one of ignored exceptions" do
+    begin
+      raise ActiveRecord::RecordNotFound
+    rescue => e
+      @ignored_exception = e
+      unless ExceptionNotifier.ignored_exceptions.include?(@ignored_exception.class.name)
+        @ignored_mail = @email_notifier.create_email(@ignored_exception)
+      end
+    end
+
+    assert @ignored_exception.class.inspect == "ActiveRecord::RecordNotFound"
+    assert_nil @ignored_mail
+  end
+end

data/test/exception_notifier/webhook_notifier_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+require 'httparty'
+
+class WebhookNotifierTest < ActiveSupport::TestCase
+
+  test "should send webhook notification if properly configured" do
+    ExceptionNotifier::WebhookNotifier.stubs(:new).returns(Object.new)
+    webhook = ExceptionNotifier::WebhookNotifier.new({:url => 'http://localhost:8000'})
+    webhook.stubs(:call).returns(fake_response)
+    response = webhook.call(fake_exception)
+
+    assert_not_nil response
+    assert_equal response[:status], 200
+    assert_equal response[:body][:exception][:error_class], "ZeroDivisionError"
+    assert response[:body][:exception][:message].include? "divided by 0"
+    assert response[:body][:exception][:backtrace].include? "/exception_notification/test/webhook_notifier_test.rb:48"
+  end
+
+  private
+
+  def fake_response
+    {
+      :status => 200,
+      :body => {
+        :exception => {
+          :error_class => 'ZeroDivisionError',
+          :message => 'divided by 0',
+          :backtrace => '/exception_notification/test/webhook_notifier_test.rb:48:in `/'
+        }
+      }
+    }
+  end
+
+  def fake_exception
+    exception = begin
+      5/0
+    rescue Exception => e
+      e
+    end
+  end
+end

data/test/exception_notifier_test.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+class ExceptionNotifierTest < ActiveSupport::TestCase
+  test "should have default ignored exceptions" do
+    assert ExceptionNotifier.ignored_exceptions == ['ActiveRecord::RecordNotFound', 'AbstractController::ActionNotFound', 'ActionController::RoutingError']
+  end
+
+  test "should have email notifier registered" do
+    assert ExceptionNotifier.notifiers == [:email]
+  end
+
+  test "should have a valid email notifier" do
+    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
+    assert_not_nil @email_notifier
+    assert @email_notifier.class == ExceptionNotifier::EmailNotifier
+    assert @email_notifier.respond_to?(:call)
+  end
+
+  test "should allow register/unregister another notifier" do
+    called = false
+    proc_notifier = lambda { |exception, options| called = true }
+    ExceptionNotifier.register_exception_notifier(:proc, proc_notifier)
+
+    assert ExceptionNotifier.notifiers.sort == [:email, :proc]
+
+    exception = StandardError.new
+    ExceptionNotifier.notify_exception(exception)
+    assert called == true
+
+    ExceptionNotifier.unregister_exception_notifier(:proc)
+    assert ExceptionNotifier.notifiers == [:email]
+  end
+
+  test "should allow select notifiers to send error to" do
+    notifier1_calls = 0
+    notifier1 = lambda { |exception, options| notifier1_calls += 1 }
+    ExceptionNotifier.register_exception_notifier(:notifier1, notifier1)
+
+    notifier2_calls = 0
+    notifier2 = lambda { |exception, options| notifier2_calls += 1 }
+    ExceptionNotifier.register_exception_notifier(:notifier2, notifier2)
+
+    assert ExceptionNotifier.notifiers.sort == [:email, :notifier1, :notifier2]
+
+    exception = StandardError.new
+    ExceptionNotifier.notify_exception(exception)
+    assert notifier1_calls == 1
+    assert notifier2_calls == 1
+
+    ExceptionNotifier.notify_exception(exception, {:notifiers => :notifier1})
+    assert notifier1_calls == 2
+    assert notifier2_calls == 1
+
+    ExceptionNotifier.notify_exception(exception, {:notifiers => :notifier2})
+    assert notifier1_calls == 2
+    assert notifier2_calls == 2
+
+    ExceptionNotifier.unregister_exception_notifier(:notifier1)
+    ExceptionNotifier.unregister_exception_notifier(:notifier2)
+    assert ExceptionNotifier.notifiers == [:email]
+  end
+
+  test "should ignore exception if satisfies conditional ignore" do
+    env = "production"
+    ExceptionNotifier.ignore_if do |exception, options|
+      env != "production"
+    end
+
+    notifier_calls = 0
+    test_notifier = lambda { |exception, options| notifier_calls += 1 }
+    ExceptionNotifier.register_exception_notifier(:test, test_notifier)
+
+    exception = StandardError.new
+
+    ExceptionNotifier.notify_exception(exception, {:notifiers => :test})
+    assert notifier_calls == 1
+
+    env = "development"
+    ExceptionNotifier.notify_exception(exception, {:notifiers => :test})
+    assert notifier_calls == 1
+
+    ExceptionNotifier.clear_ignore_conditions!
+    ExceptionNotifier.unregister_exception_notifier(:test)
+  end
+
+  test "should not send notification if one of ignored exceptions" do
+    notifier_calls = 0
+    test_notifier = lambda { |exception, options| notifier_calls += 1 }
+    ExceptionNotifier.register_exception_notifier(:test, test_notifier)
+
+    exception = StandardError.new
+
+    ExceptionNotifier.notify_exception(exception, {:notifiers => :test})
+    assert notifier_calls == 1
+
+    ExceptionNotifier.notify_exception(exception, {:notifiers => :test, :ignore_exceptions => 'StandardError' })
+    assert notifier_calls == 1
+
+    ExceptionNotifier.unregister_exception_notifier(:test)
+  end
+end