bin/ginger ginger_scenarios.rb @@ -1,4 +1,5 @@ +.ginger .DS_Store coverage doc -pkg/* \ No newline at end of file +pkg/* .gitignore @@ -1,39 +1,42 @@ begin require 'echoe' - + Echoe.new('exceptional', '0.0.6') do |p| p.rubyforge_name = 'exceptional' - p.summary = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)" - p.description = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)" - p.url = "http://getexceptional.com/" - p.author = ["Contrast"] - p.email = "hello@contrast.ie" + p.summary = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)" + p.description = "Exceptional is the core Ruby library for communicating with http://getexceptional.com (hosted error tracking service)" + p.url = "http://getexceptional.com/" + p.author = ["Contrast"] + p.email = "hello@contrast.ie" p.dependencies = ["json"] end - rescue LoadError => e puts "You are missing a dependency required for meta-operations on this gem." puts "#{e.to_s.capitalize}." end - # add spec tasks, if you have rspec installed begin require 'spec/rake/spectask' - Spec::Rake::SpecTask.new("spec") do |t| t.spec_files = FileList['spec/**/*_spec.rb'] t.spec_opts = ['--color'] end - + task :test do Rake::Task['spec'].invoke end - + Spec::Rake::SpecTask.new("coverage") do |t| t.spec_files = FileList['spec/**/*_spec.rb'] t.spec_opts = ['--color'] t.rcov = true t.rcov_opts = ['--exclude', '^spec,/gems/'] end - +end + +desc 'Run specs using ginger' +task :ginger do + ARGV.clear + ARGV << 'spec' + load File.join(*%w[bin ginger]) end \ No newline at end of file Rakefile @@ -31,4 +31,4 @@ Gem::Specification.new do |s| else s.add_dependency(%q<json>, [">= 0"]) end -end +end \ No newline at end of file exceptional.gemspec @@ -9,7 +9,6 @@ require 'exceptional/api' require 'exceptional/bootstrap' module Exceptional - class << self include Exceptional::Config include Exceptional::Api lib/exceptional.rb @@ -1,8 +1,6 @@ require 'json' unless defined? Rails - module Exceptional - module Api # parse an exception into an ExceptionData object def parse(exception) lib/exceptional/api.rb @@ -1,14 +1,11 @@ if defined? ActiveSupport - - # Hack to force Rails version prior to 2.0 to use quoted JSON as per the JSON standard... (TODO: could be cleaner!) + # Hack to force Rails version prior to 2.0 to use quoted JSON as per the JSON standard... if (defined?(ActiveSupport::JSON) && ActiveSupport::JSON.respond_to?(:unquote_hash_key_identifiers)) ActiveSupport::JSON.unquote_hash_key_identifiers = false end - end if defined? ActionController - module ActionController class Base @@ -28,5 +25,4 @@ if defined? ActionController protected :rescue_action end end - end \ No newline at end of file lib/exceptional/integration/rails.rb @@ -1,12 +1,9 @@ require File.dirname(__FILE__) + '/spec_helper' - describe Exceptional::Api do - - describe "with no configuration" do before(:each) do - Exceptional.stub!(:to_stderr) # Don't print error when testing + Exceptional.stub!(:to_stderr) # Don't print error when testing end after(:each) do @@ -23,37 +20,33 @@ describe Exceptional::Api do it "should parse exception into exception data object" do exception = mock(Exception, :message => "Something bad has happened", - :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"]) + :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"]) exception_data = Exceptional.parse(exception) exception_data.kind_of?(Exceptional::ExceptionData).should be_true exception_data.exception_message.should == exception.message exception_data.exception_backtrace.should == exception.backtrace exception_data.exception_class.should == exception.class.to_s - - end it "should post exception" do - exception_data = mock(Exceptional::ExceptionData, - :message => "Something bad has happened", - :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"], - :class => Exception, :to_hash => { :message => "Something bad has happened" }) + :message => "Something bad has happened", + :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"], + :class => Exception, :to_hash => { :message => "Something bad has happened" }) Exceptional.api_key = "TEST_API_KEY" Exceptional.should_receive(:authenticate).once.and_return(true) Exceptional.should_receive(:call_remote, :with => [:errors, exception_data]).once Exceptional.post(exception_data) - end it "should catch exception" do exception = mock(Exception, :message => "Something bad has happened", - :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"]) + :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"]) exception_data = mock(Exceptional::ExceptionData, - :message => "Something bad has happened", - :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"], - :class => Exception, :to_hash => { :message => "Something bad has happened" }) + :message => "Something bad has happened", + :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"], + :class => Exception, :to_hash => { :message => "Something bad has happened" }) exception_data.should_receive(:controller_name=).with(File.basename($0)) Exceptional.should_receive(:parse, :with => [exception]).and_return(exception_data) @@ -64,35 +57,33 @@ describe Exceptional::Api do it "should raise a license exception if api key is not set" do exception_data = mock(Exceptional::ExceptionData, - :message => "Something bad has happened", - :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"], - :class => Exception, - :to_hash => { :message => "Something bad has happened" }) + :message => "Something bad has happened", + :backtrace => ["/app/controllers/buggy_controller.rb:29:in `index'"], + :class => Exception, + :to_hash => { :message => "Something bad has happened" }) Exceptional.api_key.should == nil lambda { Exceptional.post(exception_data) }.should raise_error(Exceptional::Config::ConfigurationException) end end describe "rescue" do - it "should send exception data onto catch" do Exceptional.should_receive(:catch) lambda{ Exceptional.rescue do raise IOError end}.should raise_error(IOError) - end end describe "handle" do before(:each) do - Exceptional.stub!(:to_stderr) # Don't print error when testing - Exceptional.stub!(:log!) # Don't even attempt to log + Exceptional.stub!(:to_stderr) # Don't print error when testing + Exceptional.stub!(:log!) # Don't even attempt to log end it "should send exception data onto post" do exception = mock(Exception, :message => "Something bad has happened", - :backtrace => "/app/controllers/buggy_controller.rb:29:in `index'") + :backtrace => "/app/controllers/buggy_controller.rb:29:in `index'") controller = mock("controller", :controller_name => "Test Controller Name", :action_name => "Test Action Name") @@ -119,20 +110,20 @@ describe Exceptional::Api do end it "safe_environment() should handle array type parameters" do - - request = mock(request, :env => { - 'string_array_var' => ['value', 'another value'], - 'bool_array_var' => [false, false, true], - 'numb_array_var' => [3,2,1], - 'nil_array_var' => [nil, nil], - 'non_ack' => 'value2' } - ) - Exceptional.send(:safe_environment, request).should == { - 'string_array_var' => ['value', 'another value'], - 'bool_array_var' => [false, false, true], - 'numb_array_var' => [3,2,1], - 'nil_array_var' => [nil, nil], - 'non_ack' => 'value2' } + + request = mock(request, :env => { + 'string_array_var' => ['value', 'another value'], + 'bool_array_var' => [false, false, true], + 'numb_array_var' => [3, 2, 1], + 'nil_array_var' => [nil, nil], + 'non_ack' => 'value2' } + ) + Exceptional.send(:safe_environment, request).should == { + 'string_array_var' => ['value', 'another value'], + 'bool_array_var' => [false, false, true], + 'numb_array_var' => [3, 2, 1], + 'nil_array_var' => [nil, nil], + 'non_ack' => 'value2' } end @@ -144,7 +135,6 @@ describe Exceptional::Api do Exceptional.send(:safe_session, mock_session).should == { 'var1' => ['value', 'another value'], 'var2' => 'value2' } end - it "safe_session() should filter all /db/, /cgi/ variables and sub @ for blank" do class SessionHelper def initialize @@ -158,54 +148,35 @@ describe Exceptional::Api do Exceptional.send(:safe_session, session).should == { 'some_var' => 1 } end - it "sanitize_hash() should sanitize cyclic problem for to_json" do - class MyClass - def initialize - @test = self - end + class ClassWithCircularReferenceToHash + def initialize + @test = self + end - def to_hash - { :test => self } - end + def to_hash + { :test => self } end - my_class = MyClass.new - - lambda { my_class.to_json }.should raise_error(ActiveSupport::JSON::CircularReferenceError) - Exceptional.send(:sanitize_hash, my_class.to_hash).to_json.should == "{}" end - + + it "sanitize_hash() should sanitize cyclic problem for to_json" do + circular = ClassWithCircularReferenceToHash.new + + lambda { circular.to_json }.should raise_error + Exceptional.send(:sanitize_hash, circular.to_hash).to_json.should == "{}" + end + it "sanitize_hash() should sanitize cyclic problem for to_json passing hash" do - class MyClass - def initialize - @test = self - end + circular = ClassWithCircularReferenceToHash.new - def to_hash - { :test => self } - end - end - my_class = MyClass.new - - - lambda { my_class.to_json }.should raise_error(ActiveSupport::JSON::CircularReferenceError) - Exceptional.send(:sanitize_hash, {'hkey' => my_class}).to_json.should == "{}" + lambda { circular.to_json }.should raise_error + Exceptional.send(:sanitize_hash, {'hkey' => circular}).to_json.should == "{}" end - + it "sanitize_hash() should sanitize cyclic problem for to_json passing hash mult params" do - class MyClass - def initialize - @test = self - end + circular = ClassWithCircularReferenceToHash.new - def to_hash - { :test => self } - end - end - my_class = MyClass.new - - - lambda { my_class.to_json }.should raise_error(ActiveSupport::JSON::CircularReferenceError) - Exceptional.send(:sanitize_hash, {'hkey' => my_class, 'ruby' => 'tuesday'}).to_json.should == "{\"ruby\": \"tuesday\"}" + lambda { circular.to_json }.should raise_error + Exceptional.send(:sanitize_hash, {'hkey' => circular, 'ruby' => 'tuesday'}).should == {'ruby' => 'tuesday'} end end end spec/api_spec.rb @@ -1,11 +1,7 @@ require File.dirname(__FILE__) + '/spec_helper' - describe Exceptional::Bootstrap do - - describe "setup" do - TEST_ENVIRONMENT= "development" it "should initialize the config and log" do @@ -32,7 +28,6 @@ describe Exceptional::Bootstrap do Exceptional.should_not_receive(:authenticate) STDERR.should_not_receive(:puts) # Will silently not enable itself - Exceptional.bootstrap(TEST_ENVIRONMENT, File.dirname(__FILE__)) end @@ -55,4 +50,4 @@ describe Exceptional::Bootstrap do Exceptional.bootstrap(TEST_ENVIRONMENT, File.dirname(__FILE__)) end end -end +end \ No newline at end of file spec/bootstrap_spec.rb @@ -1,10 +1,7 @@ require File.dirname(__FILE__) + '/spec_helper' - describe Exceptional::Config do - before(:all) do - def Exceptional.reset_state @api_key = nil @ssl_enabled = nil @@ -14,7 +11,6 @@ describe Exceptional::Config do @remote_host = nil @applicaton_root = nil end - end after(:each) do @@ -27,7 +23,6 @@ describe Exceptional::Config do end describe "default configuration" do - it "should use port 80 by default if ssl not enabled" do Exceptional.ssl_enabled?.should be_false Exceptional.remote_port.should == 80 @@ -67,7 +62,6 @@ describe Exceptional::Config do end describe "load config" do - it "error during config file loading raises configuration exception" do File.should_receive(:open).once.and_raise(IOError) spec/config_spec.rb @@ -1,9 +1,7 @@ require File.dirname(__FILE__) + '/spec_helper' describe Exceptional::ExceptionData do - describe "with valid base data" do - before(:each) do @exception_data = Exceptional::ExceptionData.new @exception_data.exception_class = "Error" @@ -28,7 +26,5 @@ describe Exceptional::ExceptionData do it "should convert to json" do @exception_data.to_json.class.should == String end - end - end \ No newline at end of file spec/exception_data_spec.rb @@ -2,40 +2,38 @@ require File.dirname(__FILE__) + '/spec_helper' require 'action_controller' require File.join(File.dirname(__FILE__), '..', 'lib', 'exceptional', 'integration', 'rails') -class MyException < Exception; end -class SpecialException < Exception; end -class RescueFromController < ActionController::Base - rescue_from MyException, :with => :my_handler - - def my_handler - return 'test' - end - - def my_action - raise MyException - end - -end +if ActionController::Base.respond_to?(:rescue_from) + # pre 2.0 versions of rails don't have rescue_from so there's no contention + class MyException < Exception;end + class SpecialException < Exception;end + + class RescueFromController < ActionController::Base + rescue_from MyException, :with => :my_handler -describe "Exceptional with rescue_from() support" do - before(:each) do - @controller = RescueFromController.new + def my_handler + true + end end - it "should not call Exceptional" do - @controller.should_receive(:rescue_action_without_exceptional).and_return(true) - if Gem::Requirement.create(">=2.2.0").satisfied_by?(Gem.loaded_specs['rails'].version) - Exceptional.should_not_receive(:handle) - else + describe "Exceptional with rescue_from() support" do + before(:each) do + @controller = RescueFromController.new + end + + it "should not call Exceptional" do + @controller.should_receive(:rescue_action_without_exceptional).and_return(true) + if Gem::Requirement.create(">=2.2.0").satisfied_by?(Gem.loaded_specs['rails'].version) + Exceptional.should_not_receive(:handle) + else + Exceptional.should_receive(:handle) + end + @controller.send(:rescue_action, MyException.new("test")).should == true + end + + it "should call Exceptional" do Exceptional.should_receive(:handle) + @controller.should_receive(:rescue_action_without_exceptional).and_return(true) + @controller.send(:rescue_action, SpecialException.new("test")).should == true end - @controller.send(:rescue_action, MyException.new("test")).should == true - end - - it "should call Exceptional" do - Exceptional.should_receive(:handle) - @controller.should_receive(:rescue_action_without_exceptional).and_return(true) - @controller.send(:rescue_action, SpecialException.new("test")).should == true end - end \ No newline at end of file spec/exceptional_rescue_from_spec.rb @@ -1,8 +1,6 @@ require File.dirname(__FILE__) + '/spec_helper' - describe Exceptional do - describe "with no configuration" do before(:each) do Exceptional.stub!(:to_stderr) # Don't print error when testing @@ -21,5 +19,4 @@ describe Exceptional do lambda { Exceptional.post_exception(exception_data) }.should raise_error(Exceptional::Config::ConfigurationException) end end - end \ No newline at end of file spec/exceptional_spec.rb @@ -5,14 +5,12 @@ describe Exceptional::Log do TEST_LOG_MESSAGE = "Test-log-message" it "uninitialized should only log to STDERR" do - STDERR.should_receive(:puts) Logger.should_not_receive(:send) Exceptional.log! TEST_LOG_MESSAGE end it "initialized should log to both STDERR and log file" do - mock_log = mock("log") mock_log.should_receive(:level=) spec/log_spec.rb @@ -27,7 +27,6 @@ describe Exceptional::Remote do end describe "authentication" do - it "should not be authenticated if API authentication unsuccessful" do Exceptional.api_key = TEST_API_KEY @@ -69,9 +68,7 @@ describe Exceptional::Remote do end describe "sending data " do - it "should return response body if successful" do - OK_RESPONSE_BODY = "OK-RESP-BODY" Exceptional.api_key = TEST_API_KEY @@ -92,7 +89,6 @@ describe Exceptional::Remote do end it "should raise error if network problem during sending exception" do - Exceptional.api_key = TEST_API_KEY Exceptional.authenticated?.should be_false @@ -112,7 +108,6 @@ describe Exceptional::Remote do end it "should raise Exception if sending exception unsuccessful" do - Exceptional.api_key = TEST_API_KEY Exceptional.authenticated?.should be_false spec/remote_spec.rb @@ -1,13 +1,7 @@ -require 'rubygems' - -if ENV['RAILS_VER'] - gem 'rails', "=#{ENV['RAILS_VER']}" -else - gem 'rails' +begin + require 'ginger' +rescue LoadError end - -# TODO couple of different ways to test parts of exceptional with Rails (or a mock), reconcile them. -#require 'active_support' -# module Rails; end # Rails faker - +require 'rubygems' +gem 'rails' require File.dirname(__FILE__) + '/../lib/exceptional' spec/spec_helper.rb fc75a8b99a5dce282f67905d7d2e2f18a21fec8a Darragh Curran darragh@peelmeagrape.net http://github.com/contrast/exceptional/commit/ef18104da63d174505208d94964ea0581fcb6b3d ef18104da63d174505208d94964ea0581fcb6b3d 2009-09-23T07:52:50-07:00 2009-09-23T07:52:50-07:00 Run specs against different versions of rails using ginger (http://github.com/freelancing-god/ginger) 0f45eab2c75e6754c0dd2f93e8b110ec91c54aca Darragh Curran darragh@peelmeagrape.net