newrelic_rpm 3.12.0.288 → 3.12.1.298

data/test/multiverse/suites/agent_only/config/newrelic.yml

@@ -10,7 +10,7 @@ development:
   app_name: test
   host: 127.0.0.1
   api_host: 127.0.0.1
-  port: <%= $collector && $collector.port %>
+  port: <%= $collector ||= nil; $collector && $collector.port %>
   transaction_tracer:
     record_sql: obfuscated
     enabled: true

data/test/multiverse/suites/agent_only/script/public_api_when_disabled.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+ENV["NEW_RELIC_LOG_FILE_PATH"] = "STDOUT"
+
+# This file tries to require the minimum amount of the agent, and then call
+# public API methods on it to ensure that they don't raise exceptions. It is
+# expected to be called from a driver test which will check for failure in the
+# status code and/or output.
+
+require 'new_relic/agent'
+
+NewRelic::Agent.record_metric("Custom/Record", 1)
+NewRelic::Agent.increment_metric("Custom/Increment", 1)
+
+NewRelic::Agent.require_test_helper
+NewRelic::Agent.add_instrumentation("*_foobar.rb")
+
+NewRelic::Agent.ignore_error_filter do
+end
+
+NewRelic::Agent.notice_error(StandardError.new("Always an option"))
+
+NewRelic::Agent.record_custom_event(:DontStart, :dont => "even")
+
+NewRelic::Agent.ignore_transaction
+NewRelic::Agent.ignore_apdex
+NewRelic::Agent.ignore_enduser
+
+NewRelic::Agent.disable_all_tracing do
+end
+
+NewRelic::Agent.disable_transaction_tracing do
+end
+
+NewRelic::Agent.disable_sql_recording do
+end
+
+NewRelic::Agent.set_transaction_name("Something/Different")
+NewRelic::Agent.get_transaction_name
+
+NewRelic::Agent.with_database_metric_name("Model", "Method") do
+end
+
+NewRelic::Agent.set_sql_obfuscator do
+end
+
+NewRelic::Agent.browser_timing_header
+NewRelic::Agent.browser_timing_footer
+
+NewRelic::Agent.add_custom_attributes(:custom => "attributes")
+NewRelic::Agent.add_custom_parameters(:custom => "parameters")
+NewRelic::Agent.add_request_parameters(:request => "parameters")
+NewRelic::Agent.set_user_attributes(:user => "attributes")
+
+NewRelic::Agent.get_stats("Foo/Bar")
+NewRelic::Agent.get_stats_no_scope("Foo/Bar")
+NewRelic::Agent.reset_stats
+NewRelic::Agent.drop_buffered_data
+
+NewRelic::Agent.abort_transaction!
+
+NewRelic::Agent.after_fork(options={})
+NewRelic::Agent.shutdown(options={})
+
+NewRelic::Agent::Deprecator.deprecate("SomeClass#old_method")

data/test/multiverse/suites/agent_only/service_timeout_test.rb

@@ -24,7 +24,7 @@ class ServiceTimeoutTest < Minitest::Test
   end
 
   def test_service_timeout
-    server = NewRelic::Control::Server.new('localhost',@port,'127.0.0.1')
+    server = NewRelic::Control::Server.new('localhost', @port)
     NewRelic::Agent.config.add_config_for_testing(:timeout => 0.1)
 
     service = NewRelic::Agent::NewRelicService.new('deadbeef', server)

data/test/multiverse/suites/agent_only/ssl_test.rb

@@ -8,7 +8,8 @@ class SSLTest < Minitest::Test
 
   def setup
     # Similar to how jruby 1.6.8 behaves when jruby-openssl isn't installed
-    Net::HTTPSession.any_instance.stubs('use_ssl=').raises(LoadError)
+    Net::HTTPSession.any_instance.stubs('use_ssl=').with(true).raises(LoadError)
+    Net::HTTPSession.any_instance.stubs('use_ssl=').with(false).returns(nil)
   end
 
   def test_agent_shuts_down_when_ssl_is_on_but_unavailable

data/test/multiverse/suites/agent_only/start_up_test.rb

@@ -6,6 +6,8 @@
 require 'open3'
 
 class StartUpTest < Minitest::Test
+  GIT_NOISE = "fatal: Not a git repository (or any of the parent directories): .git\n"
+
   def test_should_not_print_to_stdout_when_logging_available
     ruby = 'require "newrelic_rpm"; NewRelic::Agent.manual_start; NewRelic::Agent.shutdown'
     cmd = "bundle exec ruby -e '#{ruby}'"
@@ -16,7 +18,7 @@ class StartUpTest < Minitest::Test
     expected_noise = [
       "JRuby limited openssl loaded. http://jruby.org/openssl\n",
       "gem install jruby-openssl for full support.\n",
-      "fatal: Not a git repository (or any of the parent directories): .git\n",
+      GIT_NOISE,
       /Exception\: java\.lang.*\n/]
 
     expected_noise.each {|noise| output.gsub!(noise, "")}
@@ -32,6 +34,10 @@ class StartUpTest < Minitest::Test
     assert_runs_without_errors("bundle exec ruby script/symbol_env.rb")
   end
 
+  def test_can_call_public_api_methods_when_agent_disabled
+    assert_runs_without_errors("bundle exec ruby script/public_api_when_disabled.rb")
+  end
+
   def test_manual_start_logs_about_mismatched_environment
     output = `bundle exec ruby script/env_change.rb`
 
@@ -46,8 +52,21 @@ class StartUpTest < Minitest::Test
     assert_equal('my great app', NewRelic::Agent.config[:app_name])
   end
 
+  # Older rubies have a lot of warnings that we don't care much about. Track it
+  # going forward from Ruby 2.1.
+  if RUBY_VERSION >= "2.1"
+    def test_no_warnings
+      output = `bundle exec ruby -w -r bundler/setup -r newrelic_rpm -e 'puts NewRelic::VERSION::STRING' 2>&1`
+      output.gsub!(GIT_NOISE, "")
+      output.chomp!
+
+      assert_equal NewRelic::VERSION::STRING, output
+    end
+  end
+
   def assert_runs_without_errors(command)
     output = `#{command}`
+    assert_equal 0, $?.exitstatus
 
     problems = output.scan(/ERROR : .*/)
     assert_empty problems

data/test/multiverse/suites/agent_only/utilization_data_collection_test.rb

@@ -8,124 +8,63 @@ require 'fake_instance_metadata_service'
 class UtilizationDataCollectionTest < Minitest::Test
   include MultiverseHelpers
 
-  setup_and_teardown_agent do
-    $collector.stub('connect',
-      {
-        "agent_run_id" => 42,
-        "collect_utilization" => true
+  def test_sends_all_utilization_data_on_connect
+    expected = {
+      "hostname" => "host",
+      "metadata_version" => 1,
+      "logical_processors" => 5,
+      "total_ram_mib" => 128,
+      "vendors" => {
+        "aws" => {
+          "id" => "i-e7e85ce1",
+          "type" => "m3.medium",
+          "zone" => "us-west-2b"
+        },
+        "docker" => {
+          "id"=>"47cbd16b77c50cbf71401"
+        }
       }
-    )
-  end
-
-  def test_hostname
-    NewRelic::Agent::Hostname.stubs(:get).returns("hostile")
-    trigger_usage_data_collection_and_submission
-
-    data = last_submitted_utilization_data
-    assert_equal("hostile", data.hostname)
-  end
-
-  def test_gathers_instance_metadata
-    instance_type = 'test.type'
-
-    with_fake_metadata_service do |service|
-      service.set_response_for_path('/2008-02-01/meta-data/instance-type', instance_type)
-      trigger_usage_data_collection_and_submission
-    end
-
-    data = last_submitted_utilization_data
-    assert_equal(instance_type, data.instance_type)
-  end
+    }
 
-  def test_omits_instance_metadata_if_contains_invalid_characters
-    instance_type = '<script>lol</script>'
+    NewRelic::Agent::Hostname.stubs(:get).returns("host")
+    NewRelic::Agent::SystemInfo.stubs(:docker_container_id).returns("47cbd16b77c50cbf71401")
+    NewRelic::Agent::SystemInfo.stubs(:num_logical_processors).returns(5)
+    NewRelic::Agent::SystemInfo.stubs(:ram_in_mib).returns(128)
 
     with_fake_metadata_service do |service|
-      service.set_response_for_path('/2008-02-01/meta-data/instance-type', instance_type)
-      trigger_usage_data_collection_and_submission
-    end
+      service.set_response_for_path('/2008-02-01/meta-data/instance-id', expected["vendors"]["aws"]["id"])
+      service.set_response_for_path('/2008-02-01/meta-data/instance-type', expected["vendors"]["aws"]["type"])
+      service.set_response_for_path('/2008-02-01/meta-data/placement/availability-zone', expected["vendors"]["aws"]["zone"])
 
-    data = last_submitted_utilization_data
-    assert_nil(data.instance_type)
-  end
+      # this will trigger the agent to connect and send utilization data
+      setup_agent
 
-  def test_omits_instance_metadata_if_too_long
-    instance_type = 'a' * 1024
-
-    with_fake_metadata_service do |service|
-      service.set_response_for_path('/2008-02-01/meta-data/instance-type', instance_type)
-      trigger_usage_data_collection_and_submission
+      assert_equal expected, single_connect_posted.utilization
     end
-
-    data = last_submitted_utilization_data
-    assert_nil(data.instance_type)
-  end
-
-  def test_gathers_cpu_metadata
-    fake_processor_info = { :num_logical_processors => 8 }
-    NewRelic::Agent::SystemInfo.stubs(:get_processor_info).returns(fake_processor_info)
-
-    trigger_usage_data_collection_and_submission
-
-    data = last_submitted_utilization_data
-    assert_equal(fake_processor_info[:num_logical_processors], data.cpu_count)
-  end
-
-  def test_nil_cpu_values_reported
-    fake_processor_info = { :num_logical_processors => nil }
-    NewRelic::Agent::SystemInfo.stubs(:get_processor_info).returns(fake_processor_info)
-
-    trigger_usage_data_collection_and_submission
-
-    data = last_submitted_utilization_data
-    assert_nil(data.cpu_count)
-  end
-
-  def test_gathers_docker_container_id
-    NewRelic::Agent::SystemInfo.stubs(:docker_container_id).returns("whale")
-
-    trigger_usage_data_collection_and_submission
-
-    data = last_submitted_utilization_data
-    assert_equal "whale", data.container_id
   end
 
-  def test_nil_docker_container_id
-    NewRelic::Agent::SystemInfo.stubs(:docker_container_id).returns(nil)
-
-    trigger_usage_data_collection_and_submission
-
-    data = last_submitted_utilization_data
-    assert_nil data.container_id
-  end
-
-  def test_retries_upon_failure_to_submit_usage_data
-    $collector.stub_exception('utilization_data', nil, 503).once
-
-    trigger_usage_data_collection_and_submission
-    first_attempt = last_submitted_utilization_data
-
-    $collector.reset
-
-    trigger_usage_data_collection_and_submission
-    next_attempt = last_submitted_utilization_data
-
-    assert_equal(first_attempt, next_attempt)
-  end
+  def test_omits_sending_vendor_data_on_connect_when_not_available
+     expected = {
+      "hostname" => "host",
+      "metadata_version" => 1,
+      "logical_processors" => 5,
+      "total_ram_mib" => 128
+    }
 
-  def last_submitted_utilization_data
-    submissions = $collector.calls_for(:utilization_data)
-    assert_equal(1, submissions.size)
+    NewRelic::Agent::Hostname.stubs(:get).returns("host")
+    NewRelic::Agent::SystemInfo.stubs(:num_logical_processors).returns(5)
+    NewRelic::Agent::SystemInfo.stubs(:ram_in_mib).returns(128)
 
-    data = submissions.last
-    assert_equal(4, data.body.size)
+    # this will trigger the agent to connect and send utilization data
+    setup_agent
 
-    data
+    assert_equal expected, single_connect_posted.utilization
   end
 
-  def trigger_usage_data_collection_and_submission
-    if NewRelic::Agent.config[:collect_utilization]
-      agent.send(:transmit_utilization_data)
+  def test_utilization_data_not_sent_when_disabled
+    with_config :disable_utilization => true do
+      setup_agent
+      assert_nil single_connect_posted.utilization, "Expected utilization data to be nil"
     end
   end
 

data/test/multiverse/suites/bare/standalone_instrumentation_test.rb

@@ -4,11 +4,11 @@
 
 # This test is based on the example code at:
 # https://docs.newrelic.com/docs/ruby/ruby-custom-metric-collection#example_class
-# 
+#
 # See https://newrelic.atlassian.net/browse/RUBY-1116 for details on how this
 # was broken previously.
 
-require 'new_relic/agent/method_tracer' 
+require 'new_relic/agent/method_tracer'
 
 class StandaloneInstrumentationTest < Minitest::Test
   class InstrumentedClass

data/test/multiverse/suites/high_security/high_security_test.rb

@@ -165,7 +165,7 @@ class HighSecurityTest < Minitest::Test
 
     run_harvest
 
-    expected = { "httpResponseCode" => 200 }
+    expected = { "httpResponseCode" => "200" }
     assert_equal expected, single_transaction_trace_posted.agent_attributes
   end
 
@@ -179,7 +179,7 @@ class HighSecurityTest < Minitest::Test
 
     run_harvest
 
-    expected = { "httpResponseCode" => 500 }
+    expected = { "httpResponseCode" => "500" }
     assert_equal expected, single_error_posted.agent_attributes
   end
 

data/test/multiverse/suites/rack/http_response_code_test.rb

@@ -27,22 +27,22 @@ class HttpResponseCodeTest < Minitest::Test
   def test_records_http_response_code_on_analytics_events
     rsp = get '/', { 'override-response-code' => 404 }
     assert_equal(404, rsp.status)
-    assert_equal('404', get_last_analytics_event[0]['httpResponseCode'])
+    assert_equal("404", get_last_analytics_event[2][:httpResponseCode])
 
     rsp = get '/', { 'override-response-code' => 302 }
     assert_equal(302, rsp.status)
-    assert_equal('302', get_last_analytics_event[0]['httpResponseCode'])
+    assert_equal("302", get_last_analytics_event[2][:httpResponseCode])
   end
 
   def test_skips_http_response_code_if_middleware_tracing_disabled
     with_config(:disable_middleware_instrumentation => true) do
       rsp = get '/', { 'override-response-code' => 404 }
       assert_equal(404, rsp.status)
-      assert_nil get_last_analytics_event[0]['httpResponseCode']
+      assert_nil get_last_analytics_event[2][:httpResponseCode]
 
       rsp = get '/', { 'override-response-code' => 302 }
       assert_equal(302, rsp.status)
-      assert_nil get_last_analytics_event[0]['httpResponseCode']
+      assert_nil get_last_analytics_event[2][:httpResponseCode]
     end
   end
 end

data/test/multiverse/suites/rails/error_tracing_test.rb

@@ -117,7 +117,7 @@ class ErrorsWithoutSSCTest < RailsMultiverseTest
 
       expected_params = {
         'request.parameters.eat' => 'static',
-        'httpResponseCode' => 500
+        'httpResponseCode' => '500'
       }
 
       attributes = agent_attributes_for_single_error_posted

data/test/multiverse/suites/sidekiq/sidekiq_instrumentation_test.rb

@@ -122,6 +122,30 @@ class SidekiqTest < Minitest::Test
     assert_attributes_on_events
   end
 
+  def test_captures_errors_from_job
+    TestWorker.fail = true
+    run_jobs
+    assert_error_for_each_job
+  ensure
+    TestWorker.fail = false
+  end
+
+  # In <= 2.x of Sidekiq, internal errors (or potentially errors further out
+  # the middleware stack) wouldn't get noticed, but there was no propery hook
+  # to catch it. 3.x+ gives us a error_handler, so only add our misbehaving
+  # middleware for those cases.
+  if Sidekiq::VERSION >= '3'
+    def test_captures_sidekiq_internal_errors
+      # Ugly, but need to coerce an internal error in Sidekiq that doesn't bail
+      # from processing entirely. This fouls up Sidekiq::Processor#stats in a
+      # spot that calls handle exception but doesn't die.
+      Redis.any_instance.stubs(:hmset).raises("Uh oh")
+      run_jobs
+
+      assert_error_for_each_job(nil)
+    end
+  end
+
   def assert_metric_and_call_count(name, expected_call_count)
     metric_data = $collector.calls_for('metric_data')
     assert_equal(1, metric_data.size, "expected exactly one metric_data post from agent")
@@ -178,4 +202,18 @@ class SidekiqTest < Minitest::Test
       end
     end
   end
+
+  def assert_error_for_each_job(txn_name=TRANSACTION_NAME)
+    error_posts = $collector.calls_for("error_data")
+    assert_equal 1, error_posts.length, "Wrong number of error posts!"
+
+    errors = error_posts.first
+    assert_equal JOB_COUNT, errors.errors.length, "Wrong number of errors noticed!"
+
+    assert_metric_and_call_count('Errors/all', JOB_COUNT)
+    if txn_name
+      assert_metric_and_call_count('Errors/allOther', JOB_COUNT)
+      assert_metric_and_call_count("Errors/#{TRANSACTION_NAME}", JOB_COUNT)
+    end
+  end
 end

data/test/multiverse/suites/sidekiq/test_worker.rb

@@ -53,7 +53,19 @@ class TestWorker
     end
   end
 
+  def self.fail=(val)
+    @fail = val
+  end
+
+  def self.am_i_a_failure?
+    @fail
+  end
+
   def perform(key, val)
-    TestWorker.record(key, val)
+    if self.class.am_i_a_failure?
+      raise "Uh oh"
+    else
+      TestWorker.record(key, val)
+    end
   end
 end