mmtrix_rpm 1.0.0.1

data/test/multiverse/suites/rails/rails3_app/app_rails3_plus.rb

@@ -0,0 +1,92 @@
+# 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 'action_controller/railtie'
+require 'active_model'
+require 'rails/test_help'
+require 'filtering_test_app'
+
+# We define our single Rails application here, one time, upon the first inclusion
+# Tests should feel free to define their own Controllers locally, but if they
+# need anything special at the Application level, put it here
+if !defined?(MyApp)
+
+  ENV['MM_TRIX_DISPATCHER'] = 'test'
+
+  class NamedMiddleware
+    def initialize(app, options={})
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers['NamedMiddleware'] = '1'
+      [status, headers, body]
+    end
+  end
+
+  class InstanceMiddleware
+    attr_reader :name
+
+    def initialize
+      @app  = nil
+      @name = 'InstanceMiddleware'
+    end
+
+    def new(app)
+      @app = app
+      self
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers['InstanceMiddleware'] = '1'
+      [status, headers, body]
+    end
+  end
+
+  if defined?(Sinatra)
+    class SinatraTestApp < Sinatra::Base
+      get '/' do
+        raise "Intentional error" if params["raise"]
+        "SinatraTestApp#index"
+      end
+    end
+  end
+
+  class MyApp < Rails::Application
+    # We need a secret token for session, cookies, etc.
+    config.active_support.deprecation = :log
+    config.secret_token = "49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+    config.eager_load = false
+    config.filter_parameters += [:secret]
+    initializer "install_error_middleware" do
+      config.middleware.use ErrorMiddleware
+    end
+    initializer "install_middleware_by_name" do
+      config.middleware.use "NamedMiddleware"
+    end
+    initializer "install_middleware_instance" do
+      config.middleware.use InstanceMiddleware.new
+    end
+  end
+  MyApp.initialize!
+
+  MyApp.routes.draw do
+    get('/bad_route' => 'test#controller_error',
+        :constraints => lambda do |_|
+          raise ActionController::RoutingError.new('this is an uncaught routing error')
+        end)
+
+    mount SinatraTestApp, :at => '/sinatra_app' if defined?(Sinatra)
+
+    post '/filtering_test' => FilteringTestApp.new
+
+    post '/parameter_capture', :to => 'parameter_capture#create'
+
+    get '/:controller(/:action(/:id))'
+  end
+
+  class ApplicationController < ActionController::Base; end
+end

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

@@ -0,0 +1,192 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# https://mmtrix.atlassian.net/browse/RUBY-1096
+
+require './app'
+
+class RequestStatsController < ApplicationController
+  def stats_action
+    sleep 0.01
+    render :text => 'some stuff'
+  end
+
+  def cross_app_action
+    Mmtrix::Agent::TransactionState.tl_get.is_cross_app_caller = true
+    render :text => 'some stuff'
+  end
+
+  def stats_action_with_custom_params
+    ::Mmtrix::Agent.add_custom_attributes('color' => 'blue', 1 => :bar, 'bad' => {})
+    render :text => 'some stuff'
+  end
+end
+
+class RequestStatsTest < RailsMultiverseTest
+  extend Multiverse::Color
+
+  include MultiverseHelpers
+  setup_and_teardown_agent
+
+  #
+  # Tests
+  #
+
+  def test_doesnt_send_when_disabled
+    with_config( :'analytics_events.enabled' => false ) do
+      5.times { get '/request_stats/stats_action' }
+
+      Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      assert_equal 0, $collector.calls_for('analytic_event_data').length
+    end
+  end
+
+  def test_request_times_should_be_reported_if_enabled
+    with_config( :'analytics_events.enabled' => true ) do
+      5.times { get '/request_stats/stats_action' }
+
+      Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      post = $collector.calls_for('analytic_event_data').first
+
+      refute_nil( post )
+      assert_kind_of Array, post.events
+      assert_kind_of Array, post.events.first
+
+      assert_equal 3, post.events.first.length
+
+      post.events.first.each do |event_chunk|
+        assert_kind_of Hash, event_chunk
+      end
+
+      sample = post.events.first.first
+      assert_equal 'Controller/request_stats/stats_action', sample['name']
+      assert_encoding 'utf-8', sample['name']
+      assert_equal 'Transaction', sample['type']
+      assert_kind_of Float, sample['duration']
+      assert_kind_of Float, sample['timestamp']
+
+      assert_nil sample['nr.guid']
+      assert_nil sample['nr.referringTransactionGuid']
+    end
+  end
+
+  def test_request_should_include_guid_if_cross_app
+    with_config( :'analytics_events.enabled' => true ) do
+      5.times { get '/request_stats/cross_app_action' }
+
+      Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      post = $collector.calls_for('analytic_event_data').first
+
+      refute_nil( post )
+      assert_kind_of Array, post.events
+      assert_kind_of Array, post.events.first
+
+      sample = post.events.first.first
+      assert_kind_of Hash, sample
+
+      assert_kind_of String, sample['nr.guid']
+    end
+  end
+
+  def test_request_should_include_referring_guid_if_needed
+    with_config(:'analytics_events.enabled' => true,
+                :'cross_process_id' => 'boo',
+                :'encoding_key' => "\0",
+                :'trusted_account_ids' => [1]) do
+      rack_env = {
+        'HTTP_X_MMTRIX_ID'          => Base64.encode64('1#234'),
+        'HTTP_X_MMTRIX_TRANSACTION' => Base64.encode64('["8badf00d",1]')
+      }
+      get '/request_stats/cross_app_action', {}, rack_env
+
+      Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      post = $collector.calls_for('analytic_event_data').first
+
+      refute_nil( post )
+      assert_kind_of Array, post.events
+      assert_kind_of Array, post.events.first
+
+      sample = post.events.first.first
+
+      assert_kind_of Hash, sample
+      assert_kind_of String, sample['nr.guid']
+      assert_equal('8badf00d', sample['nr.referringTransactionGuid'])
+    end
+  end
+
+  def test_custom_params_should_be_reported_with_events_and_coerced_to_safe_types
+    with_config( :'analytics_events.enabled' => true ) do
+      5.times { get '/request_stats/stats_action_with_custom_params' }
+
+      Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      post = $collector.calls_for('analytic_event_data').first
+
+      refute_nil( post )
+      assert_kind_of Array, post.events
+      assert_kind_of Array, post.events.first
+
+      sample = post.events.first[0]
+      assert_kind_of Hash, sample
+
+      assert_equal 'Controller/request_stats/stats_action_with_custom_params', sample['name']
+      assert_encoding 'utf-8', sample['name']
+      assert_equal 'Transaction', sample['type']
+
+      ['blue', 'bar', 'bad'].each do |key|
+        assert_not_includes(sample, key)
+      end
+
+      custom_params = post.events.first[1]
+
+      assert_equal 'blue', custom_params['color']
+      assert_equal 'bar', custom_params['1']
+      assert_equal '{}', custom_params['bad']
+    end
+  end
+
+  def test_request_samples_should_be_preserved_upon_failure
+    with_config(:'analytics_events.enabled' => true) do
+      5.times { get '/request_stats/stats_action' }
+
+      # fail once
+      $collector.stub('analytic_event_data', {}, 503)
+      Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      # recover
+      $collector.stub('analytic_event_data', {'return_value'=>nil}, 200)
+      Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      post = $collector.calls_for('analytic_event_data').last
+
+      samples = post.events
+      assert_equal(5, samples.size)
+      samples.each do |sample|
+        # undo the extra layer of wrapping that the collector wants
+        sample = sample.first
+        assert_kind_of Hash, sample
+        assert_kind_of Float, sample['duration']
+        assert_kind_of Float, sample['timestamp']
+      end
+    end
+  end
+
+
+  #
+  # Helpers
+  #
+
+  def assert_encoding( encname, string )
+    return unless string.respond_to?( :encoding )
+    expected_encoding = Encoding.find( encname ) or raise "no such encoding #{encname.dump}"
+    msg = "Expected encoding of %p to be %p, but it was %p" %
+      [ string, expected_encoding, string.encoding ]
+    assert_equal( expected_encoding, string.encoding, msg )
+  end
+
+end

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

@@ -0,0 +1,41 @@
+# 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 './app'
+require 'transaction_ignoring_test_cases'
+
+class TransactionIgnorerController < ApplicationController
+  def run_transaction
+    state = Mmtrix::Agent::TransactionState.tl_get
+    Mmtrix::Agent.set_transaction_name(params[:txn_name])
+    Mmtrix::Agent.notice_error(params[:error_msg]) if params[:error_msg]
+    Mmtrix::Agent.instance.sql_sampler.notice_sql("select * from test",
+                                 "Database/test/select",
+                                 nil, 1.5, state) if params[:slow_sql]
+    render :text => 'some stuff'
+  end
+
+
+end
+
+class TransactionIgnoringTest < RailsMultiverseTest
+
+  include MultiverseHelpers
+  include TransactionIgnoringTestCases
+
+  def trigger_transaction(txn_name)
+    get '/transaction_ignorer/run_transaction', :txn_name  => txn_name
+  end
+
+  def trigger_transaction_with_error(txn_name, error_msg)
+    get '/transaction_ignorer/run_transaction', :txn_name  => txn_name,
+                                                :error_msg => error_msg
+  end
+
+  def trigger_transaction_with_slow_sql(txn_name)
+    get '/transaction_ignorer/run_transaction', :txn_name  => txn_name,
+                                                :slow_sql  => 'true'
+  end
+
+end

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

@@ -0,0 +1,254 @@
+# 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 './app'
+require 'haml'
+
+ActionController::Base.view_paths = ['app/views']
+
+class ViewsController < ApplicationController
+  def template_render_with_3_partial_renders
+    render 'index'
+  end
+
+  def render_with_delays
+    freeze_time
+    @delay = 1
+    render 'index'
+  end
+
+  def deep_partial_render
+    render 'deep_partial'
+  end
+
+  def text_render
+    render :text => "Yay"
+  end
+
+  def json_render
+    render :json => {"a" => "b"}
+  end
+
+  def xml_render
+    render :xml => {"a" => "b"}
+  end
+
+  def js_render
+    render :js => 'alert("this is js");'
+  end
+
+  def file_render
+    # The choice of filename is significant here: we want a dot in the filename
+    # in order to expose an issue on Rails 2.
+    file = File.expand_path(File.join(File.dirname(__FILE__), "dummy.txt"))
+    render :file => file, :content_type => 'text/plain', :layout => false
+  end
+
+  def nothing_render
+    render :nothing => true
+  end
+
+  def inline_render
+    render :inline => "<% Time.now %><p><%= Time.now %></p>"
+  end
+
+  def haml_render
+    render 'haml_view'
+  end
+
+  def no_template
+    render []
+  end
+
+  def collection_render
+    render((1..3).map{|x| Foo.new })
+  end
+
+  # proc rendering isn't available in rails 3 but you can do nonsense like this
+  # and assign an enumerable object to the response body.
+  def proc_render
+    streamer = Class.new do
+      def each
+        10_000.times do |i|
+          yield "This is line #{i}\n"
+        end
+      end
+    end
+    self.response_body = streamer.new
+  end
+
+  def raise_render
+    raise "this is an uncaught RuntimeError"
+  end
+end
+
+class ViewInstrumentationTest < RailsMultiverseTest
+  include MultiverseHelpers
+
+  setup_and_teardown_agent do
+    # ActiveSupport testing keeps blowing away my subscribers on
+    # teardown for some reason.  Have to keep putting it back.
+    if Rails::VERSION::MAJOR.to_i == 4
+      Mmtrix::Agent::Instrumentation::ActionViewSubscriber \
+        .subscribe(/render_.+\.action_view$/)
+      Mmtrix::Agent::Instrumentation::ActionControllerSubscriber \
+        .subscribe(/^process_action.action_controller$/)
+    end
+  end
+
+  (ViewsController.action_methods - ['raise_render']).each do |method|
+
+    # proc rendering doesn't work on Rails 2
+    next if method == 'proc_render' && Rails::VERSION::MAJOR <= 2
+
+    define_method("test_sanity_#{method}") do
+      get "/views/#{method}"
+      assert_equal 200, status
+    end
+
+    def test_should_allow_uncaught_exception_to_propagate
+      get "/views/raise_render"
+      assert_equal 500, status
+    end
+
+    def test_should_count_all_the_template_and_partial_nodes
+      get '/views/template_render_with_3_partial_renders'
+      sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+      nodes = find_all_nodes_with_name_matching(sample, ['^Nested/Controller/views', '^View'])
+      nodes_list = "Found these nodes:\n  #{nodes.map(&:metric_name).join("\n  ")}"
+
+      if Rails::VERSION::MAJOR <= 2
+        assert_equal 8, nodes.length, "Should be a node for the controller action, the template, and 3 partials with two nodes each (8). #{nodes_list}"
+      else
+        assert_equal 5, nodes.length, "Should be a node for the controller action, the template, and 3 partials (5). #{nodes_list}"
+      end
+    end
+
+    def test_should_have_3_nodes_with_the_correct_metric_name
+      get '/views/template_render_with_3_partial_renders'
+
+      sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+      partial_nodes = find_all_nodes_with_name_matching(sample, 'View/views/_a_partial.html.erb/Partial')
+
+      assert_equal 3, partial_nodes.size, "sanity check"
+      assert_equal ['View/views/_a_partial.html.erb/Partial'], partial_nodes.map(&:metric_name).uniq
+    end
+
+    # We don't capture text or inline template rendering on Rails 2
+    if Rails::VERSION::MAJOR >= 3
+      def test_should_create_a_metric_for_the_rendered_inline_template
+        get '/views/inline_render'
+
+        sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+        text_node = find_node_with_name(sample, 'View/inline template/Rendering')
+
+        assert text_node, "Failed to find a node named View/inline template/Rendering"
+        assert_metrics_recorded('View/inline template/Rendering')
+      end
+
+      # It doesn't seem worth it to get consistent behavior here.
+      if Rails::VERSION::MAJOR.to_i == 3 && Rails::VERSION::MINOR.to_i == 0
+        def test_should_not_instrument_rendering_of_text
+          get '/views/text_render'
+          sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+          refute find_node_with_name(sample, 'View/text template/Rendering')
+        end
+      else
+        def test_should_create_a_metric_for_the_rendered_text
+          get '/views/text_render'
+
+          sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+          text_node = find_node_with_name(sample, 'View/text template/Rendering')
+
+          assert text_node, "Failed to find a node named View/text template/Rendering"
+          assert_metrics_recorded('View/text template/Rendering')
+        end
+      end
+    end
+
+    def test_should_create_a_metric_for_the_rendered_haml_template
+      get '/views/haml_render'
+
+      sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+      text_node = find_node_with_name(sample, 'View/views/haml_view.html.haml/Rendering')
+
+      assert text_node, "Failed to find a node named View/views/haml_view.html.haml/Rendering"
+      assert_metrics_recorded('View/views/haml_view.html.haml/Rendering')
+    end
+
+    def test_should_create_a_proper_metric_when_the_template_is_unknown
+      get '/views/no_template'
+      sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+
+      # Different versions have significant difference in handling, but we're
+      # happy enough with what each of them does in the unknown case
+      if Rails::VERSION::MAJOR.to_i < 3 || (Rails::VERSION::MAJOR.to_i == 3 && Rails::VERSION::MINOR.to_i == 0)
+        refute find_node_with_name_matching(sample, /^View/)
+      elsif Rails::VERSION::MAJOR.to_i == 3
+        assert find_node_with_name(sample, 'View/collection/Partial')
+      else
+        assert find_node_with_name(sample, 'View/(unknown)/Partial')
+      end
+    end
+
+    def test_should_create_a_proper_metric_when_we_render_a_collection
+      get '/views/collection_render'
+      sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+      assert find_node_with_name(sample, "View/foos/_foo.html.haml/Partial")
+    end
+
+    [:js_render, :xml_render, :proc_render, :json_render ].each do |action|
+      next if action == :proc_render && Rails::VERSION::MAJOR <= 2
+      define_method("test_should_not_instrument_rendering_of_#{action}") do
+        get "/views/#{action}"
+        sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+        view_node = find_node_with_name_matching(sample, /^View\//)
+        refute view_node, "Should not instrument rendering of #{action}, found #{view_node}."
+      end
+    end
+
+    # The Rails 2.3 view instrumentation doesn't actually pass this test, but it
+    # hasn't been a problem thus far, so we're letting it slide.
+    if Rails::VERSION::MAJOR >= 3
+      def test_should_create_a_metric_for_rendered_file_that_does_not_include_the_filename_so_it_doesnt_metric_explode
+        get '/views/file_render'
+        sample = Mmtrix::Agent.agent.transaction_sampler.last_sample
+        assert find_node_with_name(sample, 'View/file/Rendering')
+        refute find_node_with_name_matching(sample, 'dummy')
+      end
+    end
+
+    def test_exclusive_time_for_template_render_metrics_should_not_include_partial_rendering_time
+      get '/views/render_with_delays'
+
+      expected_stats_partial = {
+        :call_count           => 3,
+        :total_call_time      => 3.0,
+        :total_exclusive_time => 3.0
+      }
+
+      expected_stats_template = {
+        :call_count           => 1,
+        :total_call_time      => 4.0,
+        :total_exclusive_time => 1.0  # top-level template takes 1s itself
+      }
+
+      scope = 'Controller/views/render_with_delays'
+      template_metric = 'View/views/index.html.erb/Rendering'
+
+      if Rails::VERSION::MAJOR <= 2
+        partial_metric  = 'View/views/_a_partial.html.erb/Rendering'
+      else
+        partial_metric  = 'View/views/_a_partial.html.erb/Partial'
+      end
+
+      assert_metrics_recorded(
+         partial_metric           => expected_stats_partial,
+         template_metric          => expected_stats_template,
+         [partial_metric, scope]  => expected_stats_partial,
+         [template_metric, scope] => expected_stats_template
+      )
+    end
+  end
+end

data/test/multiverse/suites/resque/Envfile

@@ -0,0 +1,11 @@
+gemfile <<-RB
+  gem 'resque', '1.23.0'
+  gem 'json'
+  gem 'rake'
+RB
+
+gemfile <<-RB
+  gem 'resque', '~>1.25.1'
+  gem 'json'
+  gem 'rake'
+RB

data/test/multiverse/suites/resque/Rakefile

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), 'resque_setup')
+require 'resque/tasks'
+

data/test/multiverse/suites/resque/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
+  port: <%= $collector && $collector.port %>
+  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