logical-insight 0.4.0

data/spec/insight/panels/templates_panel_spec.rb

@@ -0,0 +1,84 @@
+module Insight
+  describe "TemplatesPanel" do
+    before do
+      mock_constant("ActionView::Template")
+      reset_insight :panel_classes => [TemplatesPanel]
+    end
+
+    describe "heading" do
+      it "displays the total rendering time" do
+        response = get_via_rack "/"
+        response.should have_heading("Templates: 0.00ms")
+      end
+    end
+
+    def mock_template(path)
+      template = stub("ActionView::Template")
+      template.stub!(:virtual_path => path)
+      template
+    end
+
+    describe "content" do
+      it "displays the template paths" do
+        app.before_return do
+          mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/show"))
+        end
+        response = get_via_rack "/"
+        response.should contain("users/show")
+      end
+
+      it "displays the template children" do
+        app.before_return do
+          mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/show")) do
+            mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/toolbar"))
+          end
+        end
+        response = get_via_rack "/"
+        response.should have_selector("li", :content => "users/show") do |li|
+          li.should contain("users/toolbar")
+        end
+      end
+
+      context "for templates that rendered templates" do
+        it "displays the total time" do
+          app.before_return do
+            mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/show")) do
+              mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/toolbar"))
+            end
+          end
+
+          response = get_via_rack "/"
+          response.should have_selector("li", :content => "users/show") do |li|
+            li.should contain(TIME_MS_REGEXP)
+          end
+        end
+
+        it "displays the exclusive time" do
+          app.before_return do
+            mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/show")) do
+              mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/toolbar"))
+            end
+          end
+
+          response = get_via_rack "/"
+          response.should have_selector("li", :content => "users/show") do |li|
+            li.should contain(/\d\.\d{2} exclusive/)
+          end
+        end
+      end
+
+      context "for leaf templates" do
+        it "does not display the exclusive time" do
+          app.before_return do
+            mock_method_call("ActionView::Template", :render, [], :instance, mock_template("users/show"))
+          end
+
+          response = get_via_rack "/"
+          response.should contain("users/show") do |li|
+            li.should_not contain("exclusive")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/insight/panels/timer_panel_spec.rb

@@ -0,0 +1,36 @@
+module Insight
+  describe "TimerPanel" do
+    before do
+      reset_insight :panel_classes => [TimerPanel]
+    end
+
+    describe "heading" do
+      it "displays the elapsed time" do
+        response = get_via_rack "/"
+        response.should have_heading(TIME_MS_REGEXP)
+      end
+    end
+
+    describe "content" do
+      it "displays the user CPU time" do
+        response = get_via_rack "/"
+        response.should have_row("#timer", "User CPU time", TIME_MS_REGEXP)
+      end
+
+      it "displays the system CPU time" do
+        response = get_via_rack "/"
+        response.should have_row("#timer", "System CPU time", TIME_MS_REGEXP)
+      end
+
+      it "displays the total CPU time" do
+        response = get_via_rack "/"
+        response.should have_row("#timer", "Total CPU time", TIME_MS_REGEXP)
+      end
+
+      it "displays the elapsed time" do
+        response = get_via_rack "/"
+        response.should have_row("#timer", "Elapsed time", TIME_MS_REGEXP)
+      end
+    end
+  end
+end

data/spec/insight_spec.rb

@@ -0,0 +1,141 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'logical-insight'
+
+describe Insight do
+  before :each do
+    reset_insight
+  end
+
+  it "inserts the Insight toolbar" do
+    response = get "/"
+    response.should have_selector("div#insight")
+  end
+
+  it "updates the Content-Length" do
+    response = get "/"
+    response["Content-Length"].should == response.body.size.to_s
+  end
+
+  it "serves the Insight assets under /__insight__/" do
+    response = get "/__insight__/insight.css"
+    response.should be_ok
+  end
+
+  it "modifies HTML responses with a charset" do
+    response = get "/", :content_type => "application/xhtml+xml; charset=utf-8"
+    response.should have_selector("div#insight")
+  end
+
+  it "does not modify XMLHttpRequest responses" do
+    response = get "/", {}, { :xhr => true }
+    response.should_not have_selector("div#insight")
+  end
+
+  it "modifies XHTML responses" do
+    response = get "/", :content_type => "application/xhtml+xml"
+    response.should have_selector("div#insight")
+  end
+
+  it "does not modify non-HTML responses" do
+    response = get "/", :content_type => "text/csv"
+    response.should_not have_selector("div#insight")
+  end
+
+  it "does not modify server errors" do
+    app.disable :raise_errors
+    response = get "/error"
+    app.enable :raise_errors
+    response.should_not have_selector("div#insight")
+  end
+
+  context "redirected when not configured to intercept redirects" do
+    it "passes the redirect unmodified" do
+      response = get "/redirect"
+      response.status.should == 302
+    end
+
+    it "does not show the interception page" do
+      response = get "/redirect"
+      response.body.should_not contain("Location: /")
+    end
+
+    it "does not insert the toolbar" do
+      header 'cookie', ""
+      response = get "/redirect"
+      response.should_not have_selector("div#insight")
+    end
+
+    it "does not insert the toolbar if even toolbar requested" do
+      response = get "/redirect"
+      response.should_not have_selector("div#insight")
+    end
+  end
+
+  context "redirected when configured to intercept redirects" do
+    it "shows the interception page" do
+      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response.should have_selector("div#insight")
+    end
+
+    it "should provide a link to the target URL" do
+      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response.should have_selector("a[href='http://example.org/']")
+    end
+
+    it "inserts the toolbar if requested" do
+      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response.should have_selector("div#insight")
+    end
+
+    it "does not inserts the toolbar if not requested" do
+      header 'cookie', ""
+      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response.should_not have_selector("div#insight")
+    end
+  end
+
+  context "configured with an IP address restriction" do
+    before do
+      rack_env "insight.ip_masks", [IPAddr.new("127.0.0.1/255.255.255.0")]
+    end
+
+    it "inserts the Insight toolbar when the IP matches" do
+      response = get_via_rack "/", {}, "REMOTE_ADDR" => "127.0.0.2"
+      response.should have_selector("div#insight")
+    end
+
+    it "is disabled when the IP doesn't match" do
+      response = get_via_rack "/", {}, "REMOTE_ADDR" => "128.0.0.1"
+      response.should_not have_selector("div#insight")
+    end
+
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      rack_env "insight.panel_classes", [DummyPanel]
+      get_via_rack "/", {}, "REMOTE_ADDR" => "128.0.0.1"
+    end
+  end
+
+  context "configured with a password" do
+    before do
+      rack_env "insight.password", "secret"
+    end
+
+    it "should insert the Insight toolbar when the password matches" do
+      sha = Digest::SHA1.hexdigest ["insight", "secret"].join(":")
+      set_cookie ["insight_enabled=1", "insight_password=#{sha}"]
+      response = get_via_rack "/"
+      response.should have_selector("div#insight")
+    end
+
+    it "should be disabled when the password doesn't match" do
+      response = get_via_rack "/"
+      response.should_not have_selector("div#insight")
+    end
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      rack_env "insight.panel_classes", [DummyPanel]
+      get_via_rack "/"
+    end
+  end
+end

data/spec/instrumentation_spec.rb

@@ -0,0 +1,188 @@
+require 'insight/instrumentation'
+require 'insight/instrumentation/setup'
+
+class One
+  def initialize(arry)
+    @array = arry
+  end
+
+  def self.record_self(array)
+    array << self
+  end
+
+  def self.a_class_method(array)
+    yield(array)
+  end
+
+  def an_instance_method()
+    yield(@array)
+  end
+end
+
+module Mod
+  def module_method(array)
+    yield(array)
+  end
+end
+
+class Two < One
+  def an_instance_method
+    super
+  end
+
+  def self.a_class_method(array)
+    super
+  end
+end
+
+describe "Setting up probes" do
+  let :method_calls do [] end
+  let :method_subject do [] end
+  let :recording_list do [] end
+
+  let :test_collector do
+    collector = Object.new
+    collector.extend Insight::Instrumentation::Client
+    collector.instance_variable_set("@calls", method_calls)
+    def collector.after_detect(method_call, timing, arguments, results)
+      @calls << [method_call, timing, arguments, results]
+    end
+    collector
+  end
+
+  let :instrument_setup do
+    Insight::Instrumentation::Setup.new(nil)
+  end
+
+  let :fake_env do
+    {}
+  end
+
+  before :each do
+    test_collector.probe(test_collector) do
+      instrument "One" do
+        instance_probe :an_instance_method
+        class_probe :a_class_method
+        class_probe :record_self
+        class_probe :allocate
+      end
+    end
+    instrument_setup.setup(fake_env)
+  end
+
+  after :each do
+    instrument_setup.teardown(fake_env, 200, {}, "")
+  end
+
+  # Test cases:
+  #
+  # Methods are called on
+  #   instance
+  #   class
+  #   modules
+  #
+  # Methods are defined/probed at/called on
+  # Called on:
+  #   obj: instance of class C
+  #
+  # Defined:
+  #   class C
+  #   super class B
+  #   class C and parent B (overridden)
+  #   module Mc - included in C
+  #   class C and Mc
+  #   module Mb - included in B
+  #   class C and Mb
+  #   module Me - extended in obj
+  #   Me and C - Me overrides C
+  #
+  # Probed:
+  #   On C
+  #   On B
+  #   On Mc, Mb, Me
+  #
+  # Not interfere with:
+  #   Arguments
+  #   Blocks
+  #   Return Values
+  #   Exceptions
+  #
+
+  it "should catch class methods defined on a superclass" do
+    #expect do
+      One.allocate
+    #end.to change(method_calls.length).by(1)
+    method_calls.last[0].method.should == :allocate
+  end
+
+  it "should not interfere with instance method call on One" do
+    expect do
+      One.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should not interfere with class method call" do
+    expect do
+      One.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should collect calls made on One#an_instance_method" do
+    expect do
+      One.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(1)
+    method_calls.last[0].method.should == :an_instance_method
+  end
+
+  it "should collect calls made on One#a_class_method" do
+    expect do
+      One.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(1)
+    method_calls.last[0].method.should == :a_class_method
+  end
+
+  it "should not mess with receive of class methods" do
+    One.record_self(recording_list)
+    recording_list.should include(One)
+  end
+
+  it "should not mess with receive of class methods on subclasses" do
+    Two.record_self(recording_list)
+    recording_list.should include(Two)
+  end
+
+
+  it "should not interfere with instance method call on Two" do
+    expect do
+      Two.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should not interfere with class method call" do
+    expect do
+      Two.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should collect calls made on Two#an_instance_method" do
+    expect do
+      Two.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(2)
+    method_calls.each do |method_call|
+      method_call[0].method.should == :an_instance_method
+    end
+
+    method_calls.map{|mc| mc[0].context}.should include("One", "Two")
+  end
+
+  it "should collect calls made on Two#a_class_method" do
+    expect do
+      Two.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(2)
+    method_calls.each do |method_call|
+      method_call[0].method.should == :a_class_method
+    end
+
+    method_calls.map{|mc| mc[0].context}.should include("One", "Two")
+  end
+end