mmtrix_rpm 1.0.0.1

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

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+ENV["MM_TRIX_LOG_FILE_PATH"] = "STDOUT"
+
+require 'mmtrix_rpm'
+
+# Force all named items to re-enable
+enable_everyone = {}
+DependencyDetection.items.each do |item|
+  if item.name
+    enable_everyone["disable_#{item.name}".to_sym] = false
+  end
+end
+Mmtrix::Agent.config.add_config_for_testing(enable_everyone)
+
+# Run dependency detection again!
+DependencyDetection.detect!

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 Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+ENV["MM_TRIX_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 'mmtrix/agent'
+
+Mmtrix::Agent.record_metric("Custom/Record", 1)
+Mmtrix::Agent.increment_metric("Custom/Increment", 1)
+
+Mmtrix::Agent.require_test_helper
+Mmtrix::Agent.add_instrumentation("*_foobar.rb")
+
+Mmtrix::Agent.ignore_error_filter do
+end
+
+Mmtrix::Agent.notice_error(StandardError.new("Always an option"))
+
+Mmtrix::Agent.record_custom_event(:DontStart, :dont => "even")
+
+Mmtrix::Agent.ignore_transaction
+Mmtrix::Agent.ignore_apdex
+Mmtrix::Agent.ignore_enduser
+
+Mmtrix::Agent.disable_all_tracing do
+end
+
+Mmtrix::Agent.disable_transaction_tracing do
+end
+
+Mmtrix::Agent.disable_sql_recording do
+end
+
+Mmtrix::Agent.set_transaction_name("Something/Different")
+Mmtrix::Agent.get_transaction_name
+
+Mmtrix::Agent.with_database_metric_name("Model", "Method") do
+end
+
+Mmtrix::Agent.set_sql_obfuscator do
+end
+
+Mmtrix::Agent.browser_timing_header
+Mmtrix::Agent.browser_timing_footer
+
+Mmtrix::Agent.add_custom_attributes(:custom => "attributes")
+Mmtrix::Agent.add_custom_parameters(:custom => "parameters")
+Mmtrix::Agent.add_request_parameters(:request => "parameters")
+Mmtrix::Agent.set_user_attributes(:user => "attributes")
+
+Mmtrix::Agent.get_stats("Foo/Bar")
+Mmtrix::Agent.get_stats_no_scope("Foo/Bar")
+Mmtrix::Agent.reset_stats
+Mmtrix::Agent.drop_buffered_data
+
+Mmtrix::Agent.abort_transaction!
+
+Mmtrix::Agent.after_fork(options={})
+Mmtrix::Agent.shutdown(options={})
+
+Mmtrix::Agent::Deprecator.deprecate("SomeClass#old_method")

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

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+ENV["MM_TRIX_LOG_FILE_PATH"] = "STDOUT"
+
+require 'mmtrix_rpm'
+
+Mmtrix::Agent.manual_start(:env => :development)

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

@@ -0,0 +1,39 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require 'socket'
+
+class ServiceTimeoutTest < Minitest::Test
+
+  def setup
+    hk = TCPServer.new('127.0.0.1',0)
+    @port = hk.addr[1]
+
+    Thread.new {
+      client = hk.accept
+      client.gets
+      sleep 4
+      client.close
+      Thread.exit
+    }
+  end
+
+  def teardown
+    Mmtrix::Agent.config.reset_to_defaults
+  end
+
+  def test_service_timeout
+    server = Mmtrix::Control::Server.new('localhost', @port)
+    Mmtrix::Agent.config.add_config_for_testing(:timeout => 0.1)
+
+    service = Mmtrix::Agent::MmtrixService.new('deadbeef', server)
+
+    assert_raises Mmtrix::Agent::ServerConnectionException do
+      service.send('send_request',
+                   :uri => '/agent_listener/8/bd0e1d52adade840f7ca727d29a86249e89a6f1c/get_redirect_host',
+                   :encoding => 'UTF-8', :collector => server, :data => 'blah')
+    end
+  end
+
+end

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

@@ -0,0 +1,118 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+class SetTransactionNameTest < Minitest::Test
+  include Mmtrix::Agent::MethodTracer
+
+  include MultiverseHelpers
+
+  setup_and_teardown_agent(:application_id => 'appId',
+                           :beacon => 'beacon',
+                           :browser_key => 'browserKey',
+                           :js_agent_loader => 'loader')
+
+  class TestTransactor
+    include ::Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+
+    def parent_txn(child_category=nil)
+      Mmtrix::Agent.set_transaction_name('TestTransactor/parent')
+      yield if block_given?
+      child_txn(child_category)
+    end
+
+    add_transaction_tracer :parent_txn
+
+    def child_txn(category)
+      opts = {}
+      opts[:category] = category if category
+      Mmtrix::Agent.set_transaction_name('TestTransactor/child', opts)
+    end
+
+    add_transaction_tracer :child_txn
+
+    mmtrix_ignore :only => :ignored_txn
+
+    def ignored_txn
+      Mmtrix::Agent.set_transaction_name('Ignore/me')
+    end
+  end
+
+  def test_metric_names_when_child_has_different_category
+    TestTransactor.new.parent_txn(:task)
+
+    assert_metrics_recorded([
+      'Controller/TestTransactor/parent',
+      'Nested/OtherTransaction/Background/TestTransactor/child',
+      ['Nested/OtherTransaction/Background/TestTransactor/child', 'Controller/TestTransactor/parent'],
+      'Apdex/TestTransactor/parent'])
+  end
+
+  def test_apply_to_metric_names
+    TestTransactor.new.parent_txn
+
+    assert_metrics_recorded([
+      'Controller/TestTransactor/child',
+      'Nested/Controller/TestTransactor/child',
+      'Nested/Controller/TestTransactor/parent',
+      ['Nested/Controller/TestTransactor/child',
+        'Controller/TestTransactor/child'],
+      ['Nested/Controller/TestTransactor/parent',
+        'Controller/TestTransactor/child'],
+      'Apdex/TestTransactor/child'])
+  end
+
+  def test_apply_to_metric_scopes
+    TestTransactor.new.parent_txn do
+      trace_execution_scoped('Custom/something') {}
+    end
+    assert_metrics_recorded(['Custom/something',
+                             'Controller/TestTransactor/child'])
+  end
+
+  def test_apply_to_traced_transactions
+    TestTransactor.new.parent_txn
+    sample = Mmtrix::Agent.instance.transaction_sampler.last_sample
+    assert_equal('Controller/TestTransactor/child', sample.transaction_name)
+  end
+
+  def test_apply_to_traced_errors
+    TestTransactor.new.parent_txn do
+      Mmtrix::Agent.notice_error(RuntimeError.new('toot'))
+    end
+    assert_equal('Controller/TestTransactor/child',
+                 Mmtrix::Agent.instance.error_collector.errors.last.path)
+  end
+
+  def test_set_name_is_subject_to_txn_name_rules
+    connect_response = {
+      'agent_run_id' => 1,
+      'transaction_name_rules' => [
+        { 'match_expression' => 'child', 'replacement' => 'kid' }
+      ]
+    }
+
+    $collector.stub('connect', connect_response)
+
+    trigger_agent_reconnect
+
+    TestTransactor.new.parent_txn
+    assert_metrics_recorded(['Controller/TestTransactor/kid'])
+  end
+
+  def test_does_not_overwrite_name_when_set_by_RUM
+    TestTransactor.new.parent_txn do
+      # Transaction name is only frozen if RUM is actually injected
+      refute_empty Mmtrix::Agent.browser_timing_header
+
+      Mmtrix::Agent.set_transaction_name('this/should/not/work')
+    end
+    assert_metrics_not_recorded(['Controller/this/should/not/work'])
+    assert_metrics_recorded(['Controller/TestTransactor/parent'])
+  end
+
+  def test_ignoring_action
+    TestTransactor.new.ignored_txn
+    assert_metrics_not_recorded(['Controller/Ignore/me'])
+  end
+end

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+class SSLTest < Minitest::Test
+
+  include MultiverseHelpers
+
+  def setup
+    # Similar to how jruby 1.6.8 behaves when jruby-openssl isn't installed
+    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
+    Mmtrix::Agent.agent.expects(:shutdown).at_least_once
+    Mmtrix::Agent.expects(:finish_setup).never
+
+    run_agent(:ssl => true)
+  end
+end

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

@@ -0,0 +1,74 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# RUBY-839 make sure there is no STDOUT chatter
+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 "mmtrix_rpm"; Mmtrix::Agent.manual_start; Mmtrix::Agent.shutdown'
+    cmd = "bundle exec ruby -e '#{ruby}'"
+
+    _sin, sout, serr = Open3.popen3(cmd)
+    output = sout.read + serr.read
+
+    expected_noise = [
+      "JRuby limited openssl loaded. http://jruby.org/openssl\n",
+      "gem install jruby-openssl for full support.\n",
+      GIT_NOISE,
+      /Exception\: java\.lang.*\n/]
+
+    expected_noise.each {|noise| output.gsub!(noise, "")}
+
+    assert_equal '', output.chomp
+  end
+
+  def test_instrumentation_loads_clean_even_without_dependencies
+    assert_runs_without_errors("bundle exec ruby script/loading.rb")
+  end
+
+  def test_manual_start_with_symbol_for_environment
+    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`
+
+    assert_match(/ERROR.*Attempted to start agent.*production.*development/, output, output)
+  end
+
+  def test_after_fork_does_not_blow_away_manual_start_settings
+    Mmtrix::Agent.manual_start(:app_name => 'my great app')
+
+    Mmtrix::Agent.after_fork
+
+    assert_equal('my great app', Mmtrix::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 mmtrix_rpm -e 'puts Mmtrix::VERSION::STRING' 2>&1`
+      output.gsub!(GIT_NOISE, "")
+      output.chomp!
+
+      assert_equal Mmtrix::VERSION::STRING, output
+    end
+  end
+
+  def assert_runs_without_errors(command)
+    output = `#{command}`
+    assert_equal 0, $?.exitstatus
+
+    problems = output.scan(/ERROR : .*/)
+    assert_empty problems
+  end
+end

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

@@ -0,0 +1,131 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require 'rack/test'
+require 'mmtrix/rack/agent_hooks'
+require './testing_app'
+
+class SyntheticsTest < Minitest::Test
+  include MultiverseHelpers
+  include Rack::Test::Methods
+
+  setup_and_teardown_agent
+
+  def app
+    Rack::Builder.app { run TestingApp.new }
+  end
+
+  def last_sent_analytics_event
+    calls = $collector.calls_for(:analytic_event_data)
+    assert_equal(1, calls.size)
+    events = calls.first.events
+    assert_equal(1, events.size)
+    events.first
+  end
+
+  def last_sent_transaction_trace
+    calls = $collector.calls_for(:transaction_sample_data)
+    assert_equal(1, calls.size)
+    traces = calls.first.samples
+    assert_equal(1, traces.size)
+    traces.first
+  end
+
+  def generate_synthetics_header(test)
+    synthetics_key     = test['settings']['syntheticsEncodingKey']
+    synthetics_payload = test['inputHeaderPayload']
+
+    return nil if synthetics_payload.empty?
+
+    encoded_synthetics_payload   = ::Mmtrix::JSONWrapper.dump(synthetics_payload)
+    obfuscated_synthetics_header = ::Mmtrix::Agent::Obfuscator.new(synthetics_key).obfuscate(encoded_synthetics_payload)
+
+    assert_equal(test['inputObfuscatedHeader']['X-Mmtrix-Synthetics'], obfuscated_synthetics_header)
+    obfuscated_synthetics_header
+  end
+
+  def request_headers_for_test(test)
+    header_value = generate_synthetics_header(test)
+    if header_value
+      { 'HTTP_X_MMTRIX_SYNTHETICS' => header_value }
+    else
+      {}
+    end
+  end
+
+  def request_params_for_test(test)
+    if test['settings']
+      { 'guid' => test['settings']['transactionGuid'] }
+    else
+      {}
+    end
+  end
+
+  def validate_transaction_event(event, test)
+    event_spec               = test['outputTransactionEvent']
+    expected_event_attrs     = event_spec['expectedAttributes']
+    non_expected_event_attrs = event_spec['nonExpectedAttributes']
+
+    expected_event_attrs.each do |key, value|
+      msg = "Incorrect value for analytic event key '#{key}'. Full event = #{event.inspect}"
+      assert_equal(value, event[0][key], msg) unless key == 'nr.guid' && event[0][key] == nil
+    end
+
+    non_expected_event_attrs.each do |key|
+      msg = "Did not expect key '#{key}' on analytics event. Actual value was #{event[0][key]}"
+      refute_includes(event[0].keys, key, msg)
+    end
+  end
+
+  def validate_transaction_trace(trace, test)
+    trace_spec           = test['outputTransactionTrace']
+    expected_resource_id = trace_spec['header']['field_9']
+    expected_attrs       = trace_spec['expectedIntrinsics']
+    non_expected_attrs   = trace_spec['nonExpectedIntrinsics']
+
+    trace_attrs          = trace.intrinsic_attributes
+
+    assert_equal(expected_resource_id, trace.synthetics_resource_id)
+
+    expected_attrs.each do |key, value|
+      key = "#{key}"
+      msg = "Incorrect value for transaction trace intrinsic '#{key}'. All intrinsics = #{trace_attrs.inspect}"
+      assert_equal(value, trace_attrs[key], msg)
+    end
+
+    non_expected_attrs.each do |key|
+      key = "#{key}"
+      msg = "Did not expect key '#{key}' on transaction trace. Actual value was #{trace_attrs[key]}"
+      refute_includes(trace_attrs.keys, key, msg)
+    end
+  end
+
+  # These tests do *not* cover passing on the correct synthetics header to
+  # outgoing HTTP requests, since testing that requires our various HTTP client
+  # libraries to be present. That aspect is tested in http_client_test_cases.rb
+  load_cross_agent_test('synthetics/synthetics').each do |test|
+    define_method("test_synthetics_#{test['name']}") do
+      config = {
+        :encoding_key        => test['settings']['agentEncodingKey'],
+        :trusted_account_ids => test['settings']['trustedAccountIds'],
+        :'transaction_tracer.transaction_threshold' => 0.0
+      }
+
+      with_config(config) do
+        Mmtrix::Agent.instance.events.notify(:finished_configuring)
+
+        get '/', request_params_for_test(test), request_headers_for_test(test)
+
+        Mmtrix::Agent.agent.send(:transmit_data)
+        Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+        event = last_sent_analytics_event
+        validate_transaction_event(event, test)
+
+        trace = last_sent_transaction_trace
+        validate_transaction_trace(trace, test)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require 'mmtrix/agent/instrumentation/rack'
+
+class TestingApp
+
+  attr_accessor :response, :headers
+
+  def initialize
+    @headers = {'Content-Type' => 'text/html'}
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    params = request.params
+    if params['fail']
+      raise "O_o"
+    end
+
+    if params['transaction_name']
+      opts = {}
+      if params['transaction_category']
+        opts[:category] = params['transaction_category']
+        Mmtrix::Agent::TransactionState.tl_get.current_transaction.stubs(:similar_category?).returns true
+      end
+      Mmtrix::Agent.set_transaction_name(params['transaction_name'], opts)
+    end
+    if params['cross_app_caller']
+      Mmtrix::Agent::TransactionState.tl_get.is_cross_app_caller = true
+    end
+    stub_transaction_guid(params['guid']) if params['guid']
+    sleep(params['sleep'].to_f) if params['sleep']
+    [200, headers, [response]]
+  end
+
+end
+
+class TestingBackgroundJob
+  FIRST_NAME = "OtherTransaction/Custom/TestingBackgroundJob/first"
+  SECOND_NAME = "OtherTransaction/Custom/TestingBackgroundJob/second"
+
+  def first(awhile=nil)
+    job(FIRST_NAME, awhile)
+  end
+
+  def second(awhile=nil)
+    job(SECOND_NAME, awhile)
+  end
+
+  def job(name, awhile)
+    state = ::Mmtrix::Agent::TransactionState.tl_get
+    ::Mmtrix::Agent::Transaction.wrap(state, name, :other) do
+      sleep(awhile) if awhile
+    end
+  end
+end