party_fouls 1.5.6

data/test/party_foul/issue_renderers/base_test.rb

@@ -0,0 +1,210 @@
+require 'test_helper'
+require 'active_support/core_ext/object/blank'
+require 'action_dispatch/http/parameter_filter'
+
+describe 'Party Foul Issue Renderer Base' do
+  before do
+    Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 0, '-05:00'))
+  end
+
+  after do
+    clean_up_party
+  end
+
+  describe '#body' do
+    describe 'updating issue body' do
+      before do
+        @rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        @rendered_issue.stubs(:exception).returns('Test Exception')
+        @rendered_issue.stubs(:fingerprint).returns('abcdefg1234567890')
+        @rendered_issue.stubs(:stack_trace)
+      end
+
+      it 'updates count and timestamp' do
+        body = <<-BODY.gsub(/\n/, '')
+<table>
+<tr><th>Exception</th><td>Test Exception</td></tr>
+<tr><th>Last Occurrence</th><td>January 01, 1970 00:00:00 -0500</td></tr>
+<tr><th>Count</th><td>1</td></tr>
+</table>
+
+## Stack Trace
+<pre></pre>
+Fingerprint: `abcdefg1234567890`
+    BODY
+
+        Time.stubs(:now).returns(Time.new(1985, 10, 25, 1, 22, 0, '-05:00'))
+
+        expected_body = <<-BODY.gsub(/\n/, '')
+<table>
+<tr><th>Exception</th><td>Test Exception</td></tr>
+<tr><th>Last Occurrence</th><td>October 25, 1985 01:22:00 -0500</td></tr>
+<tr><th>Count</th><td>2</td></tr>
+</table>
+
+## Stack Trace
+<pre></pre>
+Fingerprint: `abcdefg1234567890`
+    BODY
+
+        @rendered_issue.update_body(body).must_equal expected_body
+      end
+    end
+
+    describe 'empty body' do
+      before do
+        @rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        @rendered_issue.stubs(:exception).returns('Test Exception')
+        @rendered_issue.stubs(:fingerprint).returns('abcdefg1234567890')
+        @rendered_issue.stubs(:stack_trace)
+      end
+
+      it 'resets body' do
+        expected_body = <<-BODY
+<table><tr><th>Exception</th><td>Test Exception</td></tr><tr><th>Last Occurrence</th><td>January 01, 1970 00:00:00 -0500</td></tr><tr><th>Count</th><td>1</td></tr></table>
+
+## Stack Trace
+<pre></pre>
+Fingerprint: `abcdefg1234567890`
+    BODY
+        @rendered_issue.update_body(nil).must_equal expected_body
+      end
+    end
+  end
+
+  describe '#build_table_from_hash' do
+    it 'builds an HTML table from a hash' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      hash = { 'Value 1' => 'abc', 'Value 2' => { 'Value A' => 123, 'Value B' => 456 } }
+      expected = '<table><tr><th>Value 1</th><td>abc</td></tr><tr><th>Value 2</th><td><table><tr><th>Value A</th><td>123</td></tr><tr><th>Value B</th><td>456</td></tr></table></td></tr></table>'
+      rendered_issue.build_table_from_hash(hash).must_equal expected
+    end
+
+    it 'escapes HTML entities' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      hash = { 'Value 1' => 'Error in #<Foo>' }
+      expected = '<table><tr><th>Value 1</th><td>Error in #&lt;Foo&gt;</td></tr></table>'
+      rendered_issue.build_table_from_hash(hash).must_equal expected
+    end
+  end
+
+  describe '#fingerprint' do
+    it 'SHA1s the title' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      rendered_issue.stubs(:title).returns('abcdefg1234567890')
+      rendered_issue.fingerprint.must_equal Digest::SHA1.hexdigest(rendered_issue.title)
+    end
+  end
+
+  describe '#occurred_at' do
+    it 'memoizes the time' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      expected = rendered_issue.occurred_at
+      Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 1, '-05:00'))
+      rendered_issue.occurred_at.must_equal expected
+    end
+  end
+
+  describe '#title' do
+    context 'when no title prefix is configured' do
+      before do
+        PartyFoul.configure do |config|
+          config.title_prefix = nil
+        end
+      end
+
+      it 'masks the object ids in the raw_title' do
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        rendered_issue.stubs(:raw_title).returns('Error for #<ClassName:0xabcdefg1234567>')
+        rendered_issue.title.must_equal 'Error for #<ClassName:0xXXXXXX>'
+      end
+
+      it 'masks the extended object ids in the raw_title' do
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        rendered_issue.stubs(:raw_title).returns('Error for #<#<ClassName:0x007fbddbdcd340>:0x007fbddf6be0a0>')
+        rendered_issue.title.must_equal 'Error for #<#<ClassName:0xXXXXXX>:0xXXXXXX>'
+      end
+    end
+
+    context 'when a custom title prefix is configured' do
+      before do
+        PartyFoul.configure do |config|
+          config.title_prefix = 'PRODUCTION'
+        end
+      end
+
+      it 'adds a custom prefix' do
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        rendered_issue.stubs(:raw_title).returns('Error')
+        rendered_issue.title.must_equal '[PRODUCTION] Error'
+      end
+
+      it 'generated unique fingerprints' do
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        rendered_issue.stubs(:raw_title).returns('Error')
+        fingerprint = rendered_issue.fingerprint
+
+        PartyFoul.configure do |config|
+          config.title_prefix = 'STAGING'
+        end
+
+        fingerprint.wont_equal rendered_issue.fingerprint
+      end
+    end
+
+    context 'title length limit' do
+      before do
+        PartyFoul.configure do |config|
+          config.title_prefix = 'PRODUCTION'
+        end
+      end
+
+      it 'at most 256 chars' do
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        rendered_issue.stubs(:raw_title).returns('F'*300)
+        rendered_issue.title.size.must_equal 256
+      end
+    end
+  end
+
+  describe '#stack_trace' do
+    # it 'returns the stack trace' do
+      # exception = mock do
+        # stubs backtrace: ['/path/to/gems/gem-name/lib/some/file.rb:123 in `method`']
+      # end
+      # rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
+      # rendered_issue.stack_trace.must_equal exception.backtrace.first
+    # end
+
+    it 'formats the stack trace with shortened bundle paths' do
+      exception = mock do
+        stubs backtrace: ["#{Bundler.bundle_path}/some_gem/lib/some/file.rb:123 in `method`"]
+      end
+
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
+      rendered_issue.stack_trace.must_equal '[bundle].../some_gem/lib/some/file.rb:123 in `method`'
+    end
+
+    it 'formats the stack trace with link to shortened application path' do
+      clean_up_party
+      exception = mock do
+        stubs backtrace: ['/path/to/app/lib/some/file.rb:123 in `method`']
+      end
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
+      rendered_issue.stubs app_root: '/path/to/app'
+      rendered_issue.stack_trace.must_match "<a href='https://github.com///blob//lib/some/file.rb#L123'>[app].../lib/some/file.rb:123 in `method`</a>"
+    end
+
+    it 'does not link to bundled resources on Heroku' do
+      Bundler.stub(:bundle_path, '/app/vendor/bundle/ruby/2.0.0') do
+        exception = mock do
+          stubs backtrace: ["#{Bundler.bundle_path}/some_gem/lib/some/file.rb:123 in `method`"]
+        end
+
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
+        rendered_issue.stubs app_root: '/app'
+        rendered_issue.stack_trace.must_equal '[bundle].../some_gem/lib/some/file.rb:123 in `method`'
+      end
+    end
+  end
+end

data/test/party_foul/issue_renderers/rack_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+describe 'Rack Issue Renderer' do
+  describe '#params' do
+    before do
+      @issue_renderer = PartyFoul::IssueRenderers::Rack.new(nil, ::Rack::MockRequest.env_for("/?status=ok"))
+    end
+
+    it 'returns the value of the query param' do
+      @issue_renderer.params['status'].must_equal 'ok'
+    end
+  end
+  
+  describe '#raw_title' do
+    before do
+      @exception = Exception.new('message')
+    end
+
+    it 'constructs the title with the class and instance method' do
+      @issue_renderer = PartyFoul::IssueRenderers::Rack.new(@exception, {})
+      @issue_renderer.send(:raw_title).must_equal %{(Exception) "message"}
+    end
+  end
+  
+  describe '#request' do
+    it 'builds a rack request' do
+      issue_renderer = PartyFoul::IssueRenderers::Rack.new(nil, {})
+      assert issue_renderer.request.is_a?(::Rack::Request)
+    end
+  end  
+  
+  describe '#ip_address_geolocator' do
+    # we are delegating to rack, see
+    # https://github.com/rack/rack/blob/master/test/spec_request.rb    
+    
+    it 'returns the link to geolocation IP address when REMOTE_ADDR is set' do
+      issue_renderer = PartyFoul::IssueRenderers::Rack.new(nil, { 'REMOTE_ADDR' => '1.2.3.4' })
+      ip_addr = "<a href='http://ipinfo.io/1.2.3.4'>1.2.3.4</a>"
+      issue_renderer.ip_address_locator.must_equal ip_addr
+    end
+    
+    it 'return the link to geolocation IP address when HTTP_X_FORWARDED_FOR is set' do
+      issue_renderer = PartyFoul::IssueRenderers::Rack.new(nil, { 'HTTP_X_FORWARDED_FOR' => '10.0.0.1, 10.0.0.1, 3.4.5.6' })
+      ip_addr = "<a href='http://ipinfo.io/3.4.5.6'>3.4.5.6</a>"
+      issue_renderer.ip_address_locator.must_equal ip_addr
+    end
+  end
+  
+  describe '#url' do
+    it 'returns the method and uri' do
+      issue_renderer = PartyFoul::IssueRenderers::Rack.new(nil, { 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/something' })
+      issue_renderer.url.must_equal '[GET] /something'
+    end    
+  end  
+  
+  describe '#session' do
+    it 'returns the session' do
+      issue_renderer = PartyFoul::IssueRenderers::Rack.new(nil, { 'rack.session' => 'abc:123' })
+      issue_renderer.session.must_equal 'abc:123'
+    end    
+  end
+  
+  describe '#http_headers' do
+    it 'returns http headers' do
+      issue_renderer = PartyFoul::IssueRenderers::Rack.new(nil, 
+        { 
+          'HTTP_VERSION' => 'version',
+          'HTTP_USER_AGENT' => 'user agent',
+          'HTTP_ACCEPT_ENCODING' => 'accept encoding',
+          'HTTP_ACCEPT' => 'accept' 
+        })
+        
+      issue_renderer.http_headers[:Version].must_equal 'version'
+      issue_renderer.http_headers['User Agent'].must_equal 'user agent'
+      issue_renderer.http_headers['Accept Encoding'].must_equal 'accept encoding'
+      issue_renderer.http_headers[:Accept].must_equal 'accept'
+    end    
+  end
+      
+end

data/test/party_foul/issue_renderers/rackless_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+describe 'Rackless Issue Renderer' do
+  before do
+    @env = { :params => { :val1 => '1', :val2 => '2' }, :class => 'Worker', :method => 'perform' }
+  end
+
+  describe '#params' do
+    before do
+      @rendered_issue = PartyFoul::IssueRenderers::Rackless.new(nil, @env)
+    end
+
+    it 'returns the parameters' do
+      @rendered_issue.params[:val1].must_equal '1'
+      @rendered_issue.params[:val2].must_equal '2'
+    end
+  end
+
+  describe '#raw_title' do
+    before do
+      @exception = Exception.new('message')
+      @rendered_issue = PartyFoul::IssueRenderers::Rackless.new(@exception, @env)
+    end
+
+    it 'constructs the title with the controller and action' do
+      @rendered_issue.send(:raw_title).must_equal %{Worker#perform (Exception) "message"}
+    end
+  end
+end

data/test/party_foul/issue_renderers/rails_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+describe 'Rails Issue Renderer' do
+  describe '#params' do
+    let(:request_parameters) { { 'status' => 'ok', 'password' => 'test' } }
+    before do
+      @rendered_issue = PartyFoul::IssueRenderers::Rails.new(nil, {'action_dispatch.parameter_filter' => ['password'], 'action_dispatch.request.parameters' => request_parameters, 'QUERY_STRING' => { 'status' => 'fail' } })
+    end
+
+    it 'returns ok' do
+      @rendered_issue.params['status'].must_equal 'ok'
+      @rendered_issue.params['password'].must_equal '[FILTERED]'
+    end
+
+    context 'without request parameters' do
+      let(:request_parameters) { nil }
+
+      it 'returns empty hash' do
+        @rendered_issue.params.must_equal({})
+      end
+    end
+  end
+
+  describe '#occurred_at' do
+    it 'uses current when possible' do
+      Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 1, '-08:00'))
+      Time.stubs(:current).returns(Time.new(1970, 1, 1, 0, 0, 1, '-05:00'))
+      current_as_string = Time.current.strftime('%B %d, %Y %H:%M:%S %z')
+      rendered_issue = PartyFoul::IssueRenderers::Rails.new(nil, nil)
+      rendered_issue.occurred_at.must_equal current_as_string
+    end
+  end
+
+  describe '#session' do
+    let(:params) { {'action_dispatch.parameter_filter' => ['password'], 'rack.session' => { 'status' => 'ok', 'password' => 'test' }, 'QUERY_STRING' => { 'status' => 'fail' } } }
+
+    before do
+      @rendered_issue = PartyFoul::IssueRenderers::Rails.new(nil, params)
+    end
+
+    it 'returns ok' do
+      @rendered_issue.session['status'].must_equal 'ok'
+      @rendered_issue.session['password'].must_equal '[FILTERED]'
+    end
+
+    context "without session" do
+
+      let(:params) { {'action_dispatch.parameter_filter' => ['password'], 'QUERY_STRING' => { 'status' => 'fail' } } }
+
+      it 'returns empty hash' do
+        @rendered_issue.session.must_be_empty
+      end
+    end
+
+
+  end
+
+  describe '#raw_title' do
+    let(:request_parameters) { { 'controller' => 'landing', 'action' => 'index' } }
+    before do
+      @exception = Exception.new('message')
+      controller_instance = mock('Controller')
+      controller_instance.stubs(:class).returns('LandingController')
+      env = {
+        'action_dispatch.request.parameters' => request_parameters,
+        'action_controller.instance' => controller_instance
+      }
+      @rendered_issue = PartyFoul::IssueRenderers::Rails.new(@exception, env)
+    end
+
+    it 'constructs the title with the controller and action' do
+      @rendered_issue.send(:raw_title).must_equal %{LandingController#index (Exception) "message"}
+    end
+
+    context 'without request parameters' do
+      let(:request_parameters) { nil }
+
+      it 'leaves action blank' do
+        @rendered_issue.send(:raw_title).must_equal %{LandingController# (Exception) "message"}
+      end
+    end
+  end
+end

data/test/party_foul/middleware_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+describe 'Party Foul Middleware' do
+  include Rack::Test::Methods
+
+  after do
+    clean_up_party
+  end
+
+  def error_to_raise
+    Exception
+  end
+
+  def app
+    _self = self
+    Rack::Builder.new {
+      map '/' do
+        use PartyFoul::Middleware
+        run lambda { |env| raise _self.error_to_raise }
+      end
+    }
+  end
+
+  context 'handling an exception' do
+    it 'does not handle exception' do
+      PartyFoul::ExceptionHandler.stubs(:handle)
+      PartyFoul::ExceptionHandler.expects(:handle)
+      lambda {
+        get '/'
+      }.must_raise(Exception)
+    end
+  end
+
+  context 'filtering based upon exception' do
+    before do
+      PartyFoul.blacklisted_exceptions = ['StandardError']
+      self.stubs(:error_to_raise).returns(StandardError)
+    end
+
+    it 'does not handle exception' do
+      PartyFoul::ExceptionHandler.stubs(:handle)
+      PartyFoul::ExceptionHandler.expects(:handle).never
+      lambda {
+        get '/'
+      }.must_raise(StandardError)
+    end
+  end
+end

data/test/party_foul/rackless_exception_handler_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+describe 'Party Foul Rackless Exception Handler' do
+  before do
+    PartyFoul.configure do |config|
+      config.oauth_token = 'abcdefg1234567890'
+      config.owner       = 'test_owner'
+      config.repo        = 'test_repo'
+    end
+  end
+
+  describe '#handle' do
+    it 'will call run on itself' do
+      PartyFoul::RacklessExceptionHandler.any_instance.expects(:run)
+      PartyFoul::RacklessExceptionHandler.handle(nil, {})
+    end
+
+    it 'should pass parameters required by the renderer to the initializer' do
+      params = {:class => Object, :method => :to_s, :params => {:one => "One", :two => "Two"}}
+      expected_exception_handler = PartyFoul::RacklessExceptionHandler.new(nil, params)
+      expected_exception_handler.expects(:run)
+      PartyFoul::RacklessExceptionHandler.expects(:new).with(nil, params).returns(expected_exception_handler)
+      PartyFoul::RacklessExceptionHandler.handle(nil, params)      
+    end
+  end
+
+  describe '#initialize' do
+    it 'should use PartyFoul::IssueRenderers::Rackless for rendering issues' do
+      issue_renderer = PartyFoul::RacklessExceptionHandler.new(nil, {}).rendered_issue
+      assert_kind_of(PartyFoul::IssueRenderers::Rackless, issue_renderer)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'bundler/setup'
+
+if defined?(M)
+  require 'minitest/spec'
+else
+  require 'minitest/autorun'
+end
+begin
+  require 'byebug'
+rescue LoadError
+end
+require 'rack/test'
+require 'mocha/setup'
+require 'active_support'
+require 'party_foul'
+
+ActiveSupport.test_order = :random
+
+class MiniTest::Spec
+  class << self
+    alias :context :describe
+  end
+end
+
+module MiniTest::Expectations
+  infect_an_assertion :assert_received, :must_have_received
+end
+
+def clean_up_party
+  %w{github oauth_token api_endpoint owner repo blacklisted_exceptions processor web_url branch additional_labels comment_limit}.each do |attr|
+    PartyFoul.send("#{attr}=", nil)
+  end
+end
+
+def sawyer_resource(attrs)
+  agent = Sawyer::Agent.new(PartyFoul.api_endpoint)
+  Sawyer::Resource.new(agent, attrs)
+end
+
+def no_search_results
+  sawyer_resource(total_count: 0, incomplete_results: false, items: [])
+end

data/test/tmp/config/initializers/party_foul.rb

@@ -0,0 +1,39 @@
+PartyFoul.configure do |config|
+  # The collection of exceptions PartyFoul should not be allowed to handle
+  # The constants here *must* be represented as strings
+  config.blacklisted_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
+
+  # The OAuth token for the account that is opening the issues on GitHub
+  config.oauth_token            = 'test_token'
+
+  # The API endpoint for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
+  config.api_endpoint           = 'http://api.example.com'
+
+  # The Web URL for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
+  config.web_url                = 'http://example.com'
+
+  # The organization or user that owns the target repository
+  config.owner                  = 'test_owner'
+
+  # The repository for this application
+  config.repo                   = 'test_repo'
+
+  # The branch for your deployed code
+  # config.branch               = 'master'
+
+  # Additional labels to add to issues created
+  # config.additional_labels    = ['production']
+  # or
+  # config.additional_labels    = Proc.new do |exception, env|
+  #   []
+  # end
+
+  # Limit the number of comments per issue
+  # config.comment_limit        = 10
+
+  # Setting your title prefix can help with
+  # distinguishing the issue between environments
+  # config.title_prefix         = Rails.env
+end