rails_customerbeats 0.0.4

data/test/dummy/db/migrate/20100106152343_create_metrics.rb

@@ -0,0 +1,17 @@
+class CreateMetrics < ActiveRecord::Migration
+  def self.up
+    create_table :metrics do |t|
+      t.string :name
+      t.integer :request_id
+      t.integer :parent_id
+      t.integer :duration
+      t.text :payload
+      t.datetime :started_at
+      t.datetime :created_at
+    end
+  end
+
+  def self.down
+    drop_table :metrics
+  end
+end

data/test/dummy/db/migrate/20100108120821_create_users.rb

@@ -0,0 +1,13 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/test/integration/instrumentation_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class InstrumentationTest < ActionController::IntegrationTest
+  setup do
+    Metric.delete_all
+  end
+
+  test "rails metrics request is added to notifications" do
+    get "/users"
+    wait
+
+    request = Metric.first
+
+    assert_equal "rack.request", request.name
+    assert (request.duration >= 0)
+    assert_kind_of Time, request.started_at
+    assert_equal Hash[:path => "/users", :method => "GET",
+      :instrumenter_id => ActiveSupport::Notifications.instrumenter.id], request.payload
+  end
+
+  test "processed actions are added to RailsMetrics" do
+    get "/users"
+    wait
+
+    assert_equal 4, Metric.count
+    request, action, sql, template = Metric.all
+
+    assert_equal "action_controller.process_action", action.name
+    assert_equal "active_record.sql", sql.name
+    assert_equal "action_view.render_template", template.name
+
+    assert (action.duration >= 0)
+    assert (sql.duration >= 0)
+    assert (template.duration >= 0)
+
+    assert_kind_of Time, action.started_at
+    assert_kind_of Time, sql.started_at
+    assert_kind_of Time, template.started_at
+
+    assert_equal Hash[:status=>200, :end_point=>"UsersController#index",
+      :formats=>[:html]], action.payload
+
+    assert_equal Hash[:sql => "SELECT `users`.* FROM `users`", 
+      :name => "User Load"], sql.payload
+
+    assert_equal Hash[:identifier => "RAILS_ROOT/app/views/users/index.html.erb",
+      :layout => "RAILS_ROOT/app/views/layouts/users.html.erb"], template.payload
+  end
+
+  test "instrumentations are saved nested in the database" do
+    get "/users"
+    wait
+
+    assert_equal 4, Metric.count
+    request, action, sql, template = Metric.all
+
+    assert_nil request.parent_id
+    assert_equal action.parent_id, request.id
+    assert_equal sql.parent_id, action.id
+    assert_equal template.parent_id, action.id
+
+    assert_equal request.id, request.request_id
+    assert_equal request.id, action.request_id
+    assert_equal request.id, sql.request_id
+    assert_equal request.id, template.request_id
+  end
+
+  test "does not create metrics when accessing /rails_metrics" do
+    assert_no_difference "Metric.count" do
+      get "/rails_metrics"
+      wait
+    end
+  end
+
+  test "fragment cache are added to RailsMetrics" do
+    get "/users/new"
+    wait
+
+    assert_equal 6, Metric.count
+    request, action, template, partial, exist, write = Metric.all
+
+    assert_equal "action_view.render_partial", partial.name
+    assert_equal "action_controller.exist_fragment?", exist.name
+    assert_equal "action_controller.write_fragment", write.name
+
+    assert (partial.duration >= 0)
+    assert (exist.duration >= 0)
+    assert (write.duration >= 0)
+
+    assert_kind_of Time, partial.started_at
+    assert_kind_of Time, exist.started_at
+    assert_kind_of Time, write.started_at
+
+    assert_equal Hash[:identifier => "RAILS_ROOT/app/views/users/_form.html.erb"],
+      partial.payload
+
+    assert_equal Hash[:key => "views/foo.bar"], exist.payload
+    assert_equal Hash[:key => "views/foo.bar"], write.payload
+  end
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+
+class NagivationTest < ActionController::IntegrationTest
+  setup do
+    Metric.delete_all
+    get "/users"
+    wait
+  end
+
+  test "can navigate all notifications" do
+    get "/rails_metrics"
+    click_link "All metrics"
+
+    assert_contain "action_view.render_template"
+    assert_contain "action_controller.process_action"
+    assert_contain ActiveSupport::Notifications.instrumenter.id
+
+    id = Metric.last.id
+
+    within "#rails_customerbeat_#{id}" do
+      click_link "Show"
+    end
+
+    assert_contain "action_view.render_template"
+    click_link "action_view.render_template"
+
+    within "#rails_customerbeat_#{id}" do
+      click_button "Delete"
+    end
+
+    assert_contain "Metric ##{id} was deleted with success"
+
+    get "/rails_metrics/all"
+    assert_not_contain "action_view.render_template"
+  end
+
+  test "can nagivate all metrics with by scopes" do
+    get "/rails_metrics/all"
+
+    click_link "active_record.sql"
+    assert_contain "Showing 1 - 1 of 1 metrics filtered by name"
+
+    click_link "Remove \"Name\" filter"
+    assert_contain "Showing 1 - 4 of 4 metrics"
+  end
+
+  test "can nagivate all metrics with order by scopes" do
+    get "/rails_metrics/all"
+    click_link "Order by latest"
+    assert_contain "ordered by latest"
+
+    click_link "Show"
+    assert_contain "action_view.render_template"
+
+    click_link "Back"
+    click_link "Order by earliest"
+    assert_contain "ordered by earliest"
+
+    click_link "Show"
+    assert_contain "rack.request"
+
+    click_link "Back"
+    click_link "Order by fastest"
+    assert_contain "ordered by fastest"
+
+    click_link "Show"
+    assert_contain Metric.fastest.first.name
+  end
+
+  test "can destroy all notifications in a given scope" do
+    get "/rails_metrics/all"
+    click_link "active_record.sql"
+    assert_contain "Showing 1 - 1 of 1 metrics filtered by name"
+
+    click_button "Delete all"
+    assert_contain "All 1 selected metrics were deleted."
+
+    click_link "All metrics"
+    assert_contain "Showing 1 - 3 of 3 metrics"
+  end
+
+  test "can navigate all metrics with pagination" do
+    get "/rails_metrics/all"
+    assert_contain "Showing 1 - 4 of 4 metrics"
+
+    get "/rails_metrics/all?limit=2"
+    assert_contain "Showing 1 - 2 of 4 metrics"
+
+    click_link "Next"
+    assert_contain "Showing 3 - 4 of 4 metrics"
+
+    assert_raise Webrat::NotFoundError do
+      click_link "Next"
+    end
+
+    click_link "Previous"
+    assert_contain "Showing 1 - 2 of 4 metrics"
+
+    assert_raise Webrat::NotFoundError do
+      click_link "Previous"
+    end
+  end
+end

data/test/orm/active_record_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class ActiveRecordTest < ActiveSupport::TestCase
+  setup do
+    Metric.delete_all
+  end
+
+  test "does not store queries other than SELECT, INSERT, UPDATE and DELETE" do
+    instrument "test.event" do
+      User.connection.send(:select, "SHOW tables;")
+    end
+    wait
+    assert_equal 2, Metric.all.count # one for test.event and other for rack.request
+  end
+
+  test "serializes payload" do
+    metric = Metric.new
+    metric.configure(["metric", Time.now, Time.now, "id", {:foo => :bar}])
+    metric.save!
+    assert_equal Hash[:foo => :bar], metric.payload 
+  end
+
+  test "is invalid when name is blank" do
+    metric = Metric.new
+    assert metric.invalid?
+    assert "can't be blank", metric.errors["name"].join
+  end
+
+  test "is invalid when started_at is blank" do
+    metric = Metric.new
+    assert metric.invalid?
+    assert "can't be blank", metric.errors["started_at"].join
+  end
+
+  test "is invalid when duration is blank" do
+    metric = Metric.new
+    assert metric.invalid?
+    assert "can't be blank", metric.errors["duration"].join
+  end
+
+  test "responds to all required named scopes" do
+    [ :by_name, :by_request_id, :latest,
+      :earliest, :slowest, :fastest, :requests ].each do |method|
+      assert_respond_to Metric, method
+    end
+  end
+end

data/test/payload_parser_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class PayloadParserTest < ActiveSupport::TestCase
+  setup do
+    @_previous_parsers = RailsMetrics::PayloadParser.parsers.dup
+  end
+
+  teardown do
+    RailsMetrics::PayloadParser.parsers.replace @_previous_parsers
+  end
+
+  delegate :add, :ignore, :filter, :to => RailsMetrics::PayloadParser
+
+  test "a non registered parser returns payload as is" do
+    assert_equal Hash[:some => :info], filter("rails_metrics.something", :some => :info)
+  end
+
+  test "a parser with hash converts into method calls" do
+    add "rails_metrics.something", :except => [:foo, :bar]
+    assert_equal Hash[:some => :info], filter("rails_metrics.something", :some => :info,
+                                              :foo => :baz, :bar => :baz)
+  end
+
+  test "a parser with a block calls the block with payload" do
+    add "rails_metrics.something" do |payload|
+      assert_equal Hash[:some => :info], payload
+      { :foo => :bar }
+    end
+    assert_equal Hash[:foo => :bar], filter("rails_metrics.something", :some => :info)
+  end
+
+  test "a parser can be ignored" do
+    ignore "rails_metrics.something"
+    assert_nil filter("rails_metrics.something", :some => :info)
+  end
+end

data/test/rails_customerbeats_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class RailsMetricsTest < ActiveSupport::TestCase
+  setup do
+    RailsMetrics.set_store { MockStore }
+    MockStore.instances.clear
+  end
+
+  test "send instrumentation event to the specified store" do
+    instrument "rails_metrics.something"
+    wait
+  
+    assert_equal 2, MockStore.instances.size
+    assert_equal "rails_metrics.something", MockStore.instances.first.name
+  end
+
+  test "does not send an event to the store if it matches an ignored pattern" do
+    RailsMetrics.ignore_patterns << /rails_metrics/
+
+    begin
+      instrument "rails_metrics.something"
+      wait
+      assert MockStore.instances.none? { |m| m.name == "rails_metrics.something" }
+    ensure
+      RailsMetrics.ignore_patterns.pop
+    end
+  end
+
+  test "does not send an event to the store if it was generated inside it" do
+    instrument "rails_metrics.kicker"
+    wait
+
+    assert_equal 2, MockStore.instances.size
+    assert MockStore.instances.first.kicked?
+    assert_equal "rails_metrics.kicker", MockStore.instances.first.name
+  end
+
+  test "does not send an event if not listening" do
+    ActiveSupport::Notifications.instrument "rails_metrics.kicker"
+    wait
+    assert_equal 0, MockStore.instances.size
+  end
+end

data/test/store_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+class StoreTest < ActiveSupport::TestCase
+  setup do
+    RailsMetrics.set_store { MockStore }
+    MockStore.instances.clear
+  end
+
+  def sample_args
+    time = Time.now
+    ["rails_metrics.example", time, time + 1, 1, { :some => :info }]
+  end
+
+  def store!(args=sample_args)
+    metric = Metric.new
+    metric.configure(args)
+    metric
+  end
+
+  test "sets the name" do
+    assert_equal "rails_metrics.example", store!.name
+  end
+
+  test "sets the duration" do
+    assert_equal 1000000, store!.duration
+    assert_equal 1000000, store!.duration_in_us
+    assert_equal 1000, store!.duration_in_ms
+  end
+
+  test "sets started at" do
+    assert_kind_of Time, store!.started_at
+  end
+
+  test "sets the payload" do
+    assert_equal Hash[:some => :info], store!.payload
+  end
+
+  test "nested instrumentations are saved nested" do
+    instrument "rails_metrics.parent" do
+      instrument "rails_metrics.child" do
+      end
+    end
+
+    instrument "rails_metrics.another"
+
+    assert_equal 5, MockStore.instances.size
+    child, parent, request, another, another_request = MockStore.instances
+
+    assert_equal request.id, request.request_id
+    assert_equal request.id, parent.request_id
+    assert_equal request.id, parent.parent_id
+    assert_equal request.id, child.request_id
+    assert_equal parent.id, child.parent_id
+
+    assert parent.parent_of?(child)
+    assert child.child_of?(parent)
+
+    assert !parent.parent_of?(another)
+    assert !another.parent_of?(parent)
+    assert !parent.child_of?(another)
+    assert !another.child_of?(parent)
+  end
+
+  test "tree can be created from nested instrumentations" do
+    instrument "rails_metrics.parent" do
+      instrument "rails_metrics.child" do
+      end
+    end
+
+    child, parent, request = MockStore.instances
+    root = RailsMetrics.store.mount_tree(MockStore.instances)
+
+    assert_equal "rails_metrics.child", child.name
+    assert_equal "rails_metrics.parent", parent.name
+    assert_equal "rack.request", request.name
+
+    assert root.rack_request?
+    assert [parent], root.children
+    assert [child], parent.children
+  end
+end

data/test/support/helpers.rb

@@ -0,0 +1,16 @@
+class ActiveSupport::TestCase
+  # Execute the block setting the given values and restoring old values after
+  # the block is executed.
+  def swap(object, new_values)
+    old_values = {}
+    new_values.each do |key, value|
+      old_values[key] = object.send key
+      object.send :"#{key}=", value
+    end
+    yield
+  ensure
+    old_values.each do |key, value|
+      object.send :"#{key}=", value
+    end
+  end
+end

data/test/support/instrumentation.rb

@@ -0,0 +1,18 @@
+class ActiveSupport::TestCase
+  def wait
+    RailsMetrics.wait
+  end
+
+  # Fake a request instrumentation.
+  def instrument(*args, &block)
+    if RailsMetrics.listening?
+      ActiveSupport::Notifications.instrument(*args, &block)
+    else
+      RailsMetrics.listen_request do
+        ActiveSupport::Notifications.instrument "rack.request" do
+          ActiveSupport::Notifications.instrument(*args, &block)
+        end
+      end
+    end
+  end
+end

data/test/support/mock_store.rb

@@ -0,0 +1,34 @@
+class ActiveSupport::TestCase
+  class MockStore
+    include RailsMetrics::Store
+
+    attr_accessor :id, :name, :parent_id, :request_id, :started_at, :duration, :payload
+
+    def self.instances
+      @instances ||= []
+    end
+
+    def initialize
+      self.class.instances << self
+    end
+
+    def kicked?
+      @kicked || false
+    end
+
+    def new_record?
+      true
+    end
+
+  protected
+
+    def save_metric!
+      self.id ||= (rand * 1000).to_i
+
+      if self.name == "rails_metrics.kicker"
+        @kicked = true
+        ActiveSupport::Notifications.instrument("rails_metrics.inside_store")
+      end
+    end
+  end
+end

data/test/support/webrat/integrations/rails.rb

@@ -0,0 +1,31 @@
+require 'webrat/core/elements/field'
+
+module Webrat
+  Field.class_eval do
+    def parse_rails_request_params(params)
+      Rack::Utils.parse_nested_query(params)
+    end
+  end
+end
+
+module ActionController #:nodoc:
+  IntegrationTest.class_eval do
+    include Webrat::Methods
+    include Webrat::Matchers
+ 
+    # The Rails version of within supports passing in a model and Webrat
+    # will apply a scope based on Rails' dom_id for that model.
+    #
+    # Example:
+    #   within User.last do
+    #     click_link "Delete"
+    #   end
+    def within(selector_or_object, &block)
+      if selector_or_object.is_a?(String)
+        super
+      else
+        super('#' + RecordIdentifier.dom_id(selector_or_object), &block)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Webrat.configure do |config|
+  config.mode = :rails
+  config.open_error_files = false
+end
+
+# Add support to load paths so we can overwrite broken webrat setup
+$:.unshift File.expand_path('../support', __FILE__)
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+class ActiveSupport::TestCase
+  setup do
+    wait
+    RailsMetrics.set_store { Metric }
+  end
+end