kuende-opbeat 2.0.1

data/spec/opbeat/client_spec.rb

@@ -0,0 +1,35 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+require 'faraday'
+
+http = Faraday.new do |builder|
+  builder.adapter :test do |stub|
+    stub.get('/') { |env| [ 200, {}, 'foo' ]}
+  end
+end
+
+describe Opbeat::Client do
+  before do
+    @configuration = Opbeat::Configuration.new
+    @configuration.environments = ["test"]
+    @configuration.current_environment = :test
+    @configuration.secret_token = 'test'
+    @configuration.organization_id = 'test'
+    @configuration.app_id = 'test'
+    @client = Opbeat::Client.new(@configuration)
+    allow(@client).to receive(:send)
+  end
+
+  it 'send_release should send' do
+    message = "Test message"
+    expect(@client).to receive(:send).with("/releases/", message)
+    @client.send_release(message)
+  end
+
+  it 'send_message should send' do
+    event = Opbeat::Event.new :message => "my message"
+    req = http.get '/'
+    expect(@client).to receive(:send).with("/errors/", event).and_return(req)
+    @client.send_event(event)
+  end
+end

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,138 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+
+describe Opbeat::Event do
+  describe '.from_message' do
+    let(:message) { 'This is a message' }
+    let(:hash) { Opbeat::Event.from_message(message, caller).to_hash }
+
+    context 'for a Message' do
+      it 'returns an event' do
+        expect(Opbeat::Event.from_message(message, caller)).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 '.from_exception' do
+    let(:message) { 'This is a message' }
+    let(:exception) {
+      exc = Exception.new(message)
+      exc.set_backtrace caller
+      exc
+    }
+    let(:hash) { Opbeat::Event.from_exception(exception).to_hash }
+
+    context 'for an Exception' do
+      it 'returns an event' do
+        expect(Opbeat::Event.from_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) {
+        exc = Opbeat::Test::Exception.new(message)
+        exc.set_backtrace caller
+        exc
+      }
+
+      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.from_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.from_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.from_exception(exception).to_hash
+        expect(hash['extra']).to eq(extra_context)
+      end
+    end
+  end
+end

data/spec/opbeat/filter_spec.rb

@@ -0,0 +1,101 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat/filter'
+
+describe Opbeat::Filter do
+  it 'should filter http data by default' do
+    data = {
+      'http' => {
+        'data' => {
+          'foo' => 'bar',
+          'password' => 'hello',
+          'the_secret' => 'hello',
+          'a_password_here' => 'hello',
+          'mypasswd' => 'hello'
+        }
+      }
+    }
+
+    filter = Opbeat::Filter.new
+    result = filter.process_event_hash(data)
+
+    vars = result["http"]["data"]
+    expect(vars["foo"]).to eq("bar")
+    expect(vars["password"]).to eq(Opbeat::Filter::MASK)
+    expect(vars["the_secret"]).to eq(Opbeat::Filter::MASK)
+    expect(vars["a_password_here"]).to eq(Opbeat::Filter::MASK)
+    expect(vars["mypasswd"]).to eq(Opbeat::Filter::MASK)
+  end
+
+  it 'should filter http query_string by default' do
+    data = {
+      'http' => {
+        'query_string' => 'foo=bar&password=secret'
+      }
+    }
+
+    filter = Opbeat::Filter.new
+    result = filter.process_event_hash(data)
+
+    expect(result["http"]["query_string"]).to eq('foo=bar&password=' + Opbeat::Filter::MASK)
+  end
+
+  it 'should filter http cookies by default' do
+    data = {
+      'http' => {
+        'cookies' => 'foo=bar;password=secret'
+      }
+    }
+
+    filter = Opbeat::Filter.new
+    result = filter.process_event_hash(data)
+
+    expect(result["http"]["cookies"]).to eq('foo=bar;password=' + Opbeat::Filter::MASK)
+  end
+
+  it 'should not filter env, extra or headers' do
+    data = {
+      'http' => {
+        'env' => { 'password' => 'hello' },
+        'extra' => { 'password' => 'hello' },
+        'headers' => { 'password' => 'hello' }
+      }
+    }
+
+    filter = Opbeat::Filter.new
+    result = filter.process_event_hash(data)
+
+    expect(result).to eq(data)
+  end
+
+  it 'should be configurable' do
+    data = {
+      'http' => {
+        'data' => {
+          'foo' => 'secret',
+          'bar' => 'secret',
+          '-baz-' => 'secret',
+          'password' => 'public',
+          'the_secret' => 'public',
+          'a_password_here' => 'public',
+          'mypasswd' => 'public'
+        },
+        'query_string' => 'foo=secret&password=public',
+        'cookies' => 'foo=secret;password=public'
+      }
+    }
+
+    filter = Opbeat::Filter.new [:foo, 'bar', /baz/]
+    result = filter.process_event_hash(data)
+
+    vars = result["http"]["data"]
+    expect(vars["foo"]).to eq(Opbeat::Filter::MASK)
+    expect(vars["bar"]).to eq(Opbeat::Filter::MASK)
+    expect(vars["-baz-"]).to eq(Opbeat::Filter::MASK)
+    expect(vars["password"]).to eq("public")
+    expect(vars["the_secret"]).to eq("public")
+    expect(vars["a_password_here"]).to eq("public")
+    expect(vars["mypasswd"]).to eq("public")
+    expect(result["http"]["query_string"]).to eq('foo=' + Opbeat::Filter::MASK + '&password=public')
+    expect(result["http"]["cookies"]).to eq('foo=' + Opbeat::Filter::MASK + ';password=public')
+  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::capture_exception on erronous jobs' do
+    test_exception = Exception.new("Test exception")
+    expect(Opbeat).to receive(:capture_exception).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,89 @@
+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(:from_message) { @event }
+    allow(Opbeat::Event).to receive(:from_exception) { @event }
+    allow(Opbeat::Event).to receive(:from_rack_exception) { @event }
+  end
+
+  it 'capture_message should send result of Event.from_message' do
+    message = "Test message"
+    expect(Opbeat::Event).to receive(:from_message).with(message, an_instance_of(Array), {})
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.capture_message(message)
+  end
+
+  it 'capture_message with options should send result of Event.from_message' do
+    message = "Test message"
+    options = {:extra => {:hello => "world"}}
+    expect(Opbeat::Event).to receive(:from_message).with(message, an_instance_of(Array), options)
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.capture_message(message, options)
+  end
+
+  it 'capture_exception should send result of Event.from_exception' do
+    exception = build_exception()
+
+    expect(Opbeat::Event).to receive(:from_exception).with(exception, {})
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.capture_exception(exception)
+  end
+
+  it 'capture_rack_exception should send result of Event.from_exception built with env and default options' do
+    exception = build_exception()
+    rack_env = build_rack_env()
+
+    expect(Opbeat::Event).to receive(:from_rack_exception).with(exception, rack_env, {})
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.capture_rack_exception(exception, rack_env)
+  end
+
+  it "capture_rack_exception should send result of Event.from_exception built with env and options" do
+    exception = build_exception()
+    rack_env = build_rack_env()
+
+    expect(Opbeat::Event).to receive(:from_rack_exception).with(exception, rack_env, {:custom => :param})
+    expect(Opbeat).to receive(:send).with(@event)
+
+    Opbeat.capture_rack_exception(exception, rack_env, {:custom => :param})
+  end
+
+  context "async" do
+    after do
+      Opbeat.configuration.async = false
+    end
+
+    it 'capture_message should send result of Event.from_message' do
+      async = lambda {}
+      message = "Test message"
+
+      expect(Opbeat::Event).to receive(:from_message).with(message, an_instance_of(Array), {})
+      expect(Opbeat).to_not receive(:send)
+      expect(async).to receive(:call).with(@event)
+
+      Opbeat.configuration.async = async
+      Opbeat.capture_message(message)
+    end
+
+    it 'capture_exception should send result of Event.from_exception' do
+      async = lambda {}
+      exception = build_exception()
+
+      expect(Opbeat::Event).to receive(:from_exception).with(exception, {})
+      expect(Opbeat).to_not receive(:send)
+      expect(async).to receive(:call).with(@event)
+
+      Opbeat.configuration.async = async
+      Opbeat.capture_exception(exception)
+    end
+  end
+end