opbeat 0.9.1 → 0.9.2

data/spec/opbeat/configuration_spec.rb

@@ -0,0 +1,50 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+
+describe Opbeat::Configuration do
+  before do
+    # Make sure we reset the env in case something leaks in
+    ENV.delete('OPBEAT_ORGANIZATION_ID')
+    ENV.delete('OPBEAT_APP_ID')
+    ENV.delete('OPBEAT_SECRET_TOKEN')
+  end
+
+  shared_examples 'a complete configuration' do
+    it 'should have a server' do
+      expect(subject[:server]).to eq('http://opbeat.localdomain/opbeat')
+    end
+
+    it 'should have an secret token' do
+      expect(subject[:secret_token]).to eq('67890')
+    end
+
+    it 'should have an organization ID' do
+      expect(subject[:organization_id]).to eq('42')
+    end
+
+    it 'should have an app ID' do
+      expect(subject[:app_id]).to eq('43')
+    end
+  end
+
+  context 'being initialized with options' do
+    before do
+      subject.server = 'http://opbeat.localdomain/opbeat'
+      subject.secret_token = '67890'
+      subject.organization_id = '42'
+      subject.app_id = '43'
+    end
+    it_should_behave_like 'a complete configuration'
+  end
+
+  context 'being initialized with an environment variable' do
+    subject do
+      ENV['OPBEAT_ORGANIZATION_ID'] = '42'
+      ENV['OPBEAT_APP_ID'] = '43'
+      ENV['OPBEAT_SECRET_TOKEN'] = '67890'
+      ENV['OPBEAT_SERVER'] = 'http://opbeat.localdomain/opbeat'
+      Opbeat::Configuration.new
+    end
+    it_should_behave_like 'a complete configuration'
+  end
+end

data/spec/opbeat/event_spec.rb

@@ -0,0 +1,130 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+
+describe Opbeat::Event do
+  describe '.capture_message' do
+    let(:message) { 'This is a message' }
+    let(:hash) { Opbeat::Event.capture_message(message).to_hash }
+
+    context 'for a Message' do
+      it 'returns an event' do
+        expect(Opbeat::Event.capture_message(message)).to be_a(Opbeat::Event)
+      end
+
+      it "sets the message to the value passed" do
+        expect(hash['message']).to eq(message)
+      end
+
+      it 'has level ERROR' do
+        expect(hash['level']).to eq('error')
+      end
+    end
+  end
+
+  describe '.capture_exception' do
+    let(:message) { 'This is a message' }
+    let(:exception) { Exception.new(message) }
+    let(:hash) { Opbeat::Event.capture_exception(exception).to_hash }
+
+    context 'for an Exception' do
+      it 'returns an event' do
+        expect(Opbeat::Event.capture_exception(exception)).to be_a(Opbeat::Event)
+      end
+
+      it "sets the message to the exception's message and type" do
+        expect(hash['message']).to eq("Exception: #{message}")
+      end
+
+      it 'has level ERROR' do
+        expect(hash['level']).to eq('error')
+      end
+
+      it 'uses the exception class name as the exception type' do
+        expect(hash['exception']['type']).to eq('Exception')
+      end
+
+      it 'uses the exception message as the exception value' do
+        expect(hash['exception']['value']).to eq(message)
+      end
+
+      it 'does not belong to a module' do
+        expect(hash['exception']['module']).to eq('')
+      end
+    end
+
+    context 'for a nested exception type' do
+      module Opbeat::Test
+        class Exception < Exception; end
+      end
+      let(:exception) { Opbeat::Test::Exception.new(message) }
+
+      it 'sends the module name as part of the exception info' do
+        expect(hash['exception']['module']).to eq('Opbeat::Test')
+      end
+    end
+
+    context 'for a Opbeat::Error' do
+      let(:exception) { Opbeat::Error.new }
+      it 'does not create an event' do
+        expect(Opbeat::Event.capture_exception(exception)).to be_nil
+      end
+    end
+
+    context 'when the exception has a backtrace' do
+      let(:exception) do
+        e = Exception.new(message)
+        allow(e).to receive(:backtrace).and_return([
+          "/path/to/some/file:22:in `function_name'",
+          "/some/other/path:1412:in `other_function'",
+        ])
+        e
+      end
+
+      it 'parses the backtrace' do
+        expect(hash['stacktrace']['frames'].length).to eq(2)
+        expect(hash['stacktrace']['frames'][0]['lineno']).to eq(1412)
+        expect(hash['stacktrace']['frames'][0]['function']).to eq('other_function')
+        expect(hash['stacktrace']['frames'][0]['filename']).to eq('/some/other/path')
+
+        expect(hash['stacktrace']['frames'][1]['lineno']).to eq(22)
+        expect(hash['stacktrace']['frames'][1]['function']).to eq('function_name')
+        expect(hash['stacktrace']['frames'][1]['filename']).to eq('/path/to/some/file')
+      end
+
+      it "sets the culprit" do
+        expect(hash['culprit']).to eq("/some/other/path in other_function")
+      end
+
+      context 'when a path in the stack trace is on the laod path' do
+        before do
+          $LOAD_PATH << '/some'
+        end
+
+        after do
+          $LOAD_PATH.delete('/some')
+        end
+
+        it 'strips prefixes in the load path from frame filenames' do
+          expect(hash['stacktrace']['frames'][0]['filename']).to eq('other/path')
+        end
+      end
+    end
+
+    context 'when there is user context' do
+      it 'sends the context and is_authenticated' do
+        Opbeat::Event.set_context(:user => {:id => 99})
+        hash = Opbeat::Event.capture_exception(exception).to_hash        
+        expect(hash['user']).to eq({:id => 99, :is_authenticated => true})
+      end
+    end
+
+    context 'when there is extra context' do
+      it 'sends the context and is_authenticated' do
+        extra_context = {:jobid => 99}
+        Opbeat::Event.set_context(:extra => extra_context)
+        hash = Opbeat::Event.capture_exception(exception).to_hash        
+        expect(hash['extra']).to eq(extra_context)
+      end
+    end
+  end
+end

data/spec/opbeat/integrations/delayed_job_spec.rb

@@ -0,0 +1,38 @@
+require File::expand_path('../../../spec_helper', __FILE__)
+require 'time'
+require 'delayed_job'
+require 'opbeat/integrations/delayed_job'
+
+# turtles, all the way down
+# trying too hard
+require 'active_support/core_ext/time/calculations.rb'
+load File.join(
+  Gem::Specification.find_by_name("delayed_job").gem_dir,
+  "spec", "delayed", "backend", "test.rb"
+)
+
+
+class Bomb
+  def blow_up ex
+    raise ex
+  end
+end
+
+
+Delayed::Worker.backend = Delayed::Backend::Test::Job
+
+describe Delayed::Plugins::Opbeat do
+  it 'should call Opbeat::captureException on erronous jobs' do
+    test_exception = Exception.new("Test exception")
+    expect(Opbeat).to receive(:captureException).with(test_exception)
+
+    # Queue
+    bomb = Bomb.new
+    bomb.delay.blow_up test_exception
+
+    expect {
+      Delayed::Worker.new.work_off.should == [0, 1]
+    }.to raise_error(Exception)
+  end
+end
+

data/spec/opbeat/logger_spec.rb

@@ -0,0 +1,55 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+
+describe Opbeat::Logger do
+  context 'without a backend logger' do
+    before do
+      allow(Opbeat.configuration).to receive(:logger) { nil }
+    end
+
+    it 'should not error' do
+      subject.fatal 'fatalmsg'
+      subject.error 'errormsg'
+      subject.warn 'warnmsg'
+      subject.info 'infomsg'
+      subject.debug 'debugmsg'
+    end
+  end
+
+  context 'with a backend logger' do
+    before do
+      @logger = double('logger')
+      allow(Opbeat.configuration).to receive(:logger) { @logger }
+    end
+
+    it 'should log fatal messages' do
+      expect(@logger).to receive(:fatal).with('** [Opbeat] fatalmsg')
+      subject.fatal 'fatalmsg'
+    end
+
+    it 'should log error messages' do
+      expect(@logger).to receive(:error).with('** [Opbeat] errormsg')
+      subject.error 'errormsg'
+    end
+
+    it 'should log warning messages' do
+      expect(@logger).to receive(:warn).with('** [Opbeat] warnmsg')
+      subject.warn 'warnmsg'
+    end
+
+    it 'should log info messages' do
+      expect(@logger).to receive(:info).with('** [Opbeat] infomsg')
+      subject.info 'infomsg'
+    end
+
+    it 'should log debug messages' do
+      expect(@logger).to receive(:debug).with('** [Opbeat] debugmsg')
+      subject.debug 'debugmsg'
+    end
+
+    it 'should log messages from blocks' do
+      expect(@logger).to receive(:info).with('** [Opbeat] infoblock')
+      subject.info { 'infoblock' }
+    end
+  end
+end

data/spec/opbeat/opbeat_spec.rb

@@ -0,0 +1,39 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+
+describe Opbeat do
+  before do
+    @send = double("send")
+    @event = double("event")
+    allow(Opbeat).to receive(:send) { @send }
+    allow(Opbeat::Event).to receive(:capture_message) { @event }
+    allow(Opbeat::Event).to receive(:capture_exception) { @event }
+  end
+
+  it 'captureMessage should send result of Event.capture_message' do
+    message = "Test message"
+    expect(Opbeat::Event).to receive(:capture_message).with(message, {})
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.captureMessage(message)
+  end
+
+  it 'captureMessage with options should send result of Event.capture_message' do
+    message = "Test message"
+    options = {:extra => {:hello => "world"}}
+    expect(Opbeat::Event).to receive(:capture_message).with(message, options)
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.captureMessage(message, options)
+  end
+
+  it 'captureException should send result of Event.capture_exception' do
+    exception = build_exception()
+
+    expect(Opbeat::Event).to receive(:capture_exception).with(exception, {})
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.captureException(exception)
+  end
+
+end

data/spec/opbeat/rack_spec.rb

@@ -0,0 +1,117 @@
+require File::expand_path('../../spec_helper', __FILE__)
+
+require 'opbeat'
+require 'opbeat/interfaces'
+
+class User
+  attr_accessor :id, :email, :username
+end
+
+
+class TestController
+  def current_user
+    test_user = User.new
+    test_user.id = 99
+    test_user.email = "ron@opbeat.com"
+    test_user.username = "roncohen"
+
+    return test_user
+  end
+
+  def custom_user
+    test_user = User.new
+    test_user.id = 999
+    test_user.email = "custom@opbeat.com"
+    test_user.username = "custom"
+
+    return test_user
+  end
+end
+
+
+
+describe Opbeat::Rack do
+  before do
+    @send = double("send")
+    @event = double("event")
+    allow(Opbeat).to receive(:send) { @send }
+    allow(Opbeat::Event).to receive(:capture_rack_exception) { @event }
+  end
+
+  it 'should capture exceptions' do
+    exception = build_exception()
+    env = {}
+    
+    expect(Opbeat::Event).to receive(:capture_rack_exception).with(exception, env)
+    expect(Opbeat).to receive(:send).with(@event)
+
+    app = lambda do |e|
+      raise exception
+    end
+
+    stack = Opbeat::Rack.new(app)
+    expect(lambda {stack.call(env)}).to raise_error(exception)
+  end
+
+  it 'should capture rack.exception' do
+    exception = build_exception()
+    env = {}
+
+    expect(Opbeat::Event).to receive(:capture_rack_exception).with(exception, env)
+    expect(Opbeat).to receive(:send).with(@event)
+
+    app = lambda do |e|
+      e['rack.exception'] = exception
+      [200, {}, ['okay']]
+    end
+
+    stack = Opbeat::Rack.new(app)
+
+    stack.call(env)
+  end
+end
+
+
+describe Opbeat::Rack do
+  before do
+    @exception = build_exception()
+    @env = {
+      'action_controller.instance' => TestController.new
+    }
+    allow(Opbeat::HttpInterface).to receive(:new) { Opbeat::Interface.new }
+  end
+
+  it 'should extract user info' do
+    expected_user = TestController.new.current_user
+
+    Opbeat::Event.capture_rack_exception(@exception, @env) do |event|
+      user = event.to_hash['user']
+      expect(user[:id]).to eq(expected_user.id)
+      expect(user[:email]).to eq(expected_user.email)
+      expect(user[:username]).to eq(expected_user.username)
+      expect(user[:is_authenticated]).to eq(true)
+    end
+  end
+
+  it 'should handle custom user method' do
+    Opbeat.configuration.user_controller_method = :custom_user
+    expected_user = TestController.new.custom_user
+
+    Opbeat::Event.capture_rack_exception(@exception, @env) do |event|
+      user = event.to_hash['user']
+      expect(user[:id]).to eq(expected_user.id)
+      expect(user[:email]).to eq(expected_user.email)
+      expect(user[:username]).to eq(expected_user.username)
+      expect(user[:is_authenticated]).to eq(true)
+    end
+  end
+
+  it 'should handle missing user method' do
+    Opbeat.configuration.user_controller_method = :missing_user_method
+    expected_user = TestController.new.custom_user
+
+    Opbeat::Event.capture_rack_exception(@exception, @env) do |event|
+      expect(event.user).to eq(nil)
+    end
+  end
+end

data/spec/opbeat/sanitizedata_processor_spec.rb

@@ -0,0 +1,42 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat/processors/sanitizedata'
+
+describe Opbeat::Processor::SanitizeData do
+  before do
+    @client = double("client")
+    @processor = Opbeat::Processor::SanitizeData.new(@client)
+  end
+
+  it 'should filter http data' do
+    data = {
+      'http' => {
+        'data' => {
+          'foo' => 'bar',
+          'password' => 'hello',
+          'the_secret' => 'hello',
+          'a_password_here' => 'hello',
+          'mypasswd' => 'hello',
+        }
+      }
+    }
+
+    result = @processor.process(data)
+
+    vars = result["http"]["data"]
+    expect(vars["foo"]).to eq("bar")
+    expect(vars["password"]).to eq(Opbeat::Processor::SanitizeData::MASK)
+    expect(vars["the_secret"]).to eq(Opbeat::Processor::SanitizeData::MASK)
+    expect(vars["a_password_here"]).to eq(Opbeat::Processor::SanitizeData::MASK)
+    expect(vars["mypasswd"]).to eq(Opbeat::Processor::SanitizeData::MASK)
+  end
+
+  it 'should filter credit card values' do
+    data = {
+      'ccnumba' => '4242424242424242'
+    }
+
+    result = @processor.process(data)
+    expect(result["ccnumba"]).to eq(Opbeat::Processor::SanitizeData::MASK)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+SimpleCov.start
+
+def build_exception()
+  begin
+    1 / 0
+  rescue ZeroDivisionError => exception
+    return exception
+  end
+end