mmtrix_rpm 1.0.0.1

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

@@ -0,0 +1,299 @@
+# 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'
+
+class ParameterCaptureController < ApplicationController
+  def transaction
+    render :text => 'hi!'
+  end
+
+  def create
+    raise 'problem' if params[:raise]
+    render :text => 'created'
+  end
+
+  def sql
+    Mmtrix::Agent.agent.sql_sampler.notice_sql(
+      'SELECT * FROM table',
+      'ActiveRecord/foos/find',
+      {},
+      100.0
+    )
+  end
+
+  def error
+    raise 'wut'
+  end
+
+  # For Rails 3+, this is configured globally in the config block for the app
+  if Rails::VERSION::MAJOR == 2
+    filter_parameter_logging(:secret)
+  end
+end
+
+class ParameterCaptureTest < RailsMultiverseTest
+  include MultiverseHelpers
+  setup_and_teardown_agent
+
+  def test_no_params_captured_on_errors_when_disabled
+    with_config(:capture_params => false) do
+      get '/parameter_capture/error?other=1234&secret=4567'
+      refute_contains_request_params(agent_attributes_for_single_error_posted)
+    end
+  end
+
+  def test_no_params_captured_on_tts_when_disabled
+    with_config(:capture_params => false) do
+      get '/parameter_capture/transaction?other=1234&secret=4567'
+    end
+    assert_equal({}, last_transaction_trace_request_params)
+  end
+
+  def test_uri_on_traced_errors_never_contains_query_string_without_capture_params
+    with_config(:capture_params => false) do
+      get '/parameter_capture/error?other=1234&secret=4567'
+      assert_equal('/parameter_capture/error', attributes_for_single_error_posted("request_uri"))
+    end
+  end
+
+  def test_uri_on_traced_errors_never_contains_query_string_with_capture_params
+    with_config(:capture_params => true) do
+      get '/parameter_capture/error?other=1234&secret=4567'
+      assert_equal('/parameter_capture/error', attributes_for_single_error_posted("request_uri"))
+    end
+  end
+
+  def test_referrer_on_traced_errors_never_contains_query_string_without_capture_params
+    with_config(:capture_params => false) do
+      get '/parameter_capture/error?other=1234&secret=4567', {}, { 'HTTP_REFERER' => '/foo/bar?other=123&secret=456' }
+      attributes = agent_attributes_for_single_error_posted
+      assert_equal('/foo/bar', attributes["request.headers.referer"])
+    end
+  end
+
+  def test_referrer_on_traced_errors_never_contains_query_string_even_with_capture_params
+    with_config(:capture_params => true) do
+      get '/parameter_capture/error?other=1234&secret=4567', {}, { 'HTTP_REFERER' => '/foo/bar?other=123&secret=456' }
+      attributes = agent_attributes_for_single_error_posted
+      assert_equal('/foo/bar', attributes["request.headers.referer"])
+    end
+  end
+
+  def test_controller_and_action_excluded_from_error_parameters
+    with_config(:capture_params => true) do
+      get '/parameter_capture/error'
+      run_harvest
+
+      refute_error_has_agent_attribute('request.parameters.controller')
+      refute_error_has_agent_attribute('request.parameters.action')
+    end
+  end
+
+  def test_controller_and_action_excluded_from_transaction_trace_parameters
+    with_config(:capture_params => true, :'transaction_tracer.transaction_threshold' => -10) do
+      get '/parameter_capture/transaction'
+      run_harvest
+
+      refute_transaction_trace_has_agent_attribute('request.parameters.controller')
+      refute_transaction_trace_has_agent_attribute('request.parameters.action')
+    end
+  end
+
+  def test_uri_on_tts_never_contains_query_string
+    with_config(:capture_params => false) do
+      get '/parameter_capture/transaction?other=1234&secret=4567'
+    end
+    assert_equal('/parameter_capture/transaction', last_transaction_trace.uri)
+
+    with_config(:capture_params => true) do
+      get '/parameter_capture/transaction?other=1234&secret=4567'
+    end
+    assert_equal('/parameter_capture/transaction', last_transaction_trace.uri)
+  end
+
+  def test_filters_parameters_on_traced_errors
+    with_config(:capture_params => true) do
+      get '/parameter_capture/error?other=1234&secret=4567'
+
+      captured_params = agent_attributes_for_single_error_posted
+      assert_equal('[FILTERED]', captured_params['request.parameters.secret'])
+      assert_equal('1234',       captured_params['request.parameters.other'])
+    end
+  end
+
+  def test_filters_parameters_on_transaction_traces
+    with_config(:capture_params => true) do
+      get '/parameter_capture/transaction?other=1234&secret=4567'
+    end
+
+    captured_params = last_transaction_trace_request_params
+    assert_equal('[FILTERED]', captured_params['request.parameters.secret'])
+    assert_equal('1234',       captured_params['request.parameters.other'])
+  end
+
+  def test_no_traced_error_params_captured_when_bails_before_rails
+    with_config(:capture_params => false) do
+      get '/middleware_error/before?other=1234&secret=4567'
+      refute_contains_request_params(agent_attributes_for_single_error_posted)
+    end
+  end
+
+  def test_no_transaction_trace_params_captured_when_bails_before_rails
+    with_config(:capture_params => false) do
+      get '/middleware_error/before?other=1234&secret=4567'
+    end
+
+    assert_equal({}, last_transaction_trace_request_params)
+  end
+
+  def test_no_params_captured_on_error_when_bails_before_rails_even_when_enabled
+    with_config(:capture_params => true) do
+      get '/middleware_error/before?other=1234&secret=4567'
+      refute_contains_request_params(agent_attributes_for_single_error_posted)
+    end
+  end
+
+  def test_no_params_captured_on_tt_when_bails_before_rails_even_when_enabled
+    with_config(:capture_params => true) do
+      get '/middleware_error/before?other=1234&secret=4567'
+    end
+    assert_equal({}, last_transaction_trace_request_params)
+  end
+
+  def test_uri_on_tt_should_not_contain_query_string_with_capture_params_off
+    with_config(:capture_params => false) do
+      get '/parameter_capture/transaction?param1=value1&param2=value2'
+    end
+    assert_equal('/parameter_capture/transaction', last_transaction_trace.uri)
+  end
+
+  def test_uri_on_tt_should_not_contain_query_string_with_capture_params_on
+    with_config(:capture_params => true) do
+      get '/parameter_capture/transaction?param1=value1&param2=value2'
+    end
+    assert_equal('/parameter_capture/transaction', last_transaction_trace.uri)
+  end
+
+  def test_uri_on_traced_error_should_not_contain_query_string_with_capture_params_off
+    with_config(:capture_params => false) do
+      get '/parameter_capture/error?param1=value1&param2=value2'
+      assert_equal('/parameter_capture/error', attributes_for_single_error_posted("request_uri"))
+    end
+  end
+
+  def test_uri_on_traced_error_should_not_contain_query_string_with_capture_params_on
+    with_config(:capture_params => true) do
+      get '/parameter_capture/error?param1=value1&param2=value2'
+      assert_equal('/parameter_capture/error', attributes_for_single_error_posted("request_uri"))
+    end
+  end
+
+  def test_uri_on_sql_trace_should_not_contain_query_string_with_capture_params_off
+    with_config(:capture_params => false) do
+      get '/parameter_capture/sql?param1=value1&param2=value2'
+    end
+    assert_equal('/parameter_capture/sql', last_sql_trace.url)
+  end
+
+  def test_uri_on_sql_trace_should_not_contain_query_string_with_capture_params_on
+    with_config(:capture_params => true) do
+      get '/parameter_capture/sql?param1=value1&param2=value2'
+    end
+    assert_equal('/parameter_capture/sql', last_sql_trace.url)
+  end
+
+  def test_parameters_attached_to_transaction_events_if_enabled
+    with_config(:'attributes.include' => 'request.parameters.*') do
+      get '/parameter_capture/transaction?param1=value1&param2=value2'
+    end
+
+    actual = agent_attributes_for_single_event_posted_without_ignored_attributes
+
+    expected = {"request.parameters.param1" => "value1",
+      "request.parameters.param2" => "value2"
+    }
+
+    assert_equal expected, actual
+  end
+
+  if Rails::VERSION::MAJOR > 2
+    def test_params_tts_should_be_filtered_when_serviced_by_rack_app
+      params = {"secret" => "shhhhhhh", "name" => "name"}
+      with_config(:capture_params => true) do
+        post '/filtering_test/', params
+      end
+
+      expected = {
+        "request.parameters.secret" => "[FILTERED]",
+        "request.parameters.name" => "name"
+      }
+      assert_equal expected, last_transaction_trace_request_params
+    end
+
+    def test_params_on_errors_should_be_filtered_when_serviced_by_rack_app
+      params = {"secret" => "shhhhhhh", "name" => "name"}
+      with_config(:capture_params => true) do
+        post '/filtering_test?raise=1', params
+
+        expected = {
+          "request.parameters.secret" => "[FILTERED]",
+          "request.parameters.name" => "name",
+          "request.parameters.raise" => "1"
+        }
+
+        attributes = agent_attributes_for_single_error_posted
+        expected.each do |key, value|
+          assert_equal value, attributes[key]
+        end
+      end
+    end
+
+    def test_parameter_filtering_should_not_mutate_argument
+      input = { "foo" => "bar", "secret" => "baz" }
+      env   = { "action_dispatch.parameter_filter" => ["secret"] }
+      filtered = Mmtrix::Agent::ParameterFiltering.apply_filters(env, input)
+
+      assert_equal({ "foo" => "bar", "secret" => "[FILTERED]" }, filtered)
+      assert_equal({ "foo" => "bar", "secret" => "baz" }, input)
+    end
+  end
+
+  if Rails::VERSION::MAJOR > 2 && defined?(Sinatra)
+    def test_params_tts_should_be_filtered_when_serviced_by_sinatra_app
+      with_config(:capture_params => true) do
+        get '/sinatra_app/', "secret" => "shhhhhhh", "name" => "name"
+      end
+
+      expected = {
+        "request.parameters.secret" => "[FILTERED]",
+        "request.parameters.name" => "name"
+      }
+      assert_equal expected, last_transaction_trace_request_params
+    end
+
+    def test_params_on_errors_should_be_filtered_when_serviced_by_sinatra_app
+      with_config(:capture_params => true) do
+        get '/sinatra_app?raise=1', "secret" => "shhhhhhh", "name" => "name"
+
+        attributes = agent_attributes_for_single_error_posted
+        assert_equal "[FILTERED]", attributes["request.parameters.secret"]
+        assert_equal "name", attributes["request.parameters.name"]
+        assert_equal "1", attributes["request.parameters.raise"]
+      end
+    end
+
+    def test_file_upload_params_are_replaced_with_placeholder
+      with_config(:capture_params => true, :'transaction_tracer.transaction_threshold' => -10) do
+        post '/parameter_capture', :file => Rack::Test::UploadedFile.new(__FILE__, 'text/plain')
+
+        run_harvest
+
+        result = single_transaction_trace_posted
+        assert_equal "#<ActionDispatch::Http::UploadedFile>", result.agent_attributes["request.parameters.file"]
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,89 @@
+# 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-927
+
+require './app'
+
+class QueueController < ApplicationController
+  def queued
+    respond_to do |format|
+      format.html { render :text => "<html><head></head><body>Queued</body></html>" }
+    end
+  end
+
+  def nested
+    nested_transaction
+    render :text => 'whatever'
+  end
+
+  def nested_transaction; end
+
+  add_transaction_tracer :nested_transaction
+end
+
+class QueueTimeTest < RailsMultiverseTest
+
+  REQUEST_START_HEADER = 'HTTP_X_REQUEST_START'
+
+  include MultiverseHelpers
+
+  setup_and_teardown_agent(:beacon => "beacon", :browser_key => "key", :js_agent_loader => "loader")
+
+  def test_should_track_queue_time_metric
+    t0 = freeze_time
+    t1 = advance_time(2)
+    get_path('/queue/queued', t0)
+
+    assert_metrics_recorded(
+      'WebFrontend/QueueTime' => {
+        :call_count      => 1,
+        :total_call_time => (t1 - t0)
+      }
+    )
+  end
+
+  def test_should_see_queue_time_in_rum
+    t0 = freeze_time
+    t1 = advance_time(2)
+    get_path('/queue/queued', t0)
+    queue_time = extract_queue_time_from_response
+    assert_equal((t1 - t0) * 1000, queue_time)
+  end
+
+  def test_should_not_track_queue_time_for_nested_transactions
+    t0 = freeze_time
+    t1 = advance_time(2)
+    get_path('/queue/nested', t0)
+    assert_metrics_recorded(
+      'WebFrontend/QueueTime' => {
+        :call_count      => 1,
+        :total_call_time => (t1 - t0)
+      }
+    )
+  end
+
+  def get_path(path, queue_start_time)
+    value = "t=#{(queue_start_time.to_f * 1_000_000).to_i}"
+    get(path, nil, REQUEST_START_HEADER => value)
+  end
+
+  def extract_queue_time_from_response
+    get_last_response_body =~ /\"queueTime\":(\d+.*)/
+    refute_nil $1, "Should have found queue time in #{@response.body.inspect}"
+    $1.to_i
+  end
+
+  def get_last_response_body
+    if Rails::VERSION::MAJOR >= 3
+      @response.body
+    else
+      # In Rails 2 integration tests, @response.body is always the response from
+      # the controller itself, not the middleware stack. Since we want the
+      # response from the middleware stack, we grab it off of the integration
+      # session.
+      @integration_session.body
+    end
+  end
+end

data/test/multiverse/suites/rails/rails2_app/app/controllers/application.rb

@@ -0,0 +1,7 @@
+# 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 ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+end

data/test/multiverse/suites/rails/rails2_app/config/boot.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+      def read_environment_rb
+        File.read("#{RAILS_ROOT}/config/environment.rb")
+      end
+    end
+  end
+end
+
+class Rails::Boot
+  def run
+    load_initializer
+
+    Rails::Initializer.class_eval do
+      def load_gems
+        @bundler_loaded ||= Bundler.require :default, Rails.env
+      end
+    end
+
+    Rails::Initializer.run(:set_load_path)
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/multiverse/suites/rails/rails2_app/config/database.yml

@@ -0,0 +1,18 @@
+sqlite3: &sqlite3
+<% if defined?(JRuby) %>
+  adapter: jdbcsqlite3
+<% else %>
+  adapter: sqlite3
+<% end %>
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *sqlite3
+
+test:
+  <<: *sqlite3
+
+production:
+  <<: *sqlite3

data/test/multiverse/suites/rails/rails2_app/config/environment.rb

@@ -0,0 +1,16 @@
+# 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 File.join(File.dirname(__FILE__), 'boot')
+
+GC.enable_stats if GC.respond_to?(:enable_stats)
+
+Rails::Initializer.run do |config|
+  config.action_controller.session = {
+    :key    => '_rails22blog_session',
+    :secret => '603603ece6f4792a7a1284a903788646998ad4646ed19d5f06e2af7578660b7b39e54c685f3efa245084eaa5447684a0d8afc96742b63f0e133e8587272c71d1'
+  }
+end
+
+require 'application'

data/test/multiverse/suites/rails/rails2_app/config/environments/development.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+config.cache_classes = false
+config.whiny_nils = true
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+config.action_mailer.raise_delivery_errors = false

data/test/multiverse/suites/rails/rails2_app/config/initializers/load_mmtrix_rpm.rb

@@ -0,0 +1,9 @@
+# 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_rpm'
+
+# Needs to be after we've loaded the agent so we're located within our
+# transaction starting middlewares
+Rails.configuration.middleware.use ErrorMiddleware

data/test/multiverse/suites/rails/rails2_app/config/preinitializer.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+begin
+  require 'rubygems'
+  require 'bundler'
+rescue LoadError
+  raise "Could not load the bundler gem. Install it, thanks."
+end
+
+if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.24")
+  raise RuntimeError, "Your bundler version is too old for Rails 2.3." +
+   "Run `gem install bundler` to upgrade."
+end
+
+begin
+  # Set up load paths for all bundled gems
+  ENV["BUNDLE_GEMFILE"] = File.expand_path("../../Gemfile", __FILE__)
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end
+

data/test/multiverse/suites/rails/rails2_app/config/routes.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# File required to exist by Rails
+
+ActionController::Routing::Routes.draw do |map|
+  map.connect 'bad_instrumentation/:action', :controller => 'bad_instrumentation'
+  map.connect 'error/:action',               :controller => 'error'
+  map.connect 'transaction_ignorer/:action', :controller => 'transaction_ignorer'
+  map.connect 'request_stats/:action',       :controller => 'request_stats'
+  map.connect 'queue/:action',               :controller => 'queue'
+  map.connect 'views/:action',               :controller => 'views'
+  map.connect 'ignored/:action',             :controller => 'ignored'
+  map.connect 'parameter_capture/:action',   :controller => 'parameter_capture'
+  map.connect 'child/:action',               :controller => 'child'
+
+  map.connect ':controller/:action'
+end

data/test/multiverse/suites/rails/rails2_app/db/schema.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# File required to exist by Rails