mmtrix_rpm 1.0.0.1

data/test/multiverse/suites/active_record/config/database.rb

@@ -0,0 +1,80 @@
+# 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 'active_record'
+require 'erb'
+require 'mmtrix_rpm'
+
+DependencyDetection.detect!
+
+db_dir = File.expand_path('../../db', __FILE__)
+config_dir = File.expand_path(File.dirname(__FILE__))
+ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby' # MRI 1.8.7 doesn't define RUBY_ENGINE
+
+if defined?(ActiveRecord::VERSION)
+  ENV['DATABASE_NAME'] = "multiverse_activerecord_#{ActiveRecord::VERSION::STRING}_#{RUBY_VERSION}_#{ruby_engine}".gsub(".", "_")
+else
+  ENV['DATABASE_NAME'] = "multiverse_activerecord_2_x_#{ENV["MULTIVERSE_ENV"]}_#{RUBY_VERSION}_#{ruby_engine}".gsub(".", "_")
+end
+
+config_raw = File.read(File.join(config_dir, 'database.yml'))
+config_erb = ERB.new(config_raw).result
+config_yml = YAML.load(config_erb)
+
+# Rails 2.x didn't keep the Rails out of ActiveRecord much...
+RAILS_ENV  = "test"
+RAILS_ROOT = File.join(db_dir, "..")
+
+ActiveRecord::Base.configurations = config_yml
+ActiveRecord::Base.establish_connection :test
+ActiveRecord::Base.logger = Logger.new(ENV["VERBOSE"] ? STDOUT : StringIO.new)
+
+begin
+  load 'active_record/railties/databases.rake'
+rescue LoadError, StandardError
+  load 'tasks/databases.rake'
+end
+
+if defined?(ActiveRecord::Tasks)
+  include ActiveRecord::Tasks
+
+  module Seeder
+    def self.load_seed
+      # Nope
+    end
+  end
+
+  DatabaseTasks.env = "test"
+  DatabaseTasks.db_dir = db_dir
+  DatabaseTasks.migrations_paths = File.join(db_dir, 'migrate')
+  DatabaseTasks.database_configuration = config_yml
+  DatabaseTasks.seed_loader = Seeder
+else
+  # Hattip to https://github.com/janko-m/sinatra-activerecord/blob/master/lib/sinatra/activerecord/rake/activerecord_3.rb
+  module Rails
+    extend self
+
+    def root
+      Pathname.new(Rake.application.original_dir)
+    end
+
+    def env
+      ActiveSupport::StringInquirer.new(ENV["RACK_ENV"] || "development")
+    end
+
+    def application
+      seed_loader = Object.new
+      seed_loader.instance_eval do
+        def load_seed
+          # Nope
+        end
+      end
+      seed_loader
+    end
+  end
+
+  Rake::Task.define_task("db:environment")
+  Rake::Task["db:load_config"].clear if Rake::Task.task_defined? "db:load_config"
+  Rake::Task.define_task("db:rails_env")
+end

data/test/multiverse/suites/active_record/config/database.yml

@@ -0,0 +1,19 @@
+mysql: &mysql
+<% if defined?(JRuby) %>
+  adapter: jdbcmysql
+<% else %>
+  adapter: mysql
+<% end %>
+  socket: <%= (`uname -s` =~ /Linux/ ) ? "" :"/tmp/mysql.sock" %>
+  username: root
+  host: localhost
+  database: <%= db = "#{ENV['DATABASE_NAME']}"; db.empty? ? "rails_blog" : db %>
+
+development:
+  <<: *mysql
+
+test:
+  <<: *mysql
+
+production:
+  <<: *mysql

data/test/multiverse/suites/active_record/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_trace:
+    record_sql: obfuscated
+    enabled: true
+    stack_trace_threshold: 0.5
+    transaction_threshold: 1.0
+  capture_params: false

data/test/multiverse/suites/active_record/db/migrate/20141105131800_create_users_and_aliases.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 CreateUsersAndAliases < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string  :name
+    end
+
+    create_table :aliases do |t|
+      t.integer :user_id
+      t.string :aka
+    end
+  end
+
+  def self.down
+    drop_table :users
+    drop_table :aliases
+  end
+end

data/test/multiverse/suites/active_record/db/migrate/20141106082200_create_orders_and_shipments.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.
+
+class CreateOrdersAndShipments < ActiveRecord::Migration
+  def self.up
+    create_table :orders do |t|
+      t.string :name
+    end
+
+    create_table :shipments, :force => true do |t|
+    end
+
+    create_table :order_shipments, :force => true, :id => false do |t|
+      t.integer :order_id
+      t.integer :shipment_id, :integer
+    end
+  end
+
+  def self.down
+    drop_table :orders
+    drop_table :shipments
+    drop_table :order_shipments
+  end
+end

data/test/multiverse/suites/active_record/db/migrate/20150413011200_add_timestamps_to_orders.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.
+
+class AddTimestampsToOrders < ActiveRecord::Migration
+  def self.up
+    change_table(:orders) do |t|
+      t.timestamps
+    end
+  end
+
+  def self.down
+    remove_column :orders, :updated_at
+    remove_column :orders, :created_at
+  end
+end

data/test/multiverse/suites/active_record/db/migrate/20150414084400_create_groups.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 CreateGroups < ActiveRecord::Migration
+  def self.up
+    create_table :groups do |t|
+      t.string :name
+    end
+
+    create_table :groups_users, :id => false do |t|
+      t.integer :group_id, :integer
+      t.integer :user_id,  :integer
+    end
+  end
+
+  def self.down
+    drop_table :groups
+    drop_table :groups_users
+  end
+end

data/test/multiverse/suites/activemerchant/Envfile

@@ -0,0 +1,36 @@
+gemfile <<-RB
+  gem 'activemerchant', '~>1.43.1'
+  gem 'rack'
+
+  if RUBY_VERSION <= '1.9.2'
+    # Very special versioning to keep us running on 1.8.7 versions of Ruby
+    gem 'activesupport', '~>2.3.14', :require => 'active_support'
+    gem 'nokogiri', '~>1.4.7'
+    gem 'i18n', '~>0.6.11'
+  else
+    gem 'activesupport', '~>4.0.4'
+    gem 'nokogiri', '~>1.6.1'
+  end
+
+  # Need to load mmtrix_rpm after ActiveMerchant Gateways are required
+  gem 'mmtrix_rpm', :require => false, :path => File.expand_path('../../../../')
+RB
+
+gemfile <<-RB
+  gem 'activemerchant', '~>1.25.0'
+  gem 'active_utils', '2.2.3'
+  gem 'rack'
+
+  if RUBY_VERSION <= '1.9.2'
+    # Very special versioning to keep us running on 1.8.7 versions of Ruby
+    gem 'activesupport', '~>2.3.14', :require => 'active_support'
+    gem 'nokogiri', '~>1.4.7'
+    gem 'i18n', '~>0.6.11'
+  else
+    gem 'activesupport', '~>4.0.4'
+    gem 'nokogiri', '~>1.5.11'
+  end
+
+  # Need to load mmtrix_rpm after ActiveMerchant Gateways are required
+  gem 'mmtrix_rpm', :require => false, :path => File.expand_path('../../../../')
+RB

data/test/multiverse/suites/activemerchant/activemerchant_test.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# Let ActiveSupport's auto-loading make sure the testing gateway's there.
+# require complains of redefine on certain Rubies, (looking at you REE)
+ActiveMerchant::Billing::BogusGateway
+
+class ActiveMerchant::Billing::BogusGateway
+  # Testing class doesn't have this, but we instrument it for other gateways
+  def update(*_)
+  end
+end
+
+require 'mmtrix_rpm'
+
+class ActiveMerchantTest < Minitest::Test
+
+  attr_reader :gateway
+
+  include MultiverseHelpers
+
+  setup_and_teardown_agent do
+    @gateway = ActiveMerchant::Billing::BogusGateway.new
+  end
+
+  # Methods with parameters (money, paysource) can just be added to this list
+  [:authorize, :purchase, :credit, :capture, :recurring, :update].each do |operation|
+    define_method("test_#{operation}") do
+      assert_merchant_transaction(operation)
+    end
+  end
+
+  # Tests for methods that require more specific parameters should go here
+  def test_void
+    assert_merchant_transaction(:void, REFERENCE)
+  end
+
+  def test_store
+    assert_merchant_transaction(:store, PAYSOURCE)
+  end
+
+  def test_unstore
+    assert_merchant_transaction(:unstore, "1")
+  end
+
+  # Helper
+  PAYSOURCE = 1
+  REFERENCE = 3
+
+  def assert_merchant_transaction(operation, *args)
+    in_transaction('txn') do
+      # Default arguments if not provided by test
+      args = [100, PAYSOURCE] if args.empty?
+
+      gateway.send(operation, *args)
+    end
+    assert_metrics_recorded([["ActiveMerchant/gateway/BogusGateway/#{operation}", "txn"],
+                              "ActiveMerchant/gateway/BogusGateway",
+                              "ActiveMerchant/operation/#{operation}"])
+  end
+end

data/test/multiverse/suites/agent_only/Envfile

@@ -0,0 +1,4 @@
+gemfile <<-RB
+  gem 'rack'
+  gem 'rack-test'
+RB

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

@@ -0,0 +1,168 @@
+# 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 AgentAttributesTest < Minitest::Test
+
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  def test_http_response_code_default_destinations
+    run_transaction do |txn|
+      txn.http_response_code = 418
+    end
+
+    assert_transaction_trace_has_agent_attribute("httpResponseCode", "418")
+    assert_event_has_agent_attribute("httpResponseCode", "418")
+    assert_error_has_agent_attribute("httpResponseCode", "418")
+
+    refute_browser_monitoring_has_agent_attribute("httpResponseCode")
+  end
+
+  def test_request_headers_referer_default_destinations
+    txn_options = {:request => stub(:referer => "referrer", :path => "/")}
+    run_transaction({}, txn_options) do |txn|
+    end
+
+    assert_error_has_agent_attribute("request.headers.referer", "referrer")
+
+    refute_transaction_trace_has_agent_attribute("request.headers.referer")
+    refute_event_has_agent_attribute("request.headers.referer")
+    refute_browser_monitoring_has_agent_attribute("request.headers.referer")
+  end
+
+  def test_request_parameters_default_destinations_without_capture_params
+    run_transaction(:capture_params => false) do |txn|
+      txn.merge_request_parameters(:duly => "noted")
+    end
+
+    refute_transaction_trace_has_agent_attribute("request.parameters.duly")
+    refute_event_has_agent_attribute("request.parameters.duly")
+    refute_error_has_agent_attribute("request.parameters.duly")
+    refute_browser_monitoring_has_agent_attribute("request.parameters.duly")
+  end
+
+  def test_request_parameters_default_destinations_with_capture_params
+    run_transaction(:capture_params => true) do |txn|
+      txn.merge_request_parameters(:duly => "noted")
+    end
+
+    assert_transaction_trace_has_agent_attribute("request.parameters.duly", "noted")
+    assert_error_has_agent_attribute("request.parameters.duly", "noted")
+
+    refute_event_has_agent_attribute("request.parameters.duly")
+    refute_browser_monitoring_has_agent_attribute("request.parameters.duly")
+  end
+
+  def test_custom_attributes_included
+    run_transaction do
+      Mmtrix::Agent.add_custom_attributes(:foo => 'bar')
+    end
+
+    assert_transaction_tracer_has_custom_attributes('foo', 'bar')
+    assert_transaction_event_has_custom_attributes('foo', 'bar')
+    assert_error_collector_has_custom_attributes('foo', 'bar')
+    assert_browser_monitoring_has_custom_attributes('foo', 'bar')
+  end
+
+  def test_nils_excluded
+    run_transaction do
+      Mmtrix::Agent.add_custom_attributes(:foo => nil)
+    end
+
+    refute_transaction_tracer_has_custom_attributes('foo')
+    refute_transaction_event_has_custom_attributes('foo')
+    refute_error_collector_has_custom_attributes('foo')
+    refute_browser_monitoring_has_custom_attributes('foo')
+  end
+
+  def test_custom_attributes_excluded
+    config = {
+      :'transaction_tracer.attributes.enabled' => false,
+      :'transaction_events.attributes.enabled' => false,
+      :'error_collector.attributes.enabled'    => false,
+      :'browser_monitoring.attributes.enabled' => false
+    }
+
+    run_transaction(config) do
+      Mmtrix::Agent.add_custom_attributes(:foo => 'bar')
+    end
+
+    refute_transaction_tracer_has_custom_attributes('foo')
+    refute_transaction_event_has_custom_attributes('foo')
+    refute_error_collector_has_custom_attributes('foo')
+    refute_browser_monitoring_has_custom_attributes('foo')
+  end
+
+  def test_custom_attributes_excluded_with_global_config
+    run_transaction(:'attributes.enabled' => false) do
+      Mmtrix::Agent.add_custom_attributes(:foo => 'bar')
+    end
+
+    refute_transaction_tracer_has_custom_attributes('foo')
+    refute_transaction_event_has_custom_attributes('foo')
+    refute_error_collector_has_custom_attributes('foo')
+    refute_browser_monitoring_has_custom_attributes('foo')
+  end
+
+  def test_request_parameters_captured_on_transaction_events_when_enabled
+    config = {:'transaction_events.attributes.include' => 'request.parameters.*'}
+    txn_options = {
+      :filtered_params => {:foo => "bar", :bar => "baz"}
+    }
+    run_transaction(config, txn_options)
+
+    assert_event_has_agent_attribute("request.parameters.foo", "bar")
+    assert_event_has_agent_attribute("request.parameters.bar", "baz")
+  end
+
+  def test_request_parameters_captured_in_bam_when_enabled
+    config = {:'browser_monitoring.attributes.include' => 'request.parameters.*'}
+    txn_options = {
+      :filtered_params => {:foo => "bar", :bar => "baz"}
+    }
+    run_transaction(config, txn_options)
+
+    assert_browser_monitoring_has_agent_attribute("request.parameters.foo", "bar")
+    assert_browser_monitoring_has_agent_attribute("request.parameters.bar", "baz")
+  end
+
+  def test_http_response_code_excluded_in_txn_events_when_disabled
+    with_config(:'transaction_events.attributes.exclude' => 'httpResponseCode') do
+      in_web_transaction do |txn|
+        txn.http_response_code = 200
+      end
+    end
+
+    run_harvest
+
+    refute_event_has_attribute('httpResponseCode')
+  end
+
+  def run_transaction(config = {}, txn_options = {})
+    default_config = {
+      :'transaction_tracer.transaction_threshold' => -10,
+      :'transaction_tracer.attributes.enabled' => true,
+      :'transaction_events.attributes.enabled' => true,
+      :'error_collector.attributes.enabled'    => true,
+      :'browser_monitoring.attributes.enabled' => true
+    }
+
+    assert_raises(RuntimeError) do
+      with_config(default_config.merge(config)) do
+        in_transaction(txn_options) do |txn|
+          yield(txn) if block_given?
+
+          # JS instrumentation happens within transaction, so capture it now
+          capture_js_data
+
+          # Have to raise an error to exercise attribute capture there
+          raise "O_o"
+        end
+      end
+    end
+
+    run_harvest
+  end
+end

data/test/multiverse/suites/agent_only/agent_run_id_handling_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 'mmtrix_rpm'
+
+class AgentRunIdHandlingTest < Minitest::Test
+  include MultiverseHelpers
+
+  NON_NUMERIC_RUN_ID = 'some-crazy-non-integer-thing'
+
+  setup_and_teardown_agent do
+    $collector.stub('connect', { "agent_run_id" => NON_NUMERIC_RUN_ID })
+  end
+
+  # This test verifies that the Ruby agent is able to accept non-numeric values
+  # of the agent run ID handed down by the collector in response to the connect
+  # method. This is required for agent protocol version 14.
+  def test_handles_non_numeric_agent_run_ids
+    Mmtrix::Agent.agent.send(:transmit_data)
+    metric_data_post = $collector.calls_for('metric_data').last
+    assert_equal(NON_NUMERIC_RUN_ID, metric_data_post[0])
+  end
+
+  # The sql_data endpoint sends the agent run ID as a query string parameter,
+  # rather than embedded within the body, so make sure we handle that.
+  def test_handles_non_numeric_agent_run_id_on_slow_sql_traces
+    simulate_slow_sql_trace
+    sql_data_post = $collector.calls_for('sql_trace_data').last
+    assert_equal(NON_NUMERIC_RUN_ID, sql_data_post.query_params['run_id'])
+  end
+
+  def simulate_slow_sql_trace
+    in_transaction do
+      agent.sql_sampler.notice_sql("select * from test", "Database/test/select", nil, 1.5)
+    end
+    Mmtrix::Agent.agent.send(:harvest_and_send_slowest_sql)
+  end
+end

data/test/multiverse/suites/agent_only/audit_log_test.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.
+
+# RUBY-981 Audit Log
+
+require 'mmtrix_rpm'
+
+class AuditLogTest < Minitest::Test
+  include MultiverseHelpers
+
+  def setup
+    @string_log = StringIO.new
+    Mmtrix::Agent::AuditLogger.any_instance.stubs(:ensure_log_path).returns(@string_log)
+  end
+
+  def audit_log_contents
+    if @contents.nil?
+      @string_log.rewind
+      @contents = @string_log.read
+    end
+    @contents
+  end
+
+  def test_logs_nothing_by_default
+    run_agent do
+      perform_actions
+      assert_equal('', audit_log_contents)
+    end
+  end
+
+  def test_logs_nothing_when_disabled
+    run_agent(:'audit_log.enabled' => false) do
+      perform_actions
+      assert_equal('', audit_log_contents)
+    end
+  end
+
+  def test_logs_request_bodies_human_readably_ish
+    run_agent(:'audit_log.enabled' => true) do
+      perform_actions
+      format = Mmtrix::Agent::MmtrixService::JsonMarshaller.is_supported? ? :json : :pruby
+      $collector.agent_data.each do |req|
+        assert_audit_log_contains_object(audit_log_contents, req.body, format)
+      end
+    end
+  end
+
+  def perform_actions
+    state = Mmtrix::Agent::TransactionState.tl_get
+    Mmtrix::Agent.instance.sql_sampler.on_start_transaction(state, nil)
+    Mmtrix::Agent.instance.sql_sampler.notice_sql("select * from test",
+                                 "Database/test/select",
+                                 nil, 1.5, state)
+    Mmtrix::Agent.instance.sql_sampler.on_finishing_transaction(state, 'txn')
+    Mmtrix::Agent.instance.send(:harvest_and_send_slowest_sql)
+  end
+end

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

@@ -0,0 +1,87 @@
+# 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 CollectorExceptionHandlingTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent do
+    Mmtrix::Agent.agent.stubs(:sleep)
+  end
+
+  def after_setup
+    # there's a call to sleep in handle_force_restart that we want to skip
+    $collector.reset
+  end
+
+
+  RESTART_PAYLOAD       = { 'error_type' => 'Mmtrix::Agent::ForceRestartException'    }
+  DISCONNECT_PAYLOAD    = { 'error_type' => 'Mmtrix::Agent::ForceDisconnectException' }
+  RUNTIME_ERROR_PAYLOAD = { 'error_type' => 'RuntimeError'                              }
+
+
+  def test_should_reconnect_on_force_restart_exception
+    # We stub these exceptions because we want the EventLoop to exit with a
+    # ForceRestartException the first time through, then (after reconnecting)
+    # we force the disconnect so that this test will end cleanly.
+
+    $collector.stub_exception('metric_data'       , RESTART_PAYLOAD   ).once
+    $collector.stub_exception('get_agent_commands', DISCONNECT_PAYLOAD).once
+
+    with_config(:data_report_period => 0) do
+      Mmtrix::Agent.agent.deferred_work!({})
+    end
+
+    assert_equal(2, $collector.calls_for('connect').size)
+
+    # We expect one metric_data post that the collector responds to with the
+    # ForceRestartException, and then another that gets through successfully.
+    metric_data_calls = $collector.calls_for('metric_data')
+    assert_equal(2, metric_data_calls.size)
+    refute_equal(metric_data_calls[0].run_id, metric_data_calls[1].run_id)
+  end
+
+  def test_should_stop_reporting_after_force_disconnect
+    $collector.stub_exception('metric_data', DISCONNECT_PAYLOAD).once
+
+    with_config(:data_report_period => 0) do
+      Mmtrix::Agent.agent.deferred_work!({})
+    end
+
+    assert_equal(1, $collector.calls_for('connect').size)
+    assert_equal(1, $collector.calls_for('metric_data').size)
+  end
+
+  def test_should_stop_reporting_after_force_disconnect_on_connect
+    $collector.stub_exception('connect', DISCONNECT_PAYLOAD).once
+
+    with_config(:data_report_period => 0) do
+      Mmtrix::Agent.agent.deferred_work!({})
+    end
+
+    assert_equal(1, $collector.calls_for('connect').size)
+  end
+
+  def test_should_reconnect_on_connect_exception
+    $collector.stub_exception('connect', RUNTIME_ERROR_PAYLOAD).once
+    $collector.stub_exception('metric_data', DISCONNECT_PAYLOAD).once
+
+    with_config(:data_report_period => 0) do
+      Mmtrix::Agent.agent.deferred_work!({})
+    end
+
+    assert_equal(2, $collector.calls_for('connect').size)
+  end
+
+  def test_should_reconnect_on_get_redirect_host_exception
+    $collector.stub_exception('get_redirect_host', RUNTIME_ERROR_PAYLOAD).once
+    $collector.stub_exception('metric_data', DISCONNECT_PAYLOAD).once
+
+    with_config(:data_report_period => 0) do
+      Mmtrix::Agent.agent.deferred_work!({})
+    end
+
+    assert_equal(2, $collector.calls_for('get_redirect_host').size)
+    assert_equal(1, $collector.calls_for('connect').size)
+  end
+end