rack-insight 0.5.0

data/spec/rack/insight/panels/speedtracer_panel_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module Rack::Insight
+  describe "SpeedTracerPanel" do
+    before do
+      mock_constant("ActionView::Template")
+      reset_insight :panel_files => %w{speedtracer_panel}
+    end
+
+    describe "heading" do
+      it "lists traces" do
+        response = get_via_rack "/"
+        response.should have_heading("traces")
+      end
+    end
+
+    def mock_template(path)
+      template = stub("ActionView::Template")
+      template.stub!(:virtual_path => path)
+      template
+    end
+
+    describe "content", :pending => "time to build good Speedtracer tests" 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/rack/insight/panels/sql_panel_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+module Rack::Insight
+  describe "SQLPanel" do
+    before do
+      mock_constant("ActiveRecord::ConnectionAdapters::MysqlAdapter")
+      reset_insight :panel_files => %w{sql_panel}
+    end
+
+    describe "heading" do
+      it "displays the total SQL query count" do
+        app.before_return do
+          mock_method_call("ActiveRecord::ConnectionAdapters::MysqlAdapter", "execute", ["SELECT NOW();"])
+        end
+        response = get_via_rack "/"
+        response.should have_heading("1 Queries")
+      end
+
+      it "displays the total SQL time" do
+        app.before_return do
+          mock_method_call("ActiveRecord::ConnectionAdapters::MysqlAdapter", "execute", ["SELECT NOW();"])
+        end
+        response = get_via_rack "/"
+        response.should have_heading(/Queries \(\d+\.\d{2}ms\)/)
+      end
+    end
+
+    describe "content" do
+      it "displays each executed SQL query" do
+        app.before_return do
+          mock_method_call("ActiveRecord::ConnectionAdapters::MysqlAdapter", "execute", ["SELECT NOW();"])
+        end
+        response = get_via_rack "/"
+        response.should have_row("#sql", "SELECT NOW();")
+      end
+
+      it "displays the time of each executed SQL query" do
+        app.before_return do
+          mock_method_call("ActiveRecord::ConnectionAdapters::MysqlAdapter", "execute", ["SELECT NOW();"])
+        end
+        response = get_via_rack "/"
+        response.should have_row("#sql", "SELECT NOW();", TIME_MS_REGEXP)
+      end
+    end
+
+    def stub_result(results = [[]])
+      columns = results.first
+      fields = columns.map { |c| stub("field", :name => c) }
+      rows = results[1..-1]
+
+      result = stub("result", :fetch_fields => fields)
+      result.stub!(:map).and_yield(rows)
+      return result
+    end
+
+    def expect_query(sql, results)
+      conn = stub("connection")
+      mock_constant("ActiveRecord::Base")
+      ActiveRecord::Base.stub!(:connection => conn)
+      conn.should_receive(:execute).with(sql).and_return(stub_result(results))
+    end
+
+    describe "sql/execute" do
+      it "displays the query results" do
+        app.insight_app.secret_key = "abc"
+        expect_query "SELECT username FROM users",
+          [["username"],
+            ["bryan"]]
+
+        response = get_via_rack "/__insight__/sql/execute", {:query => "SELECT username FROM users",
+          :hash => Digest::SHA1.hexdigest("abc:SELECT username FROM users")}, {:xhr => true}
+        response.should contain("SELECT username FROM users")
+        response.should be_ok
+      end
+
+      it "is forbidden when the hash is missing or wrong" do
+        app.insight_app.secret_key='abc'
+
+        lambda {
+          get_via_rack "/__insight__/sql/execute", {:query => "SELECT username FROM users",
+            :hash => "foobar"}, {:xhr => true}
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the insight.secret_key is nil" do
+        app.insight_app.secret_key = nil
+
+        lambda {
+          get_via_rack "/__insight__/sql/execute", {:query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"}, {:xhr => true}
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the insight.secret_key is an empty string" do
+        app.insight_app.secret_key = ""
+
+        lambda {
+          get_via_rack "/__insight__/sql/execute", {:query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"}, {:xhr => true}
+        }.should raise_error(SecurityError)
+      end
+    end
+
+    describe "sql/explain" do
+      it "displays the query explain plan" do
+        app.insight_app.secret_key = "abc"
+        expect_query "EXPLAIN SELECT username FROM users",
+          [["table"],
+            ["users"]]
+
+
+        response = get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",
+          :hash => Digest::SHA1.hexdigest("abc:SELECT username FROM users")
+        response.should contain("SELECT username FROM users")
+        response.should be_ok
+      end
+
+      it "is forbidden when the hash is missing or wrong" do
+        app.insight_app.secret_key='abc'
+
+        lambda {
+          get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",
+          :hash => "foobar"
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the insight.secret_key is nil" do
+        app.insight_app.secret_key=nil
+
+        lambda {
+          get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",
+          :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the insight.secret_key is an empty string" do
+        app.insight_app.secret_key=""
+
+        lambda {
+          get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",
+          :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+    end
+  end
+end

data/spec/rack/insight/panels/templates_panel_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module Rack::Insight
+  describe "TemplatesPanel" do
+    before do
+      mock_constant("ActionView::Template")
+      reset_insight :panel_classes => [Rack::Insight::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/rack/insight/panels/timer_panel_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Rack::Insight
+  describe "TimerPanel" do
+    before do
+      reset_insight :panel_classes => [Rack::Insight::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/rcov.opts

@@ -0,0 +1 @@
+-x gems,spec\/

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+require "rubygems"
+require "webrat"
+require "rack/test"
+
+RAILS_ENV = "test"
+
+#$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__)) + '/lib'
+#$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+
+require "rack-insight"
+require "fixtures/sample_app"
+require "fixtures/dummy_panel"
+require "rack/insight/rspec_matchers"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # TODO: Turn this on.  Currently off because the specs bleed, and will randomly fail when run randomly.
+  #config.order = 'random'
+
+  TIME_MS_REGEXP = /\d+\.\d{2}ms/
+
+  config.include Rack::Test::Methods
+  config.include Webrat::Matchers
+  config.include Rack::Insight::RspecMatchers
+
+  config.before do
+    Thread.current["rack-insight.logger"] = Rack::Insight::Logger.new(Logger::FATAL, "")
+    @added_constants = []
+  end
+
+  config.after do
+    @added_constants.each do |parent, added|
+      parent.send :remove_const, added
+    end
+    @added_constants.clear
+  end
+
+  def reset_insight(options=nil)
+    system(*%w{rm -f rack-insight.sqlite})
+
+    Rack::Insight::Database.reset
+
+    app.prototype
+    app.insight_app.reset(options)
+
+    Rack::Insight.enable
+
+    set_cookie "rack-insight_enabled=1"
+  end
+
+  def reset_config(config_options = {:panel_load_paths => [File::join('rack', 'insight', 'panels')]})
+    Rack::Insight::Config.configure do |config|
+      # spec folder is in the load path during specs!
+      config[:panel_load_paths] = config_options[:panel_load_paths]
+    end
+  end
+
+  def app
+    SampleApp
+  end
+
+  def mock_constant(name)
+    parts = name.split("::")
+    klass = parts.pop
+    mod = parts.inject(Object) do |const, part|
+      begin
+        const.const_get(part)
+      rescue NameError
+        @added_constants << [const, part]
+        mod = Module.new
+        const.const_set(part.to_sym, mod)
+        mod
+      end
+    end
+    begin
+      mod.const_get(klass)
+    rescue NameError
+      mod.const_set(klass, Class.new)
+    end
+  end
+
+  def mock_method_call(context, method, args=[], kind=:instance, object=Object.new, &block)
+    mock_constant(context)
+
+    called_at = caller[0]
+    file, line, real_method = called_at.split(":")
+    called_at = [file,line,method].join(":")
+
+    block ||= proc {}
+
+    Rack::Insight::Instrumentation::Probe::ProbeRunner.probe_run(
+      object, context, kind, args, called_at, method, &block)
+  end
+
+  def rack_env(key, value)
+    @rack_env ||= {}
+    @rack_env[key] = value
+  end
+
+  def get_via_rack(uri, params = {}, env = {}, &block)
+    env = env.merge(@rack_env) if @rack_env
+    get(uri, params, env, &block)
+  end
+end