wd_newrelic_rpm 3.3.4.1

data/test/new_relic/agent/database_test.rb

@@ -0,0 +1,149 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..',
+                                   'test_helper'))
+require 'new_relic/agent/database'
+class NewRelic::Agent::DatabaseTest < Test::Unit::TestCase
+  def teardown
+    NewRelic::Agent::Database::Obfuscator.instance.reset
+  end
+  
+  def test_process_resultset
+    resultset = [["column"]]
+    assert_equal([nil, [["column"]]],
+                 NewRelic::Agent::Database.process_resultset(resultset))
+  end
+  
+  def test_explain_sql_select_with_mysql_connection
+    config = {:adapter => 'mysql'}
+    config.default('val')
+    sql = 'SELECT foo'
+    connection = mock('connection')
+    plan = {
+      "select_type"=>"SIMPLE", "key_len"=>nil, "table"=>"blogs", "id"=>"1",
+      "possible_keys"=>nil, "type"=>"ALL", "Extra"=>"", "rows"=>"2",
+      "ref"=>nil, "key"=>nil
+    }
+    result = mock('explain plan')
+    result.expects(:each_hash).yields(plan)
+    # two rows, two columns
+    connection.expects(:execute).with('EXPLAIN SELECT foo').returns(result)
+    NewRelic::Agent::Database.expects(:get_connection).with(config).returns(connection)
+
+    result = NewRelic::Agent::Database.explain_sql(sql, config)
+    assert_equal(plan.keys.sort, result[0].sort)
+    assert_equal(plan.values.compact.sort, result[1][0].compact.sort)    
+  end
+
+  def test_explain_sql_one_select_with_pg_connection
+    config = {:adapter => 'postgresql'}
+    config.default('val')
+    sql = 'select count(id) from blogs limit 1'
+    connection = mock('connection')
+    plan = [{"QUERY PLAN"=>"Limit  (cost=11.75..11.76 rows=1 width=4)"},
+            {"QUERY PLAN"=>"  ->  Aggregate  (cost=11.75..11.76 rows=1 width=4)"},
+            {"QUERY PLAN"=>"        ->  Seq Scan on blogs  (cost=0.00..11.40 rows=140 width=4)"}]
+    connection.expects(:execute).returns(plan)
+    NewRelic::Agent::Database.expects(:get_connection).with(config).returns(connection)
+    assert_equal([['QUERY PLAN'],
+                  [["Limit  (cost=11.75..11.76 rows=1 width=4)"],
+                   ["  ->  Aggregate  (cost=11.75..11.76 rows=1 width=4)"],
+                   ["        ->  Seq Scan on blogs  (cost=0.00..11.40 rows=140 width=4)"]]],
+                 NewRelic::Agent::Database.explain_sql(sql, config))
+  end
+
+  def test_explain_sql_no_sql
+    assert_equal(nil, NewRelic::Agent::Database.explain_sql(nil, nil))
+  end
+
+  def test_explain_sql_no_connection_config
+    assert_equal(nil, NewRelic::Agent::Database.explain_sql('select foo', nil))
+  end
+
+  def test_explain_sql_non_select
+    assert_equal([], NewRelic::Agent::Database.explain_sql('foo',
+                                                           mock('config')))
+  end
+
+  def test_explain_sql_one_select_no_connection
+    # NB this test raises an error in the log, much as it might if a
+    # user supplied a config that was not valid. This is generally
+    # expected behavior - the get_connection method shouldn't allow
+    # errors to percolate up.
+    config = mock('config')
+    config.stubs(:[]).returns(nil)
+    assert_equal([], NewRelic::Agent::Database.explain_sql('SELECT', config))
+  end  
+  
+  def test_handle_exception_in_explain
+    fake_error = StandardError.new('a message')
+    NewRelic::Control.instance.log.expects(:error).with('Error getting query plan: a message')
+    # backtrace can be basically any string, just should get logged
+    NewRelic::Control.instance.log.expects(:debug).with(instance_of(String))
+    
+    NewRelic::Agent::Database.handle_exception_in_explain do
+      raise(fake_error)
+    end
+  end
+  
+  def test_obfuscation_mysql_basic
+    insert = %q[INSERT INTO `X` values("test",0, 1 , 2, 'test')]
+    assert_equal("INSERT INTO `X` values(?,?, ? , ?, ?)",
+                 NewRelic::Agent::Database.obfuscate_sql(insert))
+    select = %q[SELECT `table`.`column` FROM `table` WHERE `table`.`column` = 'value' AND `table`.`other_column` = "other value" LIMIT 1]
+    assert_equal(%q[SELECT `table`.`column` FROM `table` WHERE `table`.`column` = ? AND `table`.`other_column` = ? LIMIT ?],
+                 NewRelic::Agent::Database.obfuscate_sql(select))
+  end
+
+  def test_obfuscation_postgresql_basic
+    insert = NewRelic::Agent::Database::Statement.new(%q[INSERT INTO "X" values('test',0, 1 , 2, 'test')])
+    insert.adapter = :postgresql
+    assert_equal('INSERT INTO "X" values(?,?, ? , ?, ?)',
+                 NewRelic::Agent::Database.obfuscate_sql(insert))
+    select = NewRelic::Agent::Database::Statement.new(%q[SELECT "table"."column" FROM "table" WHERE "table"."column" = 'value' AND "table"."other_column" = 'other value' LIMIT 1])
+    select.adapter = :postgresql
+    assert_equal(%q[SELECT "table"."column" FROM "table" WHERE "table"."column" = ? AND "table"."other_column" = ? LIMIT ?],
+                 NewRelic::Agent::Database.obfuscate_sql(select))  
+  end
+  
+  def test_obfuscation_escaped_literals
+    insert = %q[INSERT INTO X values('', 'jim''s ssn',0, 1 , 'jim''s son''s son', """jim''s"" hat", "\"jim''s secret\"")]
+    assert_equal("INSERT INTO X values(?, ?,?, ? , ?, ?, ?)",
+                 NewRelic::Agent::Database.obfuscate_sql(insert))
+  end
+
+  def test_obfuscation_mysql_integers_in_identifiers
+    select = %q[SELECT * FROM `table_007` LIMIT 1]
+    assert_equal(%q[SELECT * FROM `table_007` LIMIT ?],
+                 NewRelic::Agent::Database.obfuscate_sql(select))
+  end
+  
+  def test_obfuscation_postgresql_integers_in_identifiers
+    select = NewRelic::Agent::Database::Statement.new(%q[SELECT * FROM "table_007" LIMIT 1])
+    select.adapter = :postgresql
+    assert_equal(%q[SELECT * FROM "table_007" LIMIT ?],
+                 NewRelic::Agent::Database.obfuscate_sql(select))
+  end
+
+  def test_sql_obfuscation_filters
+    NewRelic::Agent::Database.set_sql_obfuscator(:replace) do |string|
+      "1" + string
+    end
+    
+    sql = "SELECT * FROM TABLE 123 'jim'"
+    
+    assert_equal "1" + sql, NewRelic::Agent::Database.obfuscate_sql(sql)
+    
+    NewRelic::Agent::Database.set_sql_obfuscator(:before) do |string|
+      "2" + string
+    end
+    
+    assert_equal "12" + sql, NewRelic::Agent::Database.obfuscate_sql(sql)
+    
+    NewRelic::Agent::Database.set_sql_obfuscator(:after) do |string|
+      string + "3"
+    end
+    
+    assert_equal "12" + sql + "3", NewRelic::Agent::Database.obfuscate_sql(sql)
+
+    NewRelic::Agent::Database::Obfuscator.instance.reset
+  end
+end

data/test/new_relic/agent/error_collector/notice_error_test.rb

@@ -0,0 +1,257 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','test_helper'))
+class NewRelic::Agent::ErrorCollector::NoticeErrorTest < Test::Unit::TestCase
+  require 'new_relic/agent/error_collector'
+  include NewRelic::Agent::ErrorCollector::NoticeError
+
+  def test_error_params_from_options_mocked
+    options = {:initial => 'options'}
+    self.expects(:uri_ref_and_root).returns({:hi => 'there', :hello => 'bad'})
+    self.expects(:normalized_request_and_custom_params).with({:initial => 'options'}).returns({:hello => 'world'})
+    assert_equal({:hi => 'there', :hello => 'world'}, error_params_from_options(options))
+  end
+
+  module Winner
+    def winner
+      'yay'
+    end
+  end
+
+  def test_sense_method
+    object = Object.new
+    object.extend(Winner)
+    assert !sense_method(object, 'blab')
+    assert_equal 'yay', sense_method(object, 'winner')
+  end
+
+  def test_fetch_from_options
+    options = {:hello => 'world'}
+    assert_equal 'world', fetch_from_options(options, :hello, '')
+    assert_equal '', fetch_from_options(options, :none, '')
+    assert_equal({}, options)
+  end
+
+  def test_uri_ref_and_root_default
+    fake_control = mocked_control
+    fake_control.expects(:root).returns('rootbeer')
+    options = {}
+    assert_equal({:request_referer => '', :rails_root => 'rootbeer', :request_uri => ''}, uri_ref_and_root(options))
+  end
+
+  def test_uri_ref_and_root_values
+    fake_control = mocked_control
+    fake_control.expects(:root).returns('rootbeer')
+    options = {:uri => 'whee', :referer => 'bang'}
+    assert_equal({:request_referer => 'bang', :rails_root => 'rootbeer', :request_uri => 'whee'}, uri_ref_and_root(options))
+  end
+
+  def test_custom_params_from_opts_base
+    assert_equal({}, custom_params_from_opts({}))
+  end
+
+  def test_custom_params_from_opts_custom_params
+    assert_equal({:foo => 'bar'}, custom_params_from_opts({:custom_params => {:foo => 'bar'}}))
+  end
+
+  def test_custom_params_from_opts_merged_params
+    assert_equal({:foo => 'baz'}, custom_params_from_opts({:custom_params => {:foo => 'bar'}, :foo => 'baz'}))
+  end
+
+  def test_request_params_from_opts_positive
+    fake_control = mock('control')
+    self.expects(:control).returns(fake_control)
+    fake_control.expects(:capture_params).returns(true)
+    val = {:request_params => 'foo'}
+    assert_equal('foo', request_params_from_opts(val))
+    assert_equal({}, val, "should delete request_params key from hash")
+  end
+
+  def test_request_params_from_opts_negative
+    fake_control = mock('control')
+    self.expects(:control).returns(fake_control)
+    fake_control.expects(:capture_params).returns(false)
+    val = {:request_params => 'foo'}
+    assert_equal(nil, request_params_from_opts(val))
+    assert_equal({}, val, "should delete request_params key from hash")
+  end
+
+  def test_normalized_request_and_custom_params_base
+    self.expects(:normalize_params).with(nil).returns(nil)
+    self.expects(:normalize_params).with({}).returns({})
+    fake_control = mock('control')
+    self.expects(:control).returns(fake_control)
+    fake_control.expects(:capture_params).returns(true)
+    assert_equal({:request_params => nil, :custom_params => {}}, normalized_request_and_custom_params({}))
+  end
+
+  def test_extract_source_base
+    @capture_source = true
+    self.expects(:sense_method).with(nil, 'source_extract')
+    assert_equal(nil, extract_source(nil))
+  end
+
+  def test_extract_source_disabled
+    @capture_source = false
+    assert_equal(nil, extract_source(mock('exception')))
+  end
+
+  def test_extract_source_with_source
+    self.expects(:sense_method).with('happy', 'source_extract').returns('THE SOURCE')
+    @capture_source = true
+    assert_equal('THE SOURCE', extract_source('happy'))
+  end
+
+  def test_extract_stack_trace
+    exception = mock('exception')
+    self.expects(:sense_method).with(exception, 'original_exception')
+    self.expects(:sense_method).with(exception, 'backtrace')
+    assert_equal('<no stack trace>', extract_stack_trace(exception))
+  end
+
+  def test_extract_stack_trace_positive
+    orig = mock('original')
+    exception = mock('exception')
+    self.expects(:sense_method).with(exception, 'original_exception').returns(orig)
+    self.expects(:sense_method).with(orig, 'backtrace').returns('STACK STACK STACK')
+    assert_equal('STACK STACK STACK', extract_stack_trace(exception))
+  end
+
+  def test_over_queue_limit_negative
+    @errors = []
+    assert !over_queue_limit?(nil)
+  end
+
+  def test_over_queue_limit_positive
+    @errors = %w(1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21)
+    fake_log = mock('log')
+    self.expects(:log).returns(fake_log)
+    fake_log.expects(:warn).with('The error reporting queue has reached 20. The error detail for this and subsequent errors will not be transmitted to New Relic until the queued errors have been sent: hooray')
+    assert over_queue_limit?('hooray')
+  end
+
+  def test_exception_info
+    exception = mock('exception')
+    self.expects(:sense_method).with(exception, 'file_name').returns('file_name')
+    self.expects(:sense_method).with(exception, 'line_number').returns('line_number')
+    self.expects(:extract_source).with(exception).returns('source')
+    self.expects(:extract_stack_trace).with(exception).returns('stack_trace')
+    assert_equal({:file_name => 'file_name', :line_number => 'line_number', :source => 'source', :stack_trace => 'stack_trace'},
+                 exception_info(exception))
+  end
+
+  def test_add_to_error_queue_positive
+    noticed_error = mock('noticed_error')
+    noticed_error.expects(:message).returns('a message')
+    @lock = Mutex.new
+    @errors = []
+    self.expects(:over_queue_limit?).with('a message').returns(false)
+    add_to_error_queue(noticed_error)
+    assert_equal([noticed_error], @errors)
+  end
+
+  def test_add_to_error_queue_negative
+    noticed_error = mock('noticed_error')
+    noticed_error.expects(:message).returns('a message')
+    @lock = Mutex.new
+    @errors = []
+    self.expects(:over_queue_limit?).with('a message').returns(true)
+    add_to_error_queue(noticed_error)
+    assert_equal([], @errors)
+  end
+
+  def test_should_exit_notice_error_disabled
+    error = mocked_error
+    @enabled = false
+    assert should_exit_notice_error?(error)
+  end
+
+  def test_should_exit_notice_error_nil
+    error = nil
+    @enabled = true
+    self.expects(:error_is_ignored?).with(error).returns(false)
+    # we increment it for the case that someone calls
+    # NewRelic::Agent.notice_error(foo) # foo is nil
+    # (which is probably not a good idea but is the existing api)
+    self.expects(:increment_error_count!)
+    assert should_exit_notice_error?(error)
+  end
+
+  def test_should_exit_notice_error_positive
+    error = mocked_error
+    @enabled = true
+    self.expects(:error_is_ignored?).with(error).returns(true)
+    assert should_exit_notice_error?(error)
+  end
+
+  def test_should_exit_notice_error_negative
+    error = mocked_error
+    @enabled = true
+    self.expects(:error_is_ignored?).with(error).returns(false)
+    self.expects(:increment_error_count!)
+    assert !should_exit_notice_error?(error)
+  end
+
+  def test_filtered_error_positive
+    @ignore = {'an_error' => true}
+    error = mocked_error
+    error_class = mock('error class')
+    error.expects(:class).returns(error_class)
+    error_class.expects(:name).returns('an_error')
+    assert filtered_error?(error)
+  end
+
+  def test_filtered_error_negative
+    @ignore = {}
+    error = mocked_error
+    error_class = mock('error class')
+    error.expects(:class).returns(error_class)
+    error_class.expects(:name).returns('an_error')
+    self.expects(:filtered_by_error_filter?).with(error).returns(false)
+    assert !filtered_error?(error)
+  end
+
+  def test_filtered_by_error_filter_empty
+    # should return right away when there's no filter
+    @ignore_filter = nil
+    assert !filtered_by_error_filter?(nil)
+  end
+
+  def test_filtered_by_error_filter_positive
+    error = mocked_error
+    @ignore_filter = lambda { |x| assert_equal error, x; false  }
+    assert filtered_by_error_filter?(error)
+  end
+
+  def test_filtered_by_error_filter_negative
+    error = mocked_error
+    @ignore_filter = lambda { |x| assert_equal error, x; true  }
+    assert !filtered_by_error_filter?(error)
+  end
+
+  def test_error_is_ignored_positive
+    error = mocked_error
+    self.expects(:filtered_error?).with(error).returns(true)
+    assert error_is_ignored?(error)
+  end
+
+  def test_error_is_ignored_negative
+    error = mocked_error
+    self.expects(:filtered_error?).with(error).returns(false)
+    assert !error_is_ignored?(error)
+  end
+
+  def test_error_is_ignored_no_error
+    assert !error_is_ignored?(nil), 'should not ignore nil'
+  end
+
+  private
+
+  def mocked_error
+    mock('error')
+  end
+
+  def mocked_control
+    fake_control = mock('control')
+    self.stubs(:control).returns(fake_control)
+    fake_control
+  end
+end

data/test/new_relic/agent/error_collector_test.rb

@@ -0,0 +1,192 @@
+# Run faster standalone
+ENV['SKIP_RAILS'] = 'true'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper'))
+
+class NewRelic::Agent::ErrorCollectorTest < Test::Unit::TestCase
+  def setup
+    super
+    @error_collector = NewRelic::Agent::ErrorCollector.new
+    @error_collector.stubs(:enabled).returns(true)
+  end
+  
+  def test_empty
+    @error_collector.harvest_errors([])
+    @error_collector.notice_error(nil, :metric=> 'path', :request_params => {:x => 'y'})
+    errors = @error_collector.harvest_errors([])
+
+    assert_equal 0, errors.length
+
+    @error_collector.notice_error('Some error message', :metric=> 'path', :request_params => {:x => 'y'})
+    errors = @error_collector.harvest_errors([])
+
+    err = errors.first
+    assert_equal 'Some error message', err.message
+    assert_equal 'y', err.params[:request_params][:x]
+    assert_equal '', err.params[:request_uri]
+    assert_equal '', err.params[:request_referer]
+    assert_equal 'path', err.path
+    assert_equal 'Error', err.exception_class
+  end
+  
+  def test_simple
+    @error_collector.notice_error(StandardError.new("message"), :uri => '/myurl/', :metric => 'path', :referer => 'test_referer', :request_params => {:x => 'y'})
+
+    old_errors = []
+    errors = @error_collector.harvest_errors(old_errors)
+
+    assert_equal errors.length, 1
+
+    err = errors.first
+    assert_equal 'message', err.message
+    assert_equal 'y', err.params[:request_params][:x]
+    assert err.params[:request_uri] == '/myurl/'
+    assert err.params[:request_referer] == "test_referer"
+    assert err.path == 'path'
+    assert err.exception_class == 'StandardError'
+
+    # the collector should now return an empty array since nothing
+    # has been added since its last harvest
+    errors = @error_collector.harvest_errors(nil)
+    assert errors.length == 0
+  end
+
+  def test_long_message
+    #yes, times 500. it's a 5000 byte string. Assuming strings are
+    #still 1 byte / char.
+    @error_collector.notice_error(StandardError.new("1234567890" * 500), :uri => '/myurl/', :metric => 'path', :request_params => {:x => 'y'})
+
+    old_errors = []
+    errors = @error_collector.harvest_errors(old_errors)
+
+    assert_equal errors.length, 1
+
+    err = errors.first
+    assert_equal 4096, err.message.length
+    assert_equal ('1234567890' * 500)[0..4095], err.message
+  end
+
+  def test_collect_failover
+    @error_collector.notice_error(StandardError.new("message"), :metric => 'first', :request_params => {:x => 'y'})
+
+    errors = @error_collector.harvest_errors([])
+
+    @error_collector.notice_error(StandardError.new("message"), :metric => 'second', :request_params => {:x => 'y'})
+    @error_collector.notice_error(StandardError.new("message"), :metric => 'path', :request_params => {:x => 'y'})
+    @error_collector.notice_error(StandardError.new("message"), :metric => 'last', :request_params => {:x => 'y'})
+
+    errors = @error_collector.harvest_errors(errors)
+
+    assert_equal 4, errors.length
+    assert_equal 'first', errors.first.path
+    assert_equal 'last', errors.last.path
+
+    @error_collector.notice_error(StandardError.new("message"), :metric => 'first', :request_params => {:x => 'y'})
+    @error_collector.notice_error(StandardError.new("message"), :metric => 'last', :request_params => {:x => 'y'})
+
+    errors = @error_collector.harvest_errors(nil)
+    assert_equal 2, errors.length
+    assert_equal 'first', errors.first.path
+    assert_equal 'last', errors.last.path
+  end
+
+  def test_queue_overflow
+
+    max_q_length = 20     # for some reason I can't read the constant in ErrorCollector
+
+    silence_stream(::STDOUT) do
+     (max_q_length + 5).times do |n|
+        @error_collector.notice_error(StandardError.new("exception #{n}"), :metric => "path", :request_params => {:x => n})
+      end
+    end
+
+    errors = @error_collector.harvest_errors([])
+    assert errors.length == max_q_length
+    errors.each_index do |i|
+      err = errors.shift
+      assert_equal i.to_s, err.params[:request_params][:x], err.params.inspect
+    end
+  end
+
+  # Why would anyone undef these methods?
+  class TestClass
+    undef to_s
+    undef inspect
+  end
+
+
+  def test_supported_param_types
+
+    types = [[1, '1'],
+    [1.1, '1.1'],
+    ['hi', 'hi'],
+    [:hi, :hi],
+    [StandardError.new("test"), "#<StandardError>"],
+    [TestClass.new, "#<NewRelic::Agent::ErrorCollectorTest::TestClass>"]
+    ]
+
+
+    types.each do |test|
+      @error_collector.notice_error(StandardError.new("message"), :metric => 'path', :request_params => {:x => test[0]})
+
+      assert_equal test[1], @error_collector.harvest_errors([])[0].params[:request_params][:x]
+    end
+  end
+
+
+  def test_exclude
+    @error_collector.ignore(["IOError"])
+
+    @error_collector.notice_error(IOError.new("message"), :metric => 'path', :request_params => {:x => 'y'})
+
+    errors = @error_collector.harvest_errors([])
+
+    assert_equal 0, errors.length
+  end
+
+  def test_exclude_block
+    NewRelic::Agent.logger.expects(:error).never
+    @error_collector.ignore_error_filter &wrapped_filter_proc
+        
+    @error_collector.notice_error(IOError.new("message"), :metric => 'path', :request_params => {:x => 'y'})
+    @error_collector.notice_error(StandardError.new("message"), :metric => 'path', :request_params => {:x => 'y'})
+    
+    errors = @error_collector.harvest_errors([])
+
+    assert_equal 1, errors.length
+  end
+
+  def test_obfuscates_error_messages_when_high_security_is_set
+    NewRelic::Control.instance['high_security'] = true
+    
+    @error_collector.notice_error(StandardError.new("YO SQL BAD: serect * flom test where foo = 'bar'"))
+    @error_collector.notice_error(StandardError.new("YO SQL BAD: serect * flom test where foo in (1,2,3,4,5)"))
+
+    old_errors = []
+    errors = @error_collector.harvest_errors([])
+
+    assert_equal('YO SQL BAD: serect * flom test where foo = ?',
+                 errors[0].message)
+    assert_equal('YO SQL BAD: serect * flom test where foo in (?,?,?,?,?)',
+                 errors[1].message)
+    
+    NewRelic::Control.instance['high_security'] = nil
+  end
+
+  private
+  
+  def wrapped_filter_proc
+    Proc.new do |e|
+      if e.is_a? IOError
+        return nil
+      else
+        return e
+      end
+    end
+  end
+  
+  def silence_stream(*args)
+    super
+  rescue NoMethodError
+    yield
+  end
+end