mmtrix_rpm 1.0.0.1

data/test/agent_helper.rb

@@ -0,0 +1,666 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# These helpers should not have any gem dependencies except on mmtrix_rpm
+# itself, and should be usable from within any multiverse suite.
+
+class ArrayLogDevice
+  def initialize( array=[] )
+    @array = array
+  end
+  attr_reader :array
+
+  def write( message )
+    @array << message
+  end
+
+  def close; end
+end
+
+def assert_between(floor, ceiling, value, message="expected #{floor} <= #{value} <= #{ceiling}")
+  assert((floor <= value && value <= ceiling), message)
+end
+
+def assert_in_delta(expected, actual, delta)
+  assert_between((expected - delta), (expected + delta), actual)
+end
+
+def assert_has_error(error_class)
+  assert \
+    Mmtrix::Agent.instance.error_collector.errors.find {|e| e.exception_class_name == error_class.name} != nil, \
+    "Didn't find error of class #{error_class}"
+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 )
+    msg = "Expected #{collection.inspect} to include #{member.inspect}"
+    assert_block( msg ) { collection.include?(member) }
+  end
+end
+
+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
+  end
+end
+
+unless defined?( assert_empty )
+  def assert_empty(collection, msg=nil)
+    assert collection.empty?, msg
+  end
+end
+
+def assert_equal_unordered(left, right)
+  assert_equal(left.length, right.length, "Lengths don't match. #{left.length} != #{right.length}")
+  left.each { |element| assert_includes(right, element) }
+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
+  # double-quotes and colons from the log, and the strings we searching for.
+  regex = /[:"]/
+  needle = needle.gsub(regex, '')
+  haystack = audit_log_contents.gsub(regex, '')
+  assert(haystack.include?(needle), "Expected log to contain '#{needle}'")
+end
+
+# Because we don't generate a strictly machine-readable representation of
+# request bodies for the audit log, the transformation into strings is
+# effectively one-way. This, combined with the fact that Hash traversal order
+# is arbitrary in Ruby 1.8.x means that it's difficult to directly assert that
+# some object graph made it into the audit log (due to different possible
+# orderings of the key/value pairs in Hashes that were embedded in the request
+# body). So, this method traverses an object graph and only makes assertions
+# about the terminal (non-Array-or-Hash) nodes therein.
+def assert_audit_log_contains_object(audit_log_contents, o, format)
+  case o
+  when Hash
+    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")
+  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/') }
+  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 Mmtrix::MetricSpec.new(specish)
+  when Array  then Mmtrix::MetricSpec.new(*specish)
+  end
+  spec
+end
+
+def _normalize_metric_expectations(expectations)
+  case expectations
+  when Array
+    hash = {}
+    # Just assert that the metric is present, nothing about the attributes
+    expectations.each { |k| hash[k] = { } }
+    hash
+  when String
+    { expectations => {} }
+  else
+    expectations
+  end
+end
+
+def dump_stats(stats)
+  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"
+  str << "  Max call time:        #{stats.max_call_time}\n"
+  str << "  Sum of squares:       #{stats.sum_of_squares}\n"
+  str << "  Apdex S:              #{stats.apdex_s}\n"
+  str << "  Apdex T:              #{stats.apdex_t}\n"
+  str << "  Apdex F:              #{stats.apdex_f}\n"
+  str
+end
+
+def assert_stats_has_values(stats, expected_spec, expected_attrs)
+  expected_attrs.each do |attr, expected_value|
+    actual_value = stats.send(attr)
+    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)}")
+    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)}")
+    end
+  end
+end
+
+def assert_metrics_recorded(expected)
+  expected = _normalize_metric_expectations(expected)
+  expected.each do |specish, expected_attrs|
+    expected_spec = metric_spec_from_specish(specish)
+    actual_stats = Mmtrix::Agent.instance.stats_engine.to_h[expected_spec]
+    if !actual_stats
+      all_specs = Mmtrix::Agent.instance.stats_engine.to_h.keys.sort
+      matches = all_specs.select { |spec| spec.name == expected_spec.name }
+      matches.map! { |m| "  #{m.inspect}" }
+
+      msg = "Did not find stats for spec #{expected_spec.inspect}."
+      msg += "\nDid find specs: [\n#{matches.join(",\n")}\n]" unless matches.empty?
+      msg += "\nAll specs in there were: #{format_metric_spec_list(all_specs)}"
+
+      assert(actual_stats, msg)
+    end
+    assert_stats_has_values(actual_stats, expected_spec, expected_attrs)
+  end
+end
+
+# Use this to assert that *only* the given set of metrics has been recorded.
+#
+# If you want to scope the search for unexpected metrics to a particular
+# namespace (e.g. metrics matching 'Controller/'), pass a Regex for the
+# :filter option. Only metrics matching the regex will be searched when looking
+# for unexpected metrics.
+#
+# 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/').
+#
+def assert_metrics_recorded_exclusive(expected, options={})
+  expected = _normalize_metric_expectations(expected)
+  assert_metrics_recorded(expected)
+
+  recorded_metrics = Mmtrix::Agent.instance.stats_engine.to_h.keys
+
+  if options[:filter]
+    recorded_metrics = recorded_metrics.select { |m| m.name.match(options[:filter]) }
+  end
+  if options[:ignore_filter]
+    recorded_metrics.reject! { |m| m.name.match(options[:ignore_filter]) }
+  end
+
+  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/ }
+
+  assert_equal(0, unexpected_metrics.size, "Found unexpected metrics: #{format_metric_spec_list(unexpected_metrics)}")
+end
+
+def assert_metrics_not_recorded(not_expected)
+  not_expected = _normalize_metric_expectations(not_expected)
+  found_but_not_expected = []
+  not_expected.each do |specish, _|
+    spec = metric_spec_from_specish(specish)
+    if Mmtrix::Agent.instance.stats_engine.to_h[spec]
+      found_but_not_expected << spec
+    end
+  end
+  assert_equal([], found_but_not_expected, "Found unexpected metrics: #{format_metric_spec_list(found_but_not_expected)}")
+end
+
+alias :refute_metrics_recorded :assert_metrics_not_recorded
+
+def assert_no_metrics_match(regex)
+  matching_metrics = []
+  Mmtrix::Agent.instance.stats_engine.to_h.keys.map(&:to_s).each do |metric|
+    matching_metrics << metric if metric.match regex
+  end
+
+  assert_equal(
+    [],
+    matching_metrics,
+    "Found unexpected metrics:\n" +  matching_metrics.map { |m| "  '#{m}'"}.join("\n") + "\n\n"
+  )
+end
+
+alias :refute_metrics_match :assert_no_metrics_match
+
+def format_metric_spec_list(specs)
+  spec_strings = specs.map do |spec|
+    "#{spec.name} (#{spec.scope.empty? ? '<unscoped>' : spec.scope})"
+  end
+  "[\n  #{spec_strings.join(",\n  ")}\n]"
+end
+
+def assert_truthy(expected, msg = nil)
+  msg ||= "Expected #{expected.inspect} to be truthy"
+  assert !!expected, msg
+end
+
+def assert_falsy(expected, msg = nil)
+  msg ||= "Expected #{expected.inspect} to be falsy"
+  assert !expected, msg
+end
+
+unless defined?( assert_false )
+  def assert_false(expected)
+    assert_equal false, expected
+  end
+end
+
+unless defined?(refute)
+  alias refute assert_false
+end
+
+# Mock up a transaction for testing purposes, optionally specifying a name and
+# transaction category. The given block will be executed within the context of the
+# dummy transaction.
+#
+# Examples:
+#
+# With default name ('dummy') and category (:other):
+#   in_transaction { ... }
+#
+# With an explicit transaction name and default category:
+#   in_transaction('foobar') { ... }
+#
+# With default name and explicit category:
+#   in_transaction(:category => :controller) { ... }
+#
+# With a transaction name plus category:
+#   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
+
+  # At least one test passes `:transaction_name => nil`, so handle it gently
+  name = opts.key?(:transaction_name) ? opts.delete(:transaction_name) :
+                                        args.first || 'dummy'
+
+  state = Mmtrix::Agent::TransactionState.tl_get
+  txn = nil
+
+  Mmtrix::Agent::Transaction.wrap(state, name, category, opts) do
+    txn = state.current_transaction
+    yield state.current_transaction
+  end
+
+  txn
+end
+
+def stub_transaction_guid(guid)
+  Mmtrix::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')
+  in_transaction(name, :category => :controller, :request => stub(:path => '/')) do |txn|
+    yield txn
+  end
+end
+
+def in_background_transaction(name='silly')
+  in_transaction(name, :category => :task) do |txn|
+    yield txn
+  end
+end
+
+def refute_contains_request_params(attributes)
+  attributes.keys.each do |key|
+    refute_match /^request\.parameters\./, key.to_s
+  end
+end
+
+def last_traced_error
+  Mmtrix::Agent.agent.error_collector.errors.last
+end
+
+def last_transaction_trace
+  Mmtrix::Agent.agent.transaction_sampler.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
+  end
+end
+
+def find_sql_trace(metric_name)
+  Mmtrix::Agent.agent.sql_sampler.sql_traces.values.detect do |trace|
+    trace.database_metric_name == metric_name
+  end
+end
+
+def last_sql_trace
+  Mmtrix::Agent.agent.sql_sampler.sql_traces.values.last
+end
+
+def find_last_transaction_node(transaction_sample=nil)
+  if transaction_sample
+    root_node = transaction_sample.root_node
+  else
+    builder = Mmtrix::Agent.agent.transaction_sampler.tl_builder
+    root_node = builder.current_node
+  end
+
+  last_node = nil
+  root_node.each_node {|s| last_node = s }
+
+  return last_node
+end
+
+def find_node_with_name(transaction_sample, name)
+  transaction_sample.root_node.each_node do |node|
+    if node.metric_name == name
+      return node
+    end
+  end
+
+  nil
+end
+
+def find_node_with_name_matching(transaction_sample, regex)
+  transaction_sample.root_node.each_node do |node|
+    if node.metric_name.match regex
+      return node
+    end
+  end
+
+  nil
+end
+
+def find_all_nodes_with_name_matching(transaction_sample, regexes)
+  regexes = [regexes].flatten
+  matching_nodes = []
+
+  transaction_sample.root_node.each_node do |node|
+    regexes.each do |regex|
+      if node.metric_name.match regex
+        matching_nodes << node
+      end
+    end
+  end
+
+  matching_nodes
+end
+
+def with_config(config_hash, at_start=true)
+  config = Mmtrix::Agent::Configuration::DottedHash.new(config_hash, true)
+  Mmtrix::Agent.config.add_config_for_testing(config, at_start)
+  Mmtrix::Agent.instance.refresh_attribute_filter
+  begin
+    yield
+  ensure
+    Mmtrix::Agent.config.remove_config(config)
+    Mmtrix::Agent.instance.refresh_attribute_filter
+  end
+end
+
+def with_config_low_priority(config_hash)
+  with_config(config_hash, false) do
+    yield
+  end
+end
+
+def with_transaction_renaming_rules(rule_specs)
+  original_engine = Mmtrix::Agent.agent.instance_variable_get(:@transaction_rules)
+  begin
+    new_engine = Mmtrix::Agent::RulesEngine.create_transaction_rules('transaction_name_rules' => rule_specs)
+    Mmtrix::Agent.agent.instance_variable_set(:@transaction_rules, new_engine)
+    yield
+  ensure
+    Mmtrix::Agent.agent.instance_variable_set(:@transaction_rules, original_engine)
+  end
+end
+
+# Need to guard against double-installing this patch because in 1.8.x the same
+# file can be required multiple times under different non-canonicalized paths.
+unless Time.respond_to?(:__original_now)
+  Time.instance_eval do
+    class << self
+      attr_accessor :__frozen_now
+      alias_method :__original_now, :now
+
+      def now
+        __frozen_now || __original_now
+      end
+    end
+  end
+end
+
+def freeze_time(now=Time.now)
+  Time.__frozen_now = now
+end
+
+def unfreeze_time
+  Time.__frozen_now = nil
+end
+
+def advance_time(seconds)
+  freeze_time(Time.now + seconds)
+end
+
+def with_constant_defined(constant_symbol, implementation=Module.new)
+  const_path = constant_path(constant_symbol.to_s)
+
+  if const_path
+    # Constant is already defined, nothing to do
+    return yield
+  else
+    const_path = constant_path(constant_symbol.to_s, :allow_partial => true)
+    parent = const_path[-1]
+    constant_symbol = constant_symbol.to_s.split('::').last.to_sym
+  end
+
+  begin
+    parent.const_set(constant_symbol, implementation)
+    yield
+  ensure
+    parent.send(:remove_const, constant_symbol)
+  end
+end
+
+def constant_path(name, opts={})
+  allow_partial = opts[:allow_partial]
+  path = [Object]
+  parts = name.gsub(/^::/, '').split('::')
+  parts.each do |part|
+    if !path.last.const_defined?(part)
+      return allow_partial ? path : nil
+    end
+    path << path.last.const_get(part)
+  end
+  path
+end
+
+def undefine_constant(constant_symbol)
+  const_path = constant_path(constant_symbol.to_s)
+  return yield unless const_path
+  parent = const_path[-2]
+  const_name = constant_symbol.to_s.gsub(/.*::/, '')
+  removed_constant = parent.send(:remove_const, const_name)
+  yield
+ensure
+  parent.const_set(const_name, removed_constant) if removed_constant
+end
+
+def with_debug_logging
+  orig_logger = Mmtrix::Agent.logger
+  $stderr.puts '', '---', ''
+  Mmtrix::Agent.logger =
+    Mmtrix::Agent::AgentLogger.new('', Logger.new($stderr) )
+
+  with_config(:log_level => 'debug') do
+    yield
+  end
+ensure
+  Mmtrix::Agent.logger = orig_logger
+end
+
+def create_agent_command(args = {})
+  Mmtrix::Agent::Commands::AgentCommand.new([-1, { "name" => "command_name", "arguments" => args}])
+end
+
+def wait_for_backtrace_service_poll(opts={})
+  defaults = {
+    :timeout => 10.0,
+    :service => Mmtrix::Agent.agent.agent_command_router.backtrace_service,
+    :iterations => 1
+  }
+  opts = defaults.merge(opts)
+  deadline = Time.now + opts[:timeout]
+
+  service = opts[:service]
+  worker_loop = service.worker_loop
+  worker_loop.setup(0, service.method(:poll))
+
+  until worker_loop.iterations > opts[:iterations]
+    sleep(0.01)
+    if Time.now > 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}: mmtrix_label: #{t[:mmtrix_label].inspect}\n\n" +
+              (t.backtrace || []).join("\n\t")
+            }.join("\n\n")
+    end
+  end
+end
+
+def with_array_logger(level=:info)
+  orig_logger = Mmtrix::Agent.logger
+  config = { :log_level => level }
+  logdev = ArrayLogDevice.new
+  override_logger = Logger.new(logdev)
+
+  with_config(config) do
+    Mmtrix::Agent.logger = Mmtrix::Agent::AgentLogger.new("", override_logger)
+    yield
+  end
+
+  return logdev
+ensure
+  Mmtrix::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
+  end
+  begin
+    yield
+  ensure
+    old_env.each { |key, old_val| ENV[key] = old_val }
+  end
+end
+
+def with_argv(argv)
+  old_argv = ARGV.dup
+  ARGV.clear
+  ARGV.concat(argv)
+
+  begin
+    yield
+  ensure
+    ARGV.clear
+    ARGV.concat(old_argv)
+  end
+end
+
+def with_ignore_error_filter(filter, &blk)
+  original_filter = Mmtrix::Agent.ignore_error_filter
+  Mmtrix::Agent.ignore_error_filter(&filter)
+
+  yield
+ensure
+  Mmtrix::Agent::ErrorCollector.ignore_error_filter = original_filter
+end
+
+def json_dump_and_encode(object)
+  Base64.encode64(Mmtrix::JSONWrapper.dump(object))
+end
+
+def get_last_analytics_event
+  Mmtrix::Agent.agent.instance_variable_get(:@transaction_event_aggregator).samples.last
+end
+
+def swap_instance_method(target, method_name, new_method_implementation, &blk)
+  old_method_implementation = target.instance_method(method_name)
+  target.send(:define_method, method_name, new_method_implementation)
+  yield
+rescue NameError => e
+  puts "Your target does not have the instance method #{method_name}"
+  puts e.inspect
+ensure
+  target.send(:define_method, method_name, old_method_implementation)
+end
+
+def cross_agent_tests_dir
+  File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'cross_agent_tests'))
+end
+
+def replace_camelcase(contents)
+  { "callCount" => "call_count" }.each_pair do |original, replacement|
+    contents.gsub!(original, replacement)
+  end
+  contents
+end
+
+def load_cross_agent_test(name)
+  test_file_path = File.join(cross_agent_tests_dir, "#{name}.json")
+  data = File.read(test_file_path)
+  data = replace_camelcase(data)
+  Mmtrix::JSONWrapper.load(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}
+end
+
+def assert_event_attributes(event, test_name, expected_attributes, non_expected_attributes)
+  incorrect_attributes = []
+
+  event_attrs = event[0]
+
+  expected_attributes.each do |name, expected_value|
+    actual_value = event_attrs[name]
+    incorrect_attributes << name unless actual_value == expected_value
+  end
+
+  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"
+  end
+  msg << "\n"
+
+  msg << "All event values:\n"
+  event_attrs.each do |name, actual_value|
+    msg << "  #{name}: #{actual_value.inspect}\n"
+  end
+  assert(incorrect_attributes.empty?, 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}")
+  end
+end
+
+def attributes_for(sample, type)
+  sample.attributes.instance_variable_get("@#{type}_attributes")
+end

data/test/config/mmtrix.yml

@@ -0,0 +1,46 @@
+# This is the config file loaded when running unit tests locally.
+common: &default_settings
+  transaction_tracer:
+    enabled: true
+    record_sql: raw
+
+test:
+  <<: *default_settings
+  host: localhost
+  port: 3000
+  log_level: info
+  agent_enabled: false
+  monitor_mode: false
+  developer_mode: true
+  disable_samplers: true
+  api_host: 127.0.0.1
+  api_port: 443
+  message: '<%= generated_for_user %>'
+  license_key: '<%= license_key %>'
+  agent_enabled: auto
+  apdex_t: 1.1
+  app_name:
+    - a
+    - b
+    - c
+
+  # Some fixtures for mmtrix.yml parsing tests
+  erb_value: <%= 'hey'*3 %>
+  tval: true
+  tstring: 'true'
+  fval: false
+  yval: yes
+  sval: sure
+
+  transaction_tracer:
+    record_sql: raw
+    transaction_threshold: Apdex_f # case insensitive
+    explain_threshold: 0.1
+    explain_enabled: true
+    stack_trace_threshold: 0.1
+
+  error_collector:
+    enabled: true
+
+development:
+  host: the.wrong.host