error_stalker 0.0.12

data/lib/error_stalker/version.rb

@@ -0,0 +1,4 @@
+module ErrorStalker
+  # ErrorStalker's current version.
+  VERSION = "0.0.12"
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'error_stalker'
+require 'mail'
+require 'error_stalker/server'
+
+Mail.defaults do
+  delivery_method :test
+end

data/test/unit/backend/base_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class BackendBaseTest < Test::Unit::TestCase
+  def test_report_is_not_implemented
+    assert_raises NotImplementedError do
+      ErrorStalker::Backend::Base.new.report("foo")
+    end
+  end
+end

data/test/unit/backend/in_memory_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require 'error_stalker/backend/in_memory'
+
+class BackendInMemoryTest < Test::Unit::TestCase
+
+  def setup
+    super
+    @backend = ErrorStalker::Backend::InMemory.new
+    @exception_report = ErrorStalker::ExceptionReport.new(:application => :unit_test, :exception => 'Test Exception')
+  end
+  
+  def test_report_is_implemented
+    @backend.report(@exception_report)
+    assert_equal 1, @backend.exceptions.length
+  end
+
+  def test_clear_is_implemented
+    @backend.report(@exception_report)
+    @backend.clear
+    assert_equal 0, @backend.exceptions.length
+  end
+end

data/test/unit/backend/log_file_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+require 'error_stalker/backend/log_file'
+require 'tempfile'
+
+class BackendLogFileTest < Test::Unit::TestCase
+
+  def setup
+    super
+    filename = File.join(Dir.tmpdir, 'exceptions.log')
+    @backend = ErrorStalker::Backend::LogFile.new(filename)
+    @exception_report = ErrorStalker::ExceptionReport.new(:application => :unit_test, :exception => 'Test Exception', :data => {:name => 'Bob'})
+  end
+
+  def teardown
+    File.delete(@backend.filename) if File.exists?(@backend.filename)
+    super
+  end
+  
+  def test_report_is_implemented
+    @backend.report(@exception_report)
+    exception_string = File.read(@backend.filename)
+    assert_match /Application: unit_test/, exception_string
+    assert_match /Exception: Test Exception/, exception_string
+  end
+end

data/test/unit/client_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require 'error_stalker/backend/in_memory'
+
+class ClientTest < Test::Unit::TestCase
+
+  def setup
+    super
+    @backend = ErrorStalker::Backend::InMemory.new
+    ErrorStalker::Client.backend = @backend
+  end
+  
+  def test_report
+    ErrorStalker::Client.report(:unit_test, new_exception, {:name => "Bob"})
+
+    assert_equal 1, @backend.exceptions.length
+    exception_report = @backend.exceptions.first
+    assert_equal :unit_test, exception_report.application
+    assert_equal exception_report.send(:machine_name), exception_report.machine
+    assert_match "test/unit/client_test.rb:", exception_report.backtrace.first
+    assert_equal 'Bob', exception_report.data[:name]
+    assert_equal 'NoMethodError', exception_report.type
+  end
+
+  def test_report_exceptions_in_block
+    assert_raises NoMethodError do 
+      ErrorStalker::Client.report_exceptions(:unit_test) do
+        raise new_exception
+      end
+
+      assert_equal 1, @backend.exceptions.length
+    end
+  end
+
+  def test_report_exceptions_in_block_without_reraise
+    assert_nothing_raised do
+      ErrorStalker::Client.report_exceptions(:unit_test, :reraise => false) do
+        raise new_exception
+      end
+
+      assert_equal 1, @backend.exceptions.length
+
+      ErrorStalker::Client.report_exceptions(:unit_test, :reraise => nil) do
+        raise new_exception
+      end
+
+      assert_equal 2, @backend.exceptions.length
+    end
+  end
+
+  def test_dont_raise_exceptions_during_report
+    ErrorStalker::Client.backend = nil
+    
+    assert_nothing_raised do
+      ErrorStalker::Client.report(:unit_test, new_exception, {:name => "Bob"})
+    end
+  end
+
+  def new_exception
+    exception = nil
+    begin
+      nil.foo
+    rescue => e
+      exception = e
+    end
+    exception
+  end
+end

data/test/unit/exception_report_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class ExceptionReportTest < Test::Unit::TestCase
+
+  def test_serialization
+    original_report = ErrorStalker::ExceptionReport.new(:application => :unit_test, :exception => NoMethodError.new, :data => {:name => "Bob"})
+
+    exception_report = ErrorStalker::ExceptionReport.new(JSON.parse(original_report.to_json))
+    
+    assert_equal 'unit_test', exception_report.application
+    assert_equal exception_report.send(:machine_name), exception_report.machine
+    assert_equal 'Bob', exception_report.data['name']
+    assert_equal 'NoMethodError', exception_report.type
+  end
+
+  def test_digest
+    report = ErrorStalker::ExceptionReport.new(:application => :unit_test, :exception => "Bob", :data => {:name => "Bob"})
+    report2 = ErrorStalker::ExceptionReport.new(:application => :unit_test, :exception => "Bob", :data => {:name => "Bob"})
+    report3 = ErrorStalker::ExceptionReport.new(:application => :unit_test, :exception => "Fred", :data => {:name => "Bob"})
+
+    assert_equal report.digest, report2.digest
+    assert_not_equal report.digest, report3.digest
+  end
+end

data/test/unit/plugins/email_sender_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class EmailSenderTest < Test::Unit::TestCase
+
+  def test_email_configuration_with_strings
+    p = ErrorStalker::Plugin::EmailSender.new(nil, {'to' => nil, 'from' => nil, 'delivery_method' => 'sendmail'})
+    e = ErrorStalker::ExceptionReport.new(:exception => 'test', :application => 'test', :data => {})
+    mail = p.build_email(e, nil)
+    assert_equal Mail::Sendmail, mail.delivery_method.class
+  end
+end
+

data/test/unit/server_test.rb

@@ -0,0 +1,141 @@
+require 'test_helper'
+require 'rack/test'
+require 'error_stalker/server'
+require 'mocha'
+
+ENV['RACK_ENV'] = 'test'
+
+class ServerTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    ErrorStalker::Server
+  end
+
+  def setup
+    @store = ErrorStalker::Store::InMemory.new
+    ErrorStalker::Server.any_instance.stubs(:store).returns(@store)
+  end
+
+  def test_report_exception
+    report_exception
+    assert last_response.ok?
+    assert_equal 1, @store.exceptions.length
+  end
+
+  def test_can_see_homepage
+    get '/'
+    assert last_response.ok?
+    assert_no_match /table/, last_response.body
+  end
+
+  def test_can_see_homepage_table_after_exception_logged
+    report_exception
+    get '/'
+    assert last_response.ok?
+    assert_match /table/, last_response.body
+    assert_match /failed/, last_response.body
+  end
+
+  def test_groups_aggregated_on_homepage
+    report_exception
+    report_exception('test2', 2)
+    get '/'
+    assert last_response.ok?
+    assert_match /<td class="count">2/, last_response.body
+  end
+
+  def test_find_exception
+    report_exception
+    get '/exceptions/0.html'
+    assert last_response.ok?
+    assert_match /failed/, last_response.body
+    assert_match /server_test.rb/, last_response.body
+  end
+
+  def test_find_related
+    e = report_exception('test', 4)
+    report_exception('test2', 1)
+    get "/similar/#{e.digest}.html"
+    assert last_response.ok?
+    assert_match /exceptions\/0.html/, last_response.body
+    assert_no_match /exceptions\/4.html/, last_response.body
+  end
+
+  def test_emails_sent_only_on_first_report_in_group
+    app.any_instance.stubs(:plugins).returns([ErrorStalker::Plugin::EmailSender.new(nil, {'to' => nil, 'from' => nil})])
+    report_exception('test', 2)
+    assert_equal 1, Mail::TestMailer.deliveries.length
+    report_exception('test', 1)
+    assert_equal 2, Mail::TestMailer.deliveries.length
+  end
+  
+  def test_stats_renders_total
+    report_exception('test', 4)
+    get "/stats.json"
+    assert last_response.ok?
+    stats = JSON.parse(last_response.body)
+    assert_equal 4, stats['total']
+  end
+  
+  def test_stats_renders_timestamp
+    report_exception('test', 1)
+    timestamp = Time.now.to_i - 60 # one minute ago
+    get "/stats.json", :timestamp => timestamp
+    assert last_response.ok?
+    stats = JSON.parse(last_response.body)
+    assert_equal timestamp, stats['timestamp']
+  end
+
+  def test_stats_renders_total_since
+    report_exception('test', 1)
+    timestamp = Time.now.to_i - 60 # one minute ago
+    get "/stats.json", :timestamp => timestamp
+    assert last_response.ok?
+    stats = JSON.parse(last_response.body)
+    assert_equal 1, stats['total_since']
+  end
+
+  def test_advanced_search_shows_up
+    get "/search"
+    assert last_response.ok?
+    assert_no_match /<label for="data">/, last_response.body
+
+    @store.stubs(:supports_extended_searches?).returns(true)
+    get "/search"
+    assert last_response.ok?
+    assert_match /<label for="data">/, last_response.body
+  end
+
+  def test_perform_search
+    report_exception('test', 4)
+    report_exception('te-t')
+    get "/search?application=&machine=&exception=test&Search=Search"
+    assert_match /exceptions\/0.html/, last_response.body
+    assert_no_match /exceptions\/4.html/, last_response.body
+
+    get "/search?application=&machine=&exception=te&Search=Search"
+    assert_match /exceptions\/0.html/, last_response.body
+    assert_match /exceptions\/4.html/, last_response.body
+
+    get "/search?application=foo&machine=&exception=te&Search=Search"
+    assert_no_match /exceptions\/0.html/, last_response.body
+    assert_no_match /exceptions\/4.html/, last_response.body
+  end
+
+  protected
+  def report_exception(message = "failed", count = 1, data = {})
+    e = nil
+    count.times do 
+      begin
+        raise NoMethodError, message
+      rescue => ex
+        e = ErrorStalker::ExceptionReport.new(:exception => ex, :application => 'test', :data => data)
+      end
+      
+      post '/report.json', e.to_json
+    end
+    e
+  end
+end
+

data/test/unit/stores/in_memory_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class InMemoryTest < Test::Unit::TestCase
+  def setup
+    @store = ErrorStalker::Store::InMemory.new
+  end
+  
+  def test_store_exception
+    assert @store.empty?
+    store_exception(@store)
+    assert !@store.empty?
+    assert_equal 1, @store.recent.length
+    assert @store.find(0)
+  end
+
+  def test_group
+    store_exception(@store, "test", 2)
+    store_exception(@store, "test2")
+
+    assert_equal 2, @store.recent.length
+    assert_equal 1, @store.reports_in_group(@store.find(2).digest).length
+    assert_equal 1, @store.group(@store.find(2).digest).count
+    assert_equal 2, @store.reports_in_group(@store.find(0).digest).length
+    assert_equal 2, @store.group(@store.find(0).digest).count
+  end
+
+  def test_search
+    store_exception(@store, "test", 2)
+    store_exception(@store, "text")
+    assert_equal 3, @store.search(:application => 'test').length
+    assert_equal 0, @store.search(:application => 'foo').length
+    assert_equal 3, @store.search(:machine => `hostname`.chomp, :application => 'test').length
+    assert_equal 0, @store.search(:machine => 'example.com', :application => 'test').length
+    assert_equal 1, @store.search(:application => 'test', :exception => 'tex').length
+    assert_equal 3, @store.search(:application => 'test', :exception => 'te').length
+  end
+
+  def test_machines_and_applications
+    store_exception(@store, "test", 2)
+    assert_equal 1, @store.machines.length
+    assert_equal 1, @store.applications.length
+    assert_equal 'test', @store.applications.first
+  end
+  
+  protected
+  def store_exception(store, message = "failed", count = 1, data = {})
+    e = nil
+    count.times do 
+      begin
+        raise NoMethodError, message
+      rescue => ex
+        e = ErrorStalker::ExceptionReport.new(:exception => ex, :application => 'test', :data => data)
+      end
+      @store.store(e)
+    end
+    e
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: error_stalker
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+  prerelease: 
+platform: ruby
+authors:
+- Justin Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-10 00:00:00.000000000 -07:00
+default_executable: 
+dependencies: []
+description: Logs exceptions to a pluggable backend. Also provides a server for centralized
+  exception logging using a pluggable data store.
+email:
+- jweiss@avvo.com
+executables:
+- create_indexes
+- error_stalker_server
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- bin/create_indexes
+- bin/error_stalker_server
+- error_stalker.gemspec
+- lib/error_stalker.rb
+- lib/error_stalker/backend.rb
+- lib/error_stalker/backend/base.rb
+- lib/error_stalker/backend/in_memory.rb
+- lib/error_stalker/backend/log_file.rb
+- lib/error_stalker/backend/server.rb
+- lib/error_stalker/client.rb
+- lib/error_stalker/exception_group.rb
+- lib/error_stalker/exception_report.rb
+- lib/error_stalker/plugin.rb
+- lib/error_stalker/plugin/base.rb
+- lib/error_stalker/plugin/email_sender.rb
+- lib/error_stalker/plugin/lighthouse_reporter.rb
+- lib/error_stalker/plugin/views/exception_email.erb
+- lib/error_stalker/plugin/views/report.erb
+- lib/error_stalker/server.rb
+- lib/error_stalker/server/public/exception_logger.css
+- lib/error_stalker/server/public/grid.css
+- lib/error_stalker/server/public/images/background.png
+- lib/error_stalker/server/public/jquery-1.4.4.min.js
+- lib/error_stalker/server/views/_exception_message.erb
+- lib/error_stalker/server/views/_exception_table.erb
+- lib/error_stalker/server/views/index.erb
+- lib/error_stalker/server/views/layout.erb
+- lib/error_stalker/server/views/search.erb
+- lib/error_stalker/server/views/show.erb
+- lib/error_stalker/server/views/similar.erb
+- lib/error_stalker/sinatra_link_renderer.rb
+- lib/error_stalker/store.rb
+- lib/error_stalker/store/base.rb
+- lib/error_stalker/store/in_memory.rb
+- lib/error_stalker/store/mongoid.rb
+- lib/error_stalker/version.rb
+- test/test_helper.rb
+- test/unit/backend/base_test.rb
+- test/unit/backend/in_memory_test.rb
+- test/unit/backend/log_file_test.rb
+- test/unit/client_test.rb
+- test/unit/exception_report_test.rb
+- test/unit/plugins/email_sender_test.rb
+- test/unit/server_test.rb
+- test/unit/stores/in_memory_test.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: error_stalker
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Logs exceptions to a pluggable backend and/or a pluggable store
+test_files:
+- test/test_helper.rb
+- test/unit/backend/base_test.rb
+- test/unit/backend/in_memory_test.rb
+- test/unit/backend/log_file_test.rb
+- test/unit/client_test.rb
+- test/unit/exception_report_test.rb
+- test/unit/plugins/email_sender_test.rb
+- test/unit/server_test.rb
+- test/unit/stores/in_memory_test.rb