newrelic_rpm 6.3.0.355 → 9.2.0

data/test/agent_helper.rb

@@ -1,26 +1,36 @@
-# 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 # These helpers should not have any gem dependencies except on newrelic_rpm
 # itself, and should be usable from within any multiverse suite.
 
 require 'json'
+require 'net/http'
+begin
+  require 'net/http/status'
+rescue LoadError
+  # NOP -- Net::HTTP::STATUS_CODES was introduced in Ruby 2.5
+end
 
 class ArrayLogDevice
-  def initialize( array=[] )
+  def initialize(array = [])
     @array = array
   end
   attr_reader :array
 
-  def write( message )
+  def write(message)
     @array << message
   end
 
   def close; end
 end
 
-def assert_between(floor, ceiling, value, message="expected #{floor} <= #{value} <= #{ceiling}")
+def fake_guid(length = 16)
+  NewRelic::Agent::GuidGenerator.generate_guid(length)
+end
+
+def assert_between(floor, ceiling, value, message = "expected #{floor} <= #{value} <= #{ceiling}")
   assert((floor <= value && value <= ceiling), message)
 end
 
@@ -38,8 +48,8 @@ end
 
 def assert_has_traced_error(error_class)
   errors = harvest_error_traces!
-  assert \
-    errors.find {|e| e.exception_class_name == error_class.name} != nil, \
+
+  refute_nil errors.find { |e| e.exception_class_name == error_class.name }, \
     "Didn't find error of class #{error_class}"
 end
 
@@ -55,6 +65,14 @@ def last_transaction_event
   harvest_transaction_events!.last.last
 end
 
+def harvest_span_events!
+  NewRelic::Agent.instance.span_event_aggregator.harvest!
+end
+
+def last_span_event
+  harvest_span_events!.last.last
+end
+
 def harvest_error_events!
   NewRelic::Agent.instance.error_collector.error_event_aggregator.harvest!
 end
@@ -63,29 +81,25 @@ def last_error_event
   harvest_error_events!.last.last
 end
 
-unless defined?( assert_block )
-  def assert_block(*msgs)
-    assert yield, *msgs
-  end
-end
-
-unless defined?( assert_includes )
-  def assert_includes( collection, member, msg=nil )
+unless defined? assert_includes
+  def assert_includes(collection, member, msg = nil)
     msg = "Expected #{collection.inspect} to include #{member.inspect}"
-    assert_block( msg ) { collection.include?(member) }
+
+    assert_includes collection, member, msg
   end
 end
 
-unless defined?( assert_not_includes )
-  def assert_not_includes( collection, member, msg=nil )
+unless defined? assert_not_includes
+  def assert_not_includes(collection, member, msg = nil)
     msg = "Expected #{collection.inspect} not to include #{member.inspect}"
-    assert !collection.include?(member), msg
+
+    refute_includes collection, member, msg
   end
 end
 
-unless defined?( assert_empty )
-  def assert_empty(collection, msg=nil)
-    assert collection.empty?, msg
+unless defined? assert_empty
+  def assert_empty(collection, msg = nil)
+    assert_empty collection, msg
   end
 end
 
@@ -94,6 +108,13 @@ def assert_equal_unordered(left, right)
   left.each { |element| assert_includes(right, element) }
 end
 
+def assert_log_contains(log, message)
+  lines = log.array
+
+  assert (lines.any? { |line| line.match(message) }),
+    "Could not find message. Log contained: #{lines.join("\n")}"
+end
+
 def assert_audit_log_contains(audit_log_contents, needle)
   # Original request bodies dumped to the log have symbol keys, but once
   # they go through a dump/load, they're strings again, so we strip
@@ -101,7 +122,8 @@ def assert_audit_log_contains(audit_log_contents, needle)
   regex = /[:"]/
   needle = needle.gsub(regex, '')
   haystack = audit_log_contents.gsub(regex, '')
-  assert(haystack.include?(needle), "Expected log to contain '#{needle}'")
+
+  assert_includes(haystack, needle, "Expected log to contain '#{needle}'")
 end
 
 # Because we don't generate a strictly machine-readable representation of
@@ -115,30 +137,33 @@ end
 def assert_audit_log_contains_object(audit_log_contents, o, format = :json)
   case o
   when Hash
-    o.each do |k,v|
+    o.each do |k, v|
       assert_audit_log_contains_object(audit_log_contents, v, format)
       assert_audit_log_contains_object(audit_log_contents, k, format)
     end
   when Array
+
     o.each do |el|
       assert_audit_log_contains_object(audit_log_contents, el, format)
     end
   when NilClass
-    assert_audit_log_contains(audit_log_contents, format == :json ? "null" : "nil")
+
+    assert_audit_log_contains(audit_log_contents, format == :json ? 'null' : 'nil')
   else
     assert_audit_log_contains(audit_log_contents, o.inspect)
   end
 end
 
 def compare_metrics(expected, actual)
-  actual.delete_if {|a| a.include?('GC/Transaction/') }
+  actual.delete_if { |a| a.include?('GC/Transaction/') }
+
   assert_equal(expected.to_a.sort, actual.to_a.sort, "extra: #{(actual - expected).to_a.inspect}; missing: #{(expected - actual).to_a.inspect}")
 end
 
 def metric_spec_from_specish(specish)
   spec = case specish
   when String then NewRelic::MetricSpec.new(specish)
-  when Array  then NewRelic::MetricSpec.new(*specish)
+  when Array then NewRelic::MetricSpec.new(*specish)
   end
   spec
 end
@@ -148,17 +173,17 @@ def _normalize_metric_expectations(expectations)
   when Array
     hash = {}
     # Just assert that the metric is present, nothing about the attributes
-    expectations.each { |k| hash[k] = { } }
+    expectations.each { |k| hash[k] = {} }
     hash
   when String
-    { expectations => {} }
+    {expectations => {}}
   else
     expectations
   end
 end
 
 def dump_stats(stats)
-  str =  "  Call count:           #{stats.call_count}\n"
+  str = +"  Call count:           #{stats.call_count}\n"
   str << "  Total call time:      #{stats.total_call_time}\n"
   str << "  Total exclusive time: #{stats.total_exclusive_time}\n"
   str << "  Min call time:        #{stats.min_call_time}\n"
@@ -173,16 +198,31 @@ end
 def assert_stats_has_values(stats, expected_spec, expected_attrs)
   expected_attrs.each do |attr, expected_value|
     actual_value = stats.send(attr)
+
+    msg = "Expected #{attr} for #{expected_spec} to be #{'~' unless attr == :call_count}#{expected_value}, " \
+          "got #{actual_value}.\nActual stats:\n#{dump_stats(stats)}"
+
     if attr == :call_count
-      assert_equal(expected_value, actual_value,
-        "Expected #{attr} for #{expected_spec} to be #{expected_value}, got #{actual_value}.\nActual stats:\n#{dump_stats(stats)}")
+      assert_stats_has_values_with_call_count(expected_value, actual_value, msg)
     else
-      assert_in_delta(expected_value, actual_value, 0.0001,
-        "Expected #{attr} for #{expected_spec} to be ~#{expected_value}, got #{actual_value}.\nActual stats:\n#{dump_stats(stats)}")
+      assert_in_delta(expected_value, actual_value, 0.0001, msg)
     end
   end
 end
 
+def assert_stats_has_values_with_call_count(expected_value, actual_value, msg)
+  # >, <, >=, <= comparisons
+  if expected_value.to_s =~ /([<>]=?)\s*(\d+)/
+    operator = Regexp.last_match(1).to_sym
+    count = Regexp.last_match(2).to_i
+
+    assert_operator(actual_value, operator, count, msg)
+  # == comparison
+  else
+    assert_equal(expected_value, actual_value, msg)
+  end
+end
+
 def assert_metrics_recorded(expected)
   expected = _normalize_metric_expectations(expected)
   expected.each do |specish, expected_attrs|
@@ -199,6 +239,7 @@ def assert_metrics_recorded(expected)
 
       assert(actual_stats, msg)
     end
+
     assert_stats_has_values(actual_stats, expected_spec, expected_attrs)
   end
 end
@@ -212,10 +253,11 @@ end
 #
 # If you want to *allow* unexpected metrics matching certain patterns, use
 # the :ignore_filter option. This will allow you to specify a Regex that
-# whitelists broad swathes of metric territory (e.g. 'Supportability/').
+# allowlists broad swathes of metric territory (e.g. 'Supportability/').
 #
-def assert_metrics_recorded_exclusive(expected, options={})
+def assert_metrics_recorded_exclusive(expected, options = {})
   expected = _normalize_metric_expectations(expected)
+
   assert_metrics_recorded(expected)
 
   recorded_metrics = NewRelic::Agent.instance.stats_engine.to_h.keys
@@ -227,14 +269,23 @@ def assert_metrics_recorded_exclusive(expected, options={})
     recorded_metrics.reject! { |m| m.name.match(options[:ignore_filter]) }
   end
 
-  expected_metrics   = expected.keys.map { |s| metric_spec_from_specish(s) }
+  expected_metrics = expected.keys.map { |s| metric_spec_from_specish(s) }
 
   unexpected_metrics = recorded_metrics - expected_metrics
-  unexpected_metrics.reject! { |m| m.name =~ /GC\/Transaction/ }
+  unexpected_metrics.reject! { |m| m.name.include?('GC/Transaction') }
 
   assert_equal(0, unexpected_metrics.size, "Found unexpected metrics: #{format_metric_spec_list(unexpected_metrics)}")
 end
 
+def assert_newrelic_metadata_present(metadata)
+  assert metadata.key?('newrelic')
+  refute_nil metadata['newrelic']
+end
+
+def assert_distributed_tracing_payload_created_for_transaction(transaction)
+  assert transaction.distributed_tracer.instance_variable_get(:@distributed_trace_payload_created)
+end
+
 # The clear_metrics! method prevents metrics from "leaking" between tests by resetting
 # the @stats_hash instance variable in the current instance of NewRelic::Agent::StatsEngine.
 
@@ -261,7 +312,8 @@ def assert_metrics_not_recorded(not_expected)
       found_but_not_expected << spec
     end
   end
-  assert_equal([], found_but_not_expected, "Found unexpected metrics: #{format_metric_spec_list(found_but_not_expected)}")
+
+  assert_empty(found_but_not_expected, "Found unexpected metrics: #{format_metric_spec_list(found_but_not_expected)}")
 end
 
 alias :refute_metrics_recorded :assert_metrics_not_recorded
@@ -269,13 +321,12 @@ alias :refute_metrics_recorded :assert_metrics_not_recorded
 def assert_no_metrics_match(regex)
   matching_metrics = []
   NewRelic::Agent.instance.stats_engine.to_h.keys.map(&:to_s).each do |metric|
-    matching_metrics << metric if metric.match regex
+    matching_metrics << metric if metric.match(regex)
   end
 
-  assert_equal(
-    [],
+  assert_empty(
     matching_metrics,
-    "Found unexpected metrics:\n" +  matching_metrics.map { |m| "  '#{m}'"}.join("\n") + "\n\n"
+    "Found unexpected metrics:\n" + matching_metrics.map { |m| "  '#{m}'" }.join("\n") + "\n\n"
   )
 end
 
@@ -290,21 +341,23 @@ end
 
 def assert_truthy(expected, msg = nil)
   msg ||= "Expected #{expected.inspect} to be truthy"
-  assert !!expected, msg
+
+  refute !expected, msg
 end
 
 def assert_falsy(expected, msg = nil)
   msg ||= "Expected #{expected.inspect} to be falsy"
-  assert !expected, msg
+
+  refute expected, msg
 end
 
-unless defined?( assert_false )
+unless defined? assert_false
   def assert_false(expected)
-    assert_equal false, expected
+    refute expected
   end
 end
 
-unless defined?(refute)
+unless defined? refute
   alias refute assert_false
 end
 
@@ -327,39 +380,85 @@ end
 #   in_transaction('foobar', :category => :controller) { ... }
 #
 def in_transaction(*args, &blk)
-  opts     = (args.last && args.last.is_a?(Hash)) ? args.pop : {}
-  category = (opts && opts.delete(:category)) || :other
+  opts = args.last&.is_a?(Hash) ? args.pop : {}
+  category = (opts&.delete(:category)) || :other
 
   # At least one test passes `:transaction_name => nil`, so handle it gently
-  name = opts.key?(:transaction_name) ? opts.delete(:transaction_name) :
-                                        args.first || 'dummy'
+  name = opts.key?(:transaction_name) ? opts.delete(:transaction_name) : args.first || 'dummy'
 
   state = NewRelic::Agent::Tracer.state
   txn = nil
 
   NewRelic::Agent::Tracer.in_transaction(name: name, category: category, options: opts) do
     txn = state.current_transaction
-    yield state.current_transaction
+    yield(state.current_transaction)
   end
 
   txn
 end
 
+# Temporarily disables default transformer so tests with invalid inputs can be tried
+def with_disabled_defaults_transformer(key)
+  begin
+    transformer = NewRelic::Agent::Configuration::DEFAULTS[key][:transform]
+    NewRelic::Agent::Configuration::DEFAULTS[key][:transform] = nil
+    yield
+  ensure
+    NewRelic::Agent::Configuration::DEFAULTS[key][:transform] = transformer
+  end
+end
+
+# Convenience wrapper to stand up a transaction and provide a segment within
+# that transaction to work with.  The same arguments as provided to in_transaction
+# may be supplied.
+def with_segment(*args, &blk)
+  segment = nil
+  txn = in_transaction(*args) do |t|
+    segment = t.current_segment
+    yield(segment, t)
+  end
+  [segment, txn]
+end
+
+# building error attributes on segments are deferred until it's time
+# to publish/harvest them as spans, so for testing, we'll explicitly
+# build 'em as appropriate so we can test 'em
+def build_deferred_error_attributes(segment)
+  return unless segment.noticed_error
+  return if segment.noticed_error_attributes.frozen?
+
+  segment.noticed_error.build_error_attributes
+end
+
+def capture_segment_with_error
+  begin
+    segment_with_error = nil
+    with_segment do |segment|
+      segment_with_error = segment
+      raise 'oops!'
+    end
+  rescue Exception => exception
+    assert segment_with_error, 'expected to have a segment_with_error'
+    build_deferred_error_attributes(segment_with_error)
+    return segment_with_error, exception
+  end
+end
+
 def stub_transaction_guid(guid)
   NewRelic::Agent::Transaction.tl_current.instance_variable_set(:@guid, guid)
 end
 
 # Convenience wrapper around in_transaction that sets the category so that it
 # looks like we are in a web transaction
-def in_web_transaction(name='dummy')
+def in_web_transaction(name = 'dummy')
   in_transaction(name, :category => :controller, :request => stub(:path => '/')) do |txn|
-    yield txn
+    yield(txn)
   end
 end
 
-def in_background_transaction(name='silly')
+def in_background_transaction(name = 'silly')
   in_transaction(name, :category => :task) do |txn|
-    yield txn
+    yield(txn)
   end
 end
 
@@ -371,13 +470,14 @@ end
 
 def last_transaction_trace
   return unless last_sample = NewRelic::Agent.agent.transaction_sampler.last_sample
+
   NewRelic::Agent::Transaction::TraceBuilder.build_trace(last_sample)
 end
 
 def last_transaction_trace_request_params
   agent_attributes = attributes_for(last_transaction_trace, :agent)
   agent_attributes.inject({}) do |memo, (key, value)|
-    memo[key] = value if key.to_s.start_with?("request.parameters.")
+    memo[key] = value if key.to_s.start_with?('request.parameters.')
     memo
   end
 end
@@ -392,7 +492,7 @@ def last_sql_trace
   NewRelic::Agent.agent.sql_sampler.sql_traces.values.last
 end
 
-def find_last_transaction_node(transaction_sample=nil)
+def find_last_transaction_node(transaction_sample = nil)
   if transaction_sample
     root_node = transaction_sample.root_node
   else
@@ -400,7 +500,7 @@ def find_last_transaction_node(transaction_sample=nil)
   end
 
   last_node = nil
-  root_node.each_node {|s| last_node = s }
+  root_node.each_node { |s| last_node = s }
 
   return last_node
 end
@@ -417,7 +517,7 @@ end
 
 def find_node_with_name_matching(transaction_sample, regex)
   transaction_sample.root_node.each_node do |node|
-    if node.metric_name.match regex
+    if node.metric_name.match(regex)
       return node
     end
   end
@@ -431,7 +531,7 @@ def find_all_nodes_with_name_matching(transaction_sample, regexes)
 
   transaction_sample.root_node.each_node do |node|
     regexes.each do |regex|
-      if node.metric_name.match regex
+      if node.metric_name.match(regex)
         matching_nodes << node
       end
     end
@@ -440,7 +540,7 @@ def find_all_nodes_with_name_matching(transaction_sample, regexes)
   matching_nodes
 end
 
-def with_config(config_hash, at_start=true)
+def with_config(config_hash, at_start = true)
   config = NewRelic::Agent::Configuration::DottedHash.new(config_hash, true)
   NewRelic::Agent.config.add_config_for_testing(config, at_start)
   NewRelic::Agent.instance.refresh_attribute_filter
@@ -452,6 +552,13 @@ def with_config(config_hash, at_start=true)
   end
 end
 
+def with_server_source(config_hash, at_start = true)
+  with_config(config_hash, at_start) do
+    NewRelic::Agent.config.notify_server_source_added
+    yield
+  end
+end
+
 def with_config_low_priority(config_hash)
   with_config(config_hash, false) do
     yield
@@ -484,7 +591,7 @@ unless Time.respond_to?(:__original_now)
   end
 end
 
-def nr_freeze_time(now=Time.now)
+def nr_freeze_time(now = Time.now)
   Time.__frozen_now = now
 end
 
@@ -496,7 +603,32 @@ def advance_time(seconds)
   Time.__frozen_now = Time.now + seconds
 end
 
-def with_constant_defined(constant_symbol, implementation=Module.new)
+unless Process.respond_to?(:__original_clock_gettime)
+  Process.instance_eval do
+    class << self
+      attr_accessor :__frozen_clock_gettime
+      alias_method :__original_clock_gettime, :clock_gettime
+
+      def clock_gettime(clock_id, unit = :float_second)
+        __frozen_clock_gettime || __original_clock_gettime(clock_id, unit)
+      end
+    end
+  end
+end
+
+def advance_process_time(seconds, clock_id = Process::CLOCK_REALTIME)
+  Process.__frozen_clock_gettime = Process.clock_gettime(clock_id) + seconds
+end
+
+def nr_freeze_process_time(now = Process.clock_gettime(Process::CLOCK_REALTIME))
+  Process.__frozen_clock_gettime = now
+end
+
+def nr_unfreeze_process_time
+  Process.__frozen_clock_gettime = nil
+end
+
+def with_constant_defined(constant_symbol, implementation = Module.new)
   const_path = constant_path(constant_symbol.to_s)
 
   if const_path
@@ -516,7 +648,7 @@ def with_constant_defined(constant_symbol, implementation=Module.new)
   end
 end
 
-def constant_path(name, opts={})
+def constant_path(name, opts = {})
   allow_partial = opts[:allow_partial]
   path = [Object]
   parts = name.gsub(/^::/, '').split('::')
@@ -524,6 +656,7 @@ def constant_path(name, opts={})
     if !path.last.constants.include?(part.to_sym)
       return allow_partial ? path : nil
     end
+
     path << path.last.const_get(part)
   end
   path
@@ -539,7 +672,8 @@ def undefine_constant(constant_symbol)
   const_str = constant_symbol.to_s
   parent = get_parent(const_str)
   const_name = const_str.gsub(/.*::/, '')
-  return yield unless parent && parent.constants.include?(const_name.to_sym)
+  return yield unless parent&.constants&.include?(const_name.to_sym)
+
   removed_constant = parent.send(:remove_const, const_name)
   yield
 ensure
@@ -550,7 +684,7 @@ def with_debug_logging
   orig_logger = NewRelic::Agent.logger
   $stderr.puts '', '---', ''
   NewRelic::Agent.logger =
-    NewRelic::Agent::AgentLogger.new('', Logger.new($stderr) )
+    NewRelic::Agent::AgentLogger.new('', Logger.new($stderr))
 
   with_config(:log_level => 'debug') do
     yield
@@ -560,17 +694,17 @@ ensure
 end
 
 def create_agent_command(args = {})
-  NewRelic::Agent::Commands::AgentCommand.new([-1, { "name" => "command_name", "arguments" => args}])
+  NewRelic::Agent::Commands::AgentCommand.new([-1, {'name' => 'command_name', 'arguments' => args}])
 end
 
-def wait_for_backtrace_service_poll(opts={})
+def wait_for_backtrace_service_poll(opts = {})
   defaults = {
     :timeout => 10.0,
-    :service => NewRelic::Agent.agent.agent_command_router.backtrace_service,
+    :service => NewRelic::Agent.agent.instance_variable_get(:@agent_command_router).backtrace_service,
     :iterations => 1
   }
   opts = defaults.merge(opts)
-  deadline = Time.now + opts[:timeout]
+  deadline = Process.clock_gettime(Process::CLOCK_REALTIME) + opts[:timeout]
 
   service = opts[:service]
   worker_loop = service.worker_loop
@@ -578,25 +712,25 @@ def wait_for_backtrace_service_poll(opts={})
 
   until worker_loop.iterations > opts[:iterations]
     sleep(0.01)
-    if Time.now > deadline
+    if Process.clock_gettime(Process::CLOCK_REALTIME) > deadline
       raise "Timed out waiting #{opts[:timeout]} s for backtrace service poll\n" +
-            "Worker loop ran for #{opts[:service].worker_loop.iterations} iterations\n\n" +
-            Thread.list.map { |t|
-              "#{t.to_s}: newrelic_label: #{t[:newrelic_label].inspect}\n\n" +
-              (t.backtrace || []).join("\n\t")
-            }.join("\n\n")
+        "Worker loop ran for #{opts[:service].worker_loop.iterations} iterations\n\n" +
+        Thread.list.map { |t|
+          "#{t.to_s}: newrelic_label: #{t[:newrelic_label].inspect}\n\n" +
+            (t.backtrace || []).join("\n\t")
+        }.join("\n\n")
     end
   end
 end
 
-def with_array_logger(level=:info)
+def with_array_logger(level = :info)
   orig_logger = NewRelic::Agent.logger
-  config = { :log_level => level }
+  config = {:log_level => level}
   logdev = ArrayLogDevice.new
   override_logger = Logger.new(logdev)
 
   with_config(config) do
-    NewRelic::Agent.logger = NewRelic::Agent::AgentLogger.new("", override_logger)
+    NewRelic::Agent.logger = NewRelic::Agent::AgentLogger.new('', override_logger)
     yield
   end
 
@@ -605,17 +739,87 @@ ensure
   NewRelic::Agent.logger = orig_logger
 end
 
-def with_environment(env)
-  old_env = {}
-  env.each do |key, val|
-    old_env[key] = ENV[key]
-    ENV[key]     = val.to_s
+# The EnvUpdater was introduced due to random fails in JRuby environment
+# whereby attempting to set ENV[key] = some_value randomly failed.
+# It is conjectured that this is thread related, but may also be
+# a core bug in the JVM implementation of Ruby.  Root cause was not
+# discovered, but it was found that a combination of retrying and using
+# mutex lock around the update operation was the only consistently working
+# solution as the error continued to surface without the mutex and
+# retry alone wasn't enough, either.
+#
+# JRUBY: oraclejdk8 + jruby-9.2.6.0
+#
+# NOTE: Singleton pattern to ensure one mutex lock for all threads
+class EnvUpdater
+  MAX_RETRIES = 5
+
+  def initialize
+    @mutex = Mutex.new
   end
-  begin
+
+  # Will attempt the given block up to MAX_RETRIES before
+  # surfacing the exception down the chain.
+  def with_retry(retry_limit = MAX_RETRIES)
+    retries ||= 0
+    sleep(retries)
     yield
-  ensure
-    old_env.each { |key, old_val| ENV[key] = old_val }
+  rescue
+    (retries += 1) < retry_limit ? retry : raise
+  end
+
+  # Locks and updates the ENV
+  def safe_update(env)
+    with_retry do
+      @mutex.synchronize do
+        env.each { |key, val| ENV[key] = val.to_s }
+      end
+    end
+  end
+
+  # Locks and restores the ENV
+  def safe_restore(old_env)
+    with_retry do
+      @mutex.synchronize do
+        old_env.each { |key, val| val ? ENV[key] = val : ENV.delete(key) }
+      end
+    end
+  end
+
+  # Singleton pattern implemented via @@instance
+  def self.instance
+    @@instance ||= EnvUpdater.new
+  end
+
+  def self.safe_update(env)
+    instance.safe_update(env)
   end
+
+  def self.safe_restore(old_env)
+    instance.safe_restore(old_env)
+  end
+
+  # Effectively saves current ENV settings for given env's key/values,
+  # runs given block, then restores ENV to original state before returning.
+  def self.inject(env, &block)
+    old_env = {}
+    env.each { |key, val| old_env[key] = ENV[key] }
+    begin
+      safe_update(env)
+      yield
+    ensure
+      safe_restore(old_env)
+    end
+  end
+
+  # must call instance here to ensure only one @mutex for all threads.
+  instance
+end
+
+# Changes ENV settings to given and runs given block and restores ENV
+# to original values before returning.
+def with_environment(env, &block)
+  EnvUpdater.inject(env) { yield }
 end
 
 def with_argv(argv)
@@ -641,7 +845,7 @@ ensure
 end
 
 def json_dump_and_encode(object)
-  Base64.encode64(::JSON.dump(object))
+  Base64.encode64(JSON.dump(object))
 end
 
 def get_last_analytics_event
@@ -667,15 +871,15 @@ def load_cross_agent_test(name)
   test_file_path = File.join(cross_agent_tests_dir, "#{name}.json")
   data = File.read(test_file_path)
   data.gsub!('callCount', 'call_count')
-  data = ::JSON.load(data)
-  data.each { |testcase| testcase['testname'].gsub! ' ', '_' if String === testcase['testname'] }
+  data = JSON.load(data)
+  data.each { |testcase| testcase['testname'].tr!(' ', '_') if String === testcase['testname'] }
   data
 end
 
 def each_cross_agent_test(options)
-  options = {:dir => nil, :pattern => "*"}.update(options)
-  path = File.join [cross_agent_tests_dir, options[:dir], options[:pattern]].compact
-  Dir.glob(path).each { |file| yield file}
+  options = {:dir => nil, :pattern => '*'}.update(options)
+  path = File.join([cross_agent_tests_dir, options[:dir], options[:pattern]].compact)
+  Dir.glob(path).each { |file| yield(file) }
 end
 
 def assert_event_attributes(event, test_name, expected_attributes, non_expected_attributes)
@@ -688,7 +892,7 @@ def assert_event_attributes(event, test_name, expected_attributes, non_expected_
     incorrect_attributes << name unless actual_value == expected_value
   end
 
-  msg = "Found missing or incorrect attribute values in #{test_name}:\n"
+  msg = +"Found missing or incorrect attribute values in #{test_name}:\n"
 
   incorrect_attributes.each do |name|
     msg << "  #{name}: expected = #{expected_attributes[name].inspect}, actual = #{event_attrs[name].inspect}\n"
@@ -699,13 +903,125 @@ def assert_event_attributes(event, test_name, expected_attributes, non_expected_
   event_attrs.each do |name, actual_value|
     msg << "  #{name}: #{actual_value.inspect}\n"
   end
-  assert(incorrect_attributes.empty?, msg)
+
+  assert_empty(incorrect_attributes, msg)
 
   non_expected_attributes.each do |name|
-    assert_nil(event_attrs[name], "Found value '#{event_attrs[name]}' for attribute '#{name}', but expected nothing in #{test_name}")
+    refute event_attrs[name], "Found value '#{event_attrs[name]}' for attribute '#{name}', but expected nothing in #{test_name}"
   end
 end
 
 def attributes_for(sample, type)
   sample.attributes.instance_variable_get("@#{type}_attributes")
 end
+
+def uncache_trusted_account_key
+  NewRelic::Agent::Transaction::TraceContext::AccountHelpers.instance_variable_set(:@trace_state_entry_key, nil)
+end
+
+def reset_buffers_and_caches
+  NewRelic::Agent.drop_buffered_data
+  uncache_trusted_account_key
+end
+
+def message_for_status_code(code)
+  # Net::HTTP::STATUS_CODES was introduced in Ruby 2.5
+  if defined?(Net::HTTP::STATUS_CODES)
+    return Net::HTTP::STATUS_CODES[code]
+  end
+
+  case code
+  when 200 then 'OK'
+  when 404 then 'Not Found'
+  when 403 then 'Forbidden'
+  else 'Unknown'
+  end
+end
+
+# wraps the given headers in a Net::HTTPResponse which has accompanying
+# http status code associated with it.
+# a "status_code" may be passed in the headers to alter the HTTP Status Code
+# that is wrapped in the response.
+def mock_http_response(headers, wrap_it = true)
+  status_code = (headers.delete('status_code') || 200).to_i
+  net_http_resp = Net::HTTPResponse.new(1.0, status_code, message_for_status_code(status_code))
+  headers.each do |key, value|
+    net_http_resp.add_field(key.to_s, value)
+  end
+  return net_http_resp unless wrap_it
+
+  NewRelic::Agent::HTTPClients::NetHTTPResponse.new(net_http_resp)
+end
+
+# +expected+ can be a string or regular expression
+def assert_match_or_equal(expected, value)
+  if expected.is_a?(Regexp)
+    assert_match expected, value
+  else
+    assert_equal expected, value
+  end
+end
+
+# selects the last segment with a noticed_error and checks
+# the expectations against it.
+def assert_segment_noticed_error(txn, segment_name, error_classes, error_message)
+  error_segment = txn.segments.reverse.detect { |s| s.noticed_error }
+
+  assert error_segment, 'Expected at least one segment with a noticed_error'
+
+  assert_match_or_equal segment_name, error_segment.name
+
+  noticed_error = error_segment.noticed_error
+
+  assert_match_or_equal error_classes, noticed_error.exception_class_name
+  assert_match_or_equal error_message, noticed_error.message
+end
+
+def assert_transaction_noticed_error(txn, error_classes)
+  refute_empty txn.exceptions, 'Expected transaction to notice the error'
+  assert_match_or_equal error_classes, txn.exceptions.keys.first.class.name
+end
+
+def refute_transaction_noticed_error(txn, error_class)
+  error_segment = txn.segments.reverse.detect { |s| s.noticed_error }
+
+  assert error_segment, 'Expected at least one segment with a noticed_error'
+  assert_empty txn.exceptions, 'Expected transaction to NOT notice any segment errors'
+end
+
+def refute_raises(*exp)
+  msg = "#{exp.pop}.\n" if String === exp.last
+
+  begin
+    yield
+  rescue MiniTest::Skip => e
+    puts "SKIP REPORTS: #{e.inspect}"
+    return e if exp.include?(MiniTest::Skip)
+
+    raise e
+  rescue Exception => e
+    puts "EXCEPTION RAISED: #{e.inspect}\n#{e.backtrace}"
+    exp = exp.first if exp.size == 1
+
+    flunk(msg || "unexpected exception raised: #{e}")
+  end
+end
+
+def assert_implements(instance, method, *args)
+  fail_message = "expected #{instance.class}##{method} method to be implemented"
+  refute_raises NotImplementedError, fail_message do
+    instance.send(method, *args)
+  end
+end
+
+def defer_testing_to_min_supported_rails(test_file, min_rails_version, supports_jruby = true)
+  if defined?(Rails) &&
+      defined?(Rails::VERSION::STRING) &&
+      (Rails::VERSION::STRING.to_f >= min_rails_version) &&
+      (supports_jruby || !NewRelic::LanguageSupport.jruby?)
+
+    yield
+  else
+    puts "Skipping tests in #{File.basename(test_file)} because Rails >= #{min_rails_version} is unavailable" if ENV['VERBOSE_TEST_OUTPUT']
+  end
+end