mmtrix_rpm 1.0.0.1

data/test/multiverse/suites/resque/instrumentation_test.rb

@@ -0,0 +1,155 @@
+# 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-669
+
+require 'resque'
+require 'logger'
+require 'mmtrix_rpm'
+require 'fake_collector'
+
+class ResqueTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  class JobForTesting
+    @queue = :resque_test
+    @count = 0
+
+    def self.reset_counter
+      @count = 0
+    end
+
+    def self.count
+      @count
+    end
+
+    def self.perform(name, sleep_duration=0)
+      sleep sleep_duration
+      @count += 1
+    end
+  end
+
+  JOB_COUNT = 5
+  TRANSACTION_NAME = 'OtherTransaction/ResqueJob/ResqueTest::JobForTesting/perform'
+
+  def run_jobs
+    JobForTesting.reset_counter
+
+    # From multiverse, we only run the Resque jobs inline to check that we
+    # are properly instrumenting the methods. Testing of the forking/backgrounding
+    # will be done in our upcoming end-to-end testing suites
+    Resque.inline = true
+
+    with_config(:'transaction_tracer.transaction_threshold' => 0.0) do
+      JOB_COUNT.times do |i|
+        Resque.enqueue(JobForTesting, "testing")
+      end
+    end
+
+    run_harvest
+  end
+
+  def test_all_jobs_ran
+    run_jobs
+    assert_equal(JOB_COUNT, JobForTesting.count)
+  end
+
+  def test_agent_posts_correct_metric_data
+    run_jobs
+    assert_metric_and_call_count('Instance/Busy', 1)
+    assert_metric_and_call_count('OtherTransaction/ResqueJob/all', JOB_COUNT)
+  end
+
+  def test_agent_still_running_after_inline_job
+    run_jobs
+    assert Mmtrix::Agent.instance.started?
+  end
+
+  def test_doesnt_capture_args_by_default
+    run_jobs
+    refute_attributes_on_transaction_traces
+    refute_attributes_on_events
+  end
+
+  def test_isnt_influenced_by_global_capture_params
+    with_config(:capture_params => true) do
+      run_jobs
+    end
+
+    refute_attributes_on_transaction_traces
+    refute_attributes_on_events
+  end
+
+  def test_agent_posts_captured_args_to_job
+    with_config(:'resque.capture_params' => true) do
+      run_jobs
+    end
+
+    assert_attributes_on_transaction_traces
+    refute_attributes_on_events
+  end
+
+  def test_arguments_are_captured_on_transaction_events_when_enabled
+    with_config(:'attributes.include' => 'job.resque.args.*') do
+      run_jobs
+    end
+
+    assert_attributes_on_events
+  end
+
+  def assert_metric_and_call_count(name, expected_call_count)
+    metric_data = $collector.calls_for('metric_data')
+    assert_equal(1, metric_data.size, "expected exactly one metric_data post from agent")
+
+    metric = metric_data.first.metrics.find { |m| m[0]['name'] == name }
+    assert(metric, "could not find metric named #{name}")
+
+    call_count = metric[1][0]
+    assert_equal(expected_call_count, call_count)
+  end
+
+  def assert_attributes_on_transaction_traces
+    transaction_samples = $collector.calls_for('transaction_sample_data')
+    assert_false transaction_samples.empty?
+
+    transaction_samples.each do |post|
+      post.samples.each do |sample|
+        assert_equal sample.metric_name, TRANSACTION_NAME, "Huh, that transaction shouldn't be in there!"
+        assert_equal 'testing', sample.agent_attributes["job.resque.args.0"]
+      end
+    end
+  end
+
+  def refute_attributes_on_transaction_traces
+    transaction_samples = $collector.calls_for('transaction_sample_data')
+    assert_false transaction_samples.empty?
+
+    transaction_samples.each do |post|
+      post.samples.each do |sample|
+        assert_equal sample.metric_name, TRANSACTION_NAME, "Huh, that transaction shouldn't be in there!"
+        assert sample.agent_attributes.keys.none? { |k| k =~ /^job.resque.args.*/ }
+      end
+    end
+  end
+
+  def assert_attributes_on_events
+    event_posts = $collector.calls_for('analytic_event_data')
+    event_posts.each do |post|
+      post.events.each do |event|
+        assert_equal ["job.resque.args.0"], event[2].keys
+      end
+    end
+  end
+
+  def refute_attributes_on_events
+    event_posts = $collector.calls_for('analytic_event_data')
+    event_posts.each do |post|
+      post.events.each do |event|
+        assert event[2].keys.none? { |k| k.start_with?("job.resque.args") }, "Found unexpected resque arguments"
+      end
+    end
+  end
+end

data/test/multiverse/suites/resque/resque_marshalling_test.rb

@@ -0,0 +1,53 @@
+# 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__), '..', '..', '..', 'mmtrix', 'marshalling_test_cases')
+
+if Mmtrix::LanguageSupport.can_fork?
+
+class ResqueMarshallingTest < Minitest::Test
+
+  include MultiverseHelpers
+  include MarshallingTestCases
+
+  setup_and_teardown_agent
+
+  class DummyJob
+    extend Resque::Plugins::MmtrixInstrumentation
+  end
+
+  def invoke_hook(name, *args)
+    hooks = Array(Resque.send(name))
+    hooks.each { |h| h.call(*args) }
+  end
+
+  def around_each
+    invoke_hook(:before_first_fork)
+
+    # We just need something that responds to object_id here, because our
+    # Resque instrumentation uses that to assign a unique identifier to the pipe
+    # that will be used to send data about this job.
+    job = Object.new
+
+    invoke_hook(:before_fork, job)
+
+    child_pid = Process.fork
+
+    if child_pid
+      Process.wait(child_pid)
+    else
+      invoke_hook(:after_fork, job)
+      DummyJob.around_perform_with_monitoring do
+        yield
+      end
+      exit
+    end
+  end
+
+  def after_each
+    Mmtrix::Agent::PipeChannelManager.listener.stop
+  end
+end
+
+end

data/test/multiverse/suites/sequel/Envfile

@@ -0,0 +1,34 @@
+gemfile <<-RB
+  gem 'mmtrix_rpm', :require => false, :path => File.expand_path('../../../../')
+  gem 'jdbc-sqlite3', '3.7.2', :platform => :jruby
+  gem 'sqlite3', :platform => :ruby
+  gem 'sequel', '2.9.0'
+RB
+
+gemfile <<-RB
+  gem 'mmtrix_rpm', :require => false, :path => File.expand_path('../../../../')
+  gem 'jdbc-sqlite3', '3.7.2', :platform => :jruby
+  gem 'sqlite3', :platform => :ruby
+  gem 'sequel', '3.34.0'
+RB
+
+gemfile <<-RB
+  gem 'mmtrix_rpm', :require => false, :path => File.expand_path('../../../../')
+  gem 'jdbc-sqlite3', '3.7.2', :platform => :jruby
+  gem 'sqlite3', :platform => :ruby
+  gem 'sequel', '3.36.1'
+RB
+
+gemfile <<-RB
+  gem 'mmtrix_rpm', :require => false, :path => File.expand_path('../../../../')
+  gem 'jdbc-sqlite3', '3.7.2', :platform => :jruby
+  gem 'sqlite3', :platform => :ruby
+  gem 'sequel', '3.47.0'
+RB
+
+gemfile <<-RB
+  gem 'mmtrix_rpm', :require => false, :path => File.expand_path('../../../../')
+  gem 'jdbc-sqlite3', '3.7.2', :platform => :jruby
+  gem 'sqlite3', :platform => :ruby
+  gem 'sequel', '4.0.0'
+RB

data/test/multiverse/suites/sequel/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/sequel/database.rb

@@ -0,0 +1,57 @@
+# 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 'sequel'
+
+# This file is intended to define the database connection and schema for all of
+# the Sequel multiverse tests.
+#
+# DO NOT require mmtrix_rpm here. Some of the tests rely on the timing of
+# when Mmtrix gets pulled in.
+if !defined?(DB)
+  def jruby?
+    defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+  end
+
+  def create_tables(db)
+    db.create_table( :authors ) do
+      primary_key :id
+      string :name
+      string :login
+    end
+
+    db.create_table( :posts ) do
+      primary_key :id
+      string :title
+      string :content
+      time :created_at
+    end
+
+    db.create_table( :users ) do
+      primary_key :uid
+      string :login
+      string :firstname
+      string :lastname
+    end
+  end
+
+  # Use an in-memory SQLite database
+  if (jruby?)
+    DB = Sequel.connect('jdbc:sqlite::memory:')
+  else
+    DB = Sequel.sqlite
+  end
+
+  create_tables(DB)
+
+  class Author < Sequel::Model; end
+  class Post < Sequel::Model; end
+  class User < Sequel::Model; end
+
+  # Version 4.0 of Sequel moved update_except off to a plugin
+  # So we can test that we still instrument it, it's got to be included
+  if defined?(Sequel::MAJOR) && Sequel::MAJOR >= 4
+    Sequel::Model.plugin :blacklist_security
+  end
+end

data/test/multiverse/suites/sequel/sequel_extension_test.rb

@@ -0,0 +1,142 @@
+# 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__), 'database.rb')
+require File.join(File.dirname(__FILE__), 'sequel_helpers.rb')
+
+if Sequel.const_defined?( :MAJOR ) &&
+      ( Sequel::MAJOR > 3 ||
+        Sequel::MAJOR == 3 && Sequel::MINOR >= 37 )
+
+require 'mmtrix_rpm'
+
+class SequelExtensionTest < Minitest::Test
+  include SequelHelpers
+
+  def setup
+    super
+
+    DB.extension :mmtrix_instrumentation
+
+    @posts = DB[:posts]
+
+    Mmtrix::Agent.disable_all_tracing do
+      post_id = @posts.insert( :title => 'All The Things', :content => 'A nice short story.' )
+      @post = @posts[:id => post_id]
+    end
+  end
+
+  def teardown
+    super
+
+    Mmtrix::Agent.shutdown
+  end
+
+  def expected_metrics_for_operation(operation)
+    [
+      ["Datastore/operation/#{product_name}/#{operation}", "dummy"],
+      "Datastore/operation/#{product_name}/#{operation}",
+      "Datastore/#{product_name}/allWeb",
+      "Datastore/allWeb",
+      "Datastore/#{product_name}/all",
+      "Datastore/all"
+    ]
+  end
+
+  def test_all
+    in_web_transaction { @posts.all }
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:select))
+  end
+
+  def test_find
+    in_web_transaction do
+      @posts[:id => 11]
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:select))
+  end
+
+  def test_model_create_method_generates_metrics
+    in_web_transaction do
+      @posts.insert( :title => 'The Thing', :content => 'A wicked short story.' )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:insert))
+  end
+
+  def test_doesnt_block_constraint_errors
+    first_post = @posts.insert(:title => 'The Thing', :content => 'A wicked short story.')
+    assert_raises(Sequel::DatabaseError) do
+      @posts.insert(:id => first_post, :title => 'Copy Cat', :content => 'A wicked short story.')
+    end
+  end
+
+  def test_update
+    in_web_transaction do
+      @posts.where(:id => @post[:id]).update( :title => 'A Lot of the Things' )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:update))
+  end
+
+  def test_delete
+    in_web_transaction do
+      @posts.where(:id => @post[:id]).delete
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:delete))
+  end
+
+  def test_slow_queries_get_an_explain_plan
+    with_config( :'transaction_tracer.explain_threshold' => -0.01,
+                 :'transaction_tracer.record_sql' => 'raw' ) do
+      node = last_node_for do
+        @posts[:id => 11]
+      end
+      assert_match %r{select \* from `posts` where \(?`id` = 11\)?( limit 1)?}i, node.params[:sql]
+      assert_node_has_explain_plan( node )
+    end
+  end
+
+  def test_sql_is_recorded_in_tt_for_non_select
+    with_config(:'transaction_tracer.record_sql' => 'raw') do
+      node = last_node_for do
+        @posts.insert(:title => 'title', :content => 'content')
+      end
+      assert_match %r{insert into `posts` \([^\)]*\) values \([^\)]*\)}i, node.params[:sql]
+    end
+  end
+
+  def test_queries_can_get_explain_plan_with_obfuscated_sql
+    config = {
+      :'transaction_tracer.explain_threshold' => -0.01,
+      :'transaction_tracer.record_sql' => 'obfuscated'
+    }
+    with_config(config) do
+      node = last_node_for(:record_sql => :obfuscated) do
+        @posts[:id => 11]
+      end
+      assert_match %r{select \* from `posts` where \(?`id` = \?\)?}i, node.params[:sql]
+      assert_node_has_explain_plan( node )
+    end
+  end
+
+  def test_notices_sql_with_proper_metric_name
+    config = {
+      :'transaction_tracer.explain_threshold' => -0.01,
+      :'transaction_tracer.record_sql' => 'obfuscated'
+    }
+    with_config(config) do
+      in_web_transaction { @posts.all }
+      expected_metric_name = "Datastore/operation/#{product_name}/select"
+      recorded_metric_names = Mmtrix::Agent.agent.sql_sampler.sql_traces.values.map(&:database_metric_name)
+      assert_includes recorded_metric_names, expected_metric_name
+    end
+  end
+end
+
+else
+  puts "Skipping tests in #{__FILE__} because unsupported Sequel version"
+end

data/test/multiverse/suites/sequel/sequel_helpers.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.
+
+module SequelHelpers
+  def setup
+    super
+
+    DB.extension :mmtrix_instrumentation
+
+    Mmtrix::Agent.drop_buffered_data
+  end
+
+  def teardown
+    super
+
+    Mmtrix::Agent.shutdown
+  end
+	#
+  # Helpers
+  #
+
+  # Pattern to match the column headers of a Sqlite explain plan
+  SQLITE_EXPLAIN_PLAN_COLUMNS_RE =
+    %r{\|addr\s*\|opcode\s*\|p1\s*\|p2\s*\|p3\s*\|p4\s*\|p5\s*\|comment\s*\|}
+
+  # This is particular to sqlite plans currently. To abstract it up, we'd need to
+  # be able to specify a flavor (e.g., :sqlite, :postgres, :mysql, etc.)
+  def assert_node_has_explain_plan( node, msg=nil )
+    msg = "Expected #{node.inspect} to have an explain plan"
+    assert_block( msg ) { node.params[:explain_plan].join =~ SQLITE_EXPLAIN_PLAN_COLUMNS_RE }
+  end
+
+  def last_node_for(options={})
+      in_transaction('sandwiches/index') do
+        yield
+      end
+      sample = Mmtrix::Agent.instance.transaction_sampler.last_sample
+      sample.prepare_to_send!
+      last_node(sample)
+  end
+
+  def last_node(txn_sample)
+    l_node = nil
+    txn_sample.root_node.each_node do |node|
+      l_node = node
+    end
+    l_node
+  end
+
+  def product_name
+    if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+      "JDBC"
+    else
+      "SQLite"
+    end
+  end
+
+  def assert_datastore_metrics_recorded_exclusive(metrics, options = {})
+    assert_metrics_recorded_exclusive(metrics, {:filter => /^Datastores/}.update(options))
+  end
+end