mmtrix_rpm 1.0.0.1

data/test/multiverse/suites/delayed_job/delayed_job_sampler_test.rb

@@ -0,0 +1,128 @@
+# 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/delayed_job_injection'
+
+if Mmtrix::Agent::Samplers::DelayedJobSampler.supported_backend?
+  class DelayedJobSamplerTest < Minitest::Test
+    include MultiverseHelpers
+
+    TestWorker = Struct.new(:name, :read_ahead)
+
+    setup_and_teardown_agent do
+      Mmtrix::DelayedJobInjection.worker_name = "delayed"
+      @worker = TestWorker.new("delayed", 1)
+      @sampler = Mmtrix::Agent::Samplers::DelayedJobSampler.new
+    end
+
+    def after_teardown
+      # This appears in the base delayed_job gem even after the adapter split
+      # so it appears to be safe to call across adapters
+      Delayed::Job.delete_all
+    end
+
+    class IWantToWait
+      def take_action
+      end
+    end
+
+    def test_cant_create_without_injection
+      Mmtrix::DelayedJobInjection.worker_name = nil
+      assert_raises(Mmtrix::Agent::Sampler::Unsupported) do
+        Mmtrix::Agent::Samplers::DelayedJobSampler.new
+      end
+    end
+
+    def test_sampler_no_failures_or_locks
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/failed_jobs"      => { :total_call_time => 0 },
+        "Workers/DelayedJob/locked_jobs"      => { :total_call_time => 0 })
+    end
+
+    def test_sampler_sees_failures
+      job = IWantToWait.new.delay.take_action
+
+      return unless job.respond_to?(:fail!)
+      job.fail!
+
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/failed_jobs" => { :total_call_time => 1 })
+    end
+
+    def test_sampler_sees_locks
+      IWantToWait.new.delay.take_action
+      ::Delayed::Job.reserve(@worker)
+
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/locked_jobs" => { :total_call_time => 1 })
+    end
+
+    def test_sampler_queue_depth_with_job
+      IWantToWait.new.delay.take_action
+
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/queue_length/priority/0" => { :total_call_time => 1 },
+        "Workers/DelayedJob/queue_length/all"        => { :total_call_time => 1 })
+    end
+
+    def test_sampler_queue_depth_with_alternate_priority
+      IWantToWait.new.delay(:priority => 7).take_action
+
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/queue_length/priority/7" => { :total_call_time => 1 },
+        "Workers/DelayedJob/queue_length/all"        => { :total_call_time => 1 })
+    end
+
+    def test_sampler_queue_depth_with_default_queue
+      return unless Delayed::Job.instance_methods.include?(:queue)
+
+      IWantToWait.new.delay.take_action
+
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/queue_length/name/default" => { :total_call_time => 1 },
+        "Workers/DelayedJob/queue_length/all"          => { :total_call_time => 1 })
+    end
+
+    def test_sampler_queue_depth_with_alternate_queues
+      return unless Delayed::Job.instance_methods.include?(:queue)
+
+      IWantToWait.new.delay(:queue => "cue").take_action
+      IWantToWait.new.delay(:queue => "cute").take_action
+
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/queue_length/name/cue"   => { :total_call_time => 1 },
+        "Workers/DelayedJob/queue_length/name/cute"  => { :total_call_time => 1 },
+        "Workers/DelayedJob/queue_length/all"        => { :total_call_time => 2 })
+    end
+
+    def test_sampler_queue_depth_with_queues_and_priorities
+      return unless Delayed::Job.instance_methods.include?(:queue)
+
+      IWantToWait.new.delay(:priority => 1, :queue => "cue").take_action
+      IWantToWait.new.delay(:priority => 1, :queue => "cute").take_action
+
+      @sampler.poll
+
+      assert_metrics_recorded(
+        "Workers/DelayedJob/queue_length/name/cue"   => { :total_call_time => 1 },
+        "Workers/DelayedJob/queue_length/name/cute"  => { :total_call_time => 1 },
+        "Workers/DelayedJob/queue_length/priority/1" => { :total_call_time => 2 },
+        "Workers/DelayedJob/queue_length/all"        => { :total_call_time => 2 })
+    end
+  end
+end

data/test/multiverse/suites/delayed_job/unsupported_backend_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.
+
+require 'mmtrix/delayed_job_injection'
+
+if !Mmtrix::Agent::Samplers::DelayedJobSampler.supported_backend?
+  class UnsupportedBackendTest < Minitest::Test
+    include MultiverseHelpers
+
+    setup_and_teardown_agent do
+      Mmtrix::DelayedJobInjection.worker_name = "delayed"
+    end
+
+    def test_unsupported_raises_on_instantiation
+      assert_raises(Mmtrix::Agent::Sampler::Unsupported) do
+        Mmtrix::Agent::Samplers::DelayedJobSampler.new
+      end
+    end
+  end
+end

data/test/multiverse/suites/excon/Envfile

@@ -0,0 +1,21 @@
+if RUBY_VERSION >= '2.2.0'
+  excon_versions = %w(0.45.3)
+else
+  excon_versions = %w(0.45.3
+                      0.25.0
+                      0.24.0
+                      0.19.0
+                      0.18.0
+                      0.10.0)
+end
+
+# Excon 0.10.0 doesn't seem to work on Rubinius 2.2.10
+excon_versions.delete("0.10.0") if defined?(RUBY_ENGINE) && RUBY_ENGINE == "rbx"
+
+excon_versions.each do |excon_version|
+  gemfile <<-RB
+    gem 'excon', '~> #{excon_version}'
+    gem 'rack'
+    gem 'json', :platforms => [:rbx, :mri_18]
+  RB
+end

data/test/multiverse/suites/excon/config/mmtrix.yml

@@ -0,0 +1,18 @@
+---
+development:
+  error_collector:
+    enabled: true
+  apdex_t: 0.5
+  ssl: false
+  monitor_mode: true
+  license_key: bootstrap_mmtrix_admin_license_key_000
+  developer_mode: false
+  app_name: test
+  host: 127.0.0.1
+  api_host: 127.0.0.1
+  transaction_tracer:
+    record_sql: obfuscated
+    enabled: true
+    stack_trace_threshold: 0.5
+    transaction_threshold: 1.0
+  capture_params: false

data/test/multiverse/suites/excon/excon_test.rb

@@ -0,0 +1,81 @@
+# 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 "excon"
+require "mmtrix_rpm"
+require "http_client_test_cases"
+
+class ExconTest < Minitest::Test
+  include HttpClientTestCases
+
+  def client_name
+    "Excon"
+  end
+
+  def get_response(url=nil, headers=nil)
+    Excon.get(url || default_url, :headers => (headers || {}))
+  end
+
+  def get_response_multi(url, n)
+    responses = []
+    conn = Excon.new(url)
+    n.times { responses << conn.get }
+    conn.reset
+    responses
+  end
+
+  def head_response
+    Excon.head(default_url)
+  end
+
+  def post_response
+    Excon.post(default_url, :body => "")
+  end
+
+  def put_response
+    Excon.put(default_url, :body => "")
+  end
+
+  def delete_response
+    Excon.delete(default_url)
+  end
+
+  def request_instance
+    Mmtrix::Agent::HTTPClients::ExconHTTPRequest.new({:headers => ""})
+  end
+
+  def response_instance(headers = {})
+    Mmtrix::Agent::HTTPClients::ExconHTTPResponse.new(Excon::Response.new(:headers => headers))
+  end
+
+  def test_still_records_tt_node_when_request_fails_with_idempotent_set
+    target_url = "#{default_url}/idempotent_test"
+
+    in_transaction do
+      conn = Excon.new("#{target_url}?status=404")
+      assert_raises(Excon::Errors::NotFound) do
+        conn.get(:expects => 200, :idempotent => true)
+      end
+    end
+
+    tt = Mmtrix::Agent.agent.transaction_sampler.last_sample
+    node = tt.root_node.called_nodes.first.called_nodes.first
+    assert_equal("External/localhost/Excon/GET", node.metric_name)
+    assert_equal(target_url, node.params[:uri])
+  end
+
+  def test_still_records_tt_node_when_request_expects_different_response_code
+    in_transaction do
+      conn = Excon.new("#{default_url}?status=500")
+      begin
+        conn.request(:method => :get, :expects => [200])
+      rescue Excon::Errors::Error
+        # meh
+      end
+
+      last_node = find_last_transaction_node()
+      assert_equal("External/localhost/Excon/GET", last_node.metric_name)
+    end
+  end
+end

data/test/multiverse/suites/grape/Envfile

@@ -0,0 +1,13 @@
+suite_condition("Grape is only supported for versions >= 1.9.3") do
+  RUBY_VERSION >= '1.9.3'
+end
+
+versions = %w(0.9.0 0.8.0 0.7.0 0.6.1 0.5.0 0.4.1 0.3.2 0.2.6 0.2.0 0.1.5)
+
+versions.each do |version|
+  gemfile <<-RB
+    gem 'rack'
+    gem 'rack-test'
+    gem 'grape', '~> #{version}'
+  RB
+end

data/test/multiverse/suites/grape/config/mmtrix.yml

@@ -0,0 +1,19 @@
+---
+development:
+  error_collector:
+    enabled: true
+  apdex_t: 0.5
+  ssl: false
+  monitor_mode: true
+  license_key: bootstrap_mmtrix_admin_license_key_000
+  developer_mode: false
+  app_name: test
+  host: 127.0.0.1
+  api_host: 127.0.0.1
+  port: <%= $collector && $collector.port %>
+  transaction_tracer:
+    record_sql: obfuscated
+    enabled: true
+    stack_trace_threshold: 0.5
+    transaction_threshold: 1.0
+  capture_params: false

data/test/multiverse/suites/grape/grape_test.rb

@@ -0,0 +1,202 @@
+# 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 "grape"
+require "mmtrix_rpm"
+require './grape_test_api'
+
+class GrapeTest < Minitest::Test
+  include Rack::Test::Methods
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  unless ::Grape::VERSION == '0.1.5'
+    def app
+      Rack::Builder.app { run GrapeTestApi.new }
+    end
+
+    def test_nonexistent_route
+      get '/not_grape_ape'
+      assert_no_metrics_match(/grape_ape/)
+    end
+
+    def test_route_raises_an_error
+      assert_raises(GrapeTestApiError) do
+        get '/self_destruct'
+      end
+
+      expected_txn_name = 'Controller/Grape/GrapeTestApi/self_destruct (GET)'
+      assert_grape_metrics(expected_txn_name)
+      assert_metrics_recorded(["Errors/#{expected_txn_name}"])
+    end
+
+    def test_getting_a_list_of_grape_apes
+      get '/grape_ape'
+      assert_grape_metrics('Controller/Grape/GrapeTestApi/grape_ape (GET)')
+    end
+
+    def test_showing_a_grape_ape
+      get '/grape_ape/1'
+      assert_grape_metrics('Controller/Grape/GrapeTestApi/grape_ape/:id (GET)')
+    end
+
+    def test_creating_a_grape_ape
+      post '/grape_ape', {}
+      assert_grape_metrics('Controller/Grape/GrapeTestApi/grape_ape (POST)')
+    end
+
+    def test_updating_a_grape_ape
+      put '/grape_ape/1', {}
+      assert_grape_metrics('Controller/Grape/GrapeTestApi/grape_ape/:id (PUT)')
+    end
+
+    def test_deleting_a_grape_ape
+      delete '/grape_ape/1'
+      assert_grape_metrics('Controller/Grape/GrapeTestApi/grape_ape/:id (DELETE)')
+    end
+
+    def test_transaction_renaming
+      get '/grape_ape/renamed'
+      # The second node here is 'Rack' because of an idiosyncrasy of
+      # the set_transaction_name API: when you call set_transaction_name and
+      # don't provide an explicit category, you lock in the category prefix
+      # that was in use at the time you made the call.
+      #
+      # We may change this behavior in the future, once we have a better
+      # internal representation of the name and category of a transaction as
+      # truly separate entities.
+      #
+      assert_grape_metrics('Controller/Rack/RenamedTxn')
+    end
+
+    def test_params_are_not_captured_with_capture_params_disabled
+      with_config(:capture_params => false) do
+        get '/grape_ape/10'
+
+        expected = {}
+        assert_equal expected, last_transaction_trace_request_params
+      end
+    end
+
+    def test_route_params_are_captured
+      with_config(:capture_params => true) do
+        get '/grape_ape/10'
+
+        expected = {
+          "request.parameters.id" => "10"
+        }
+        assert_equal expected, last_transaction_trace_request_params
+      end
+    end
+
+    def test_query_params_are_captured
+      with_config(:capture_params => true) do
+        get '/grape_ape?q=1234&foo=bar'
+
+        expected = {
+          'request.parameters.q' => '1234',
+          'request.parameters.foo' => 'bar'
+        }
+        assert_equal expected, last_transaction_trace_request_params
+      end
+    end
+
+    def test_post_body_params_are_captured
+      with_config(:capture_params => true) do
+        post '/grape_ape', {'q' => '1234', 'foo' => 'bar'}.to_json, "CONTENT_TYPE" => "application/json"
+
+        expected = {
+          'request.parameters.q' => '1234',
+          'request.parameters.foo' => 'bar'
+        }
+        assert_equal expected, last_transaction_trace_request_params
+      end
+    end
+
+    def test_post_body_params_are_captured_with_error
+      with_config(:capture_params => true) do
+        assert_raises(GrapeTestApiError) do
+          post '/grape_ape_fail', {'q' => '1234', 'foo' => 'fail'}.to_json, "CONTENT_TYPE" => "application/json"
+        end
+
+        agent_attributes = attributes_for(last_traced_error, :agent)
+        assert_equal('1234', agent_attributes['request.parameters.q'])
+        assert_equal('fail', agent_attributes['request.parameters.foo'])
+      end
+    end
+
+    def test_post_body_params_are_captured_with_rescue_from
+      with_config(:capture_params => true) do
+        post '/grape_ape_fail_rescue', {'q' => '1234', 'foo' => 'fail'}.to_json, "CONTENT_TYPE" => "application/json"
+
+        agent_attributes = attributes_for(last_traced_error, :agent)
+        assert_equal('1234', agent_attributes['request.parameters.q'])
+        assert_equal('fail', agent_attributes['request.parameters.foo'])
+      end
+    end
+
+    def test_post_body_with_nested_params_are_captured
+      with_config(:capture_params => true) do
+        params = {"ape" => {"first_name" => "koko", "last_name" => "gorilla"}}
+        post '/grape_ape', params.to_json, "CONTENT_TYPE" => "application/json"
+
+        expected = {
+          "request.parameters.ape.first_name" => "koko",
+          "request.parameters.ape.last_name" => "gorilla"
+        }
+        assert_equal expected, last_transaction_trace_request_params
+      end
+    end
+
+    def test_file_upload_params_are_filtered
+      with_config(:capture_params => true) do
+        params = {
+          :title => "blah",
+          :file => Rack::Test::UploadedFile.new(__FILE__, 'text/plain')
+        }
+        post '/grape_ape', params
+
+        expected = {
+          "request.parameters.title" => "blah",
+          "request.parameters.file" => "[FILE]"
+        }
+        assert_equal expected, last_transaction_trace_request_params
+      end
+    end
+
+    def test_404_with_params_does_not_capture_them
+      with_config(:capture_params => true) do
+        post '/grape_catfish', {"foo" => "bar"}
+        expected = {}
+        assert_equal expected, last_transaction_trace_request_params
+      end
+    end
+
+    def test_params_are_captured_on_transaction_events
+      with_config(:'attributes.include' => 'request.parameters.*') do
+        json = {
+          :foo => "bar",
+          :bar => "baz"
+        }.to_json
+
+        post '/grape_ape', json, {"CONTENT_TYPE" => "application/json"}
+
+        expected = {"request.parameters.foo" => "bar", "request.parameters.bar" => "baz"}
+        actual = agent_attributes_for_single_event_posted_without_ignored_attributes
+
+        assert_equal(expected, actual)
+      end
+    end
+
+    def assert_grape_metrics(expected_txn_name)
+      expected_node_name = 'Middleware/Grape/GrapeTestApi/call'
+      assert_metrics_recorded([
+        expected_node_name,
+        [expected_node_name, expected_txn_name],
+        expected_txn_name
+      ])
+    end
+  end
+end

data/test/multiverse/suites/grape/grape_test_api.rb

@@ -0,0 +1,64 @@
+# 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 'grape'
+
+class GrapeTestApiError < StandardError; end
+class GrapeTestApi < Grape::API
+  # namespace, group, resource, and resources all do the same thing.
+  # They are aliases for namespace.
+
+  get :self_destruct do
+    raise GrapeTestApiError.new("I'm sorry Dave, I'm afraid I can't do that.")
+  end
+
+  namespace :grape_ape do
+    get do
+      'List grape apes!'
+    end
+
+    get 'renamed' do
+      ::Mmtrix::Agent.set_transaction_name("RenamedTxn")
+      'Totally renamed it.'
+    end
+
+    get ':id' do
+      'Show grape ape!'
+    end
+  end
+
+  resource :grape_ape do
+    post do
+      'Create grape ape!'
+    end
+  end
+
+  resources :grape_ape do
+    put ':id' do
+      'Update grape ape!'
+    end
+  end
+
+  group :grape_ape do
+    delete ':id' do
+      'Destroy grape ape!'
+    end
+  end
+
+  resource :grape_ape_fail do
+    post do
+      raise GrapeTestApiError.new("I'm sorry Dave, I'm afraid I can't do that.")
+    end
+  end
+
+  resource :grape_ape_fail_rescue do
+    rescue_from :all do |e|
+      error_response({ message: "rescued from #{e.class.name}" })
+    end
+
+    post do
+      raise GrapeTestApiError.new("I'm sorry Dave, I'm afraid I can't do that.")
+    end
+  end
+end

data/test/multiverse/suites/grape/grape_versioning_test.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix"s license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+unless ::Grape::VERSION == '0.1.5'
+  require './grape_versioning_test_api'
+
+  class GrapeVersioningTest < Minitest::Test
+    include Rack::Test::Methods
+    include MultiverseHelpers
+
+    setup_and_teardown_agent
+
+    def app
+      clazz = @app_class
+      Rack::Builder.app { run clazz.new }
+    end
+
+    def test_version_from_path_is_recorded_in_transaction_name
+      @app_class = GrapeVersioning::ApiV1
+      get '/v1/fish'
+      assert_metrics_recorded('Controller/Grape/GrapeVersioning::ApiV1-v1/fish (GET)')
+    end
+
+    def test_version_is_stripped_when_requesting_root_route
+      @app_class = GrapeVersioning::ApiV1
+      get '/v1'
+      assert_metrics_recorded('Controller/Grape/GrapeVersioning::ApiV1-v1/ (GET)')
+    end
+
+    def test_version_is_stripped_when_requesting_root_route_with_trailing_slash
+      @app_class = GrapeVersioning::ApiV1
+      get '/v1/'
+      assert_metrics_recorded('Controller/Grape/GrapeVersioning::ApiV1-v1/ (GET)')
+    end
+
+    def test_version_from_param_version_is_recorded_in_transaction_name
+      @app_class = GrapeVersioning::ApiV2
+      get '/fish?apiver=v2'
+      assert_metrics_recorded('Controller/Grape/GrapeVersioning::ApiV2-v2/fish (GET)')
+    end
+
+    def test_version_from_header_is_recorded_in_transaction_name
+      @app_class = GrapeVersioning::ApiV3
+      get '/fish', {}, 'HTTP_ACCEPT' => 'application/vnd.mmtrix-v3+json'
+      assert_metrics_recorded('Controller/Grape/GrapeVersioning::ApiV3-v3/fish (GET)')
+    end
+
+    #version from http accept header is not supported in older versions of grape
+    if Mmtrix::VersionNumber.new(Grape::VERSION) >= Mmtrix::VersionNumber.new('4.0.0')
+      def test_version_from_accept_version_header_is_recorded_in_transaction_name
+        @app_class = GrapeVersioning::ApiV4
+        get '/fish', {}, 'HTTP_ACCEPT_VERSION' => 'v4'
+        assert_metrics_recorded('Controller/Grape/GrapeVersioning::ApiV4-v4/fish (GET)')
+      end
+    end
+
+    def test_app_not_using_versioning_does_not_record_version_in_transaction_name
+      @app_class = GrapeVersioning::Unversioned
+      get '/fish'
+      assert_metrics_recorded('Controller/Grape/GrapeVersioning::Unversioned/fish (GET)')
+    end
+  end
+end