rack-bug-rails-3 0.3.0

data/spec/rack/bug/panels/rails_info_panel_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+class Rack::Bug
+  describe RailsInfoPanel do
+    before do
+      rack_env "rack-bug.panel_classes", [RailsInfoPanel]
+
+      unless defined?(Rails)
+        @added_rails = true
+        Object.const_set :Rails, Module.new
+        Rails::Info = Class.new do
+          def self.properties
+            []
+          end
+        end
+      end
+    end
+
+    after do
+      Object.send :remove_const, :Rails if @added_rails
+    end
+
+    describe "heading" do
+      it "displays the Rails version" do
+        Rails.stub!(:version => "v2.3.0")
+        response = get_via_rack "/"
+        response.should have_heading("Rails v2.3.0")
+      end
+    end
+
+    describe "content" do
+      it "displays the Rails::Info properties" do
+        Rails.stub!(:version => "v2.3.0")
+        Rails::Info.stub!(:properties => [["Name", "Value"]])
+        response = get_via_rack "/"
+        response.should have_row("#rails_info", "Name", "Value")
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/redis_panel_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+$LOADED_FEATURES << "redis.rb" #avoid dependency on redis
+
+class Rack::Bug
+  describe RedisPanel do
+    before do
+      RedisPanel.reset
+      rack_env "rack-bug.panel_classes", [RedisPanel]
+    end
+
+    describe "heading" do
+      it "displays the total redis time" do
+        response = get_via_rack "/"
+        response.should have_heading("Redis: 0.00ms")
+      end
+    end
+
+    describe "content" do
+      describe "usage table" do
+        it "displays the total number of redis calls" do
+          RedisPanel.record(["get, user:1"], Kernel.caller) { }
+          response = get_via_rack "/"
+
+          # This causes a bus error:
+          # response.should have_selector("th:content('Total Calls') + td", :content => "1")
+
+          response.should have_row("#redis_usage", "Total Calls", "1")
+        end
+
+        it "displays the total redis time" do
+          response = get_via_rack "/"
+          response.should have_row("#redis_usage", "Total Time", "0.00ms")
+        end
+      end
+
+      describe "breakdown" do
+        it "displays each redis operation" do
+          RedisPanel.record(["get, user:1"], Kernel.caller) { }
+          response = get_via_rack "/"
+          response.should have_row("#redis_breakdown", "get")
+        end
+
+        it "displays the time for redis call" do
+          RedisPanel.record(["get, user:1"], Kernel.caller) { }
+          response = get_via_rack "/"
+          response.should have_row("#redis_breakdown", "user:1", TIME_MS_REGEXP)
+        end
+
+        it "displays the arguments for each redis call" do
+          RedisPanel.record(["get, user:1"], Kernel.caller) { }
+          response = get_via_rack "/"
+          response.should have_row("#redis_breakdown", "user:1", "get")
+        end
+
+        it "displays a link to show the backtrace when it's available" do
+          RedisPanel.record(["get, user:1"], Kernel.caller) { }
+          response = get_via_rack "/"
+          response.should have_row("#redis_breakdown", "user:1", "Show Backtrace")
+        end
+
+        it "does not display a link to show the backtrace when it's not available" do
+          RedisPanel.record(["get, user:1"], []) { }
+          response = get_via_rack "/"
+          response.should_not contain("Show Backtrace")
+        end
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/sql_panel_spec.rb

@@ -0,0 +1,146 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+class Rack::Bug
+  describe SQLPanel do
+    before do
+      SQLPanel.reset
+      rack_env "rack-bug.panel_classes", [SQLPanel]
+
+      unless defined?(ActiveRecord)
+        @added_rails = true
+        Object.const_set :ActiveRecord, Module.new
+        ActiveRecord.const_set :Base, Class.new
+      end
+    end
+    
+    after do
+      Object.send :remove_const, :ActiveRecord if @added_active_record
+    end
+
+    describe "heading" do
+      it "displays the total SQL query count" do
+        SQLPanel.record("SELECT NOW();") { }
+        response = get_via_rack "/"
+        response.should have_heading("1 Queries")
+      end
+
+      it "displays the total SQL time" do
+        SQLPanel.record("SELECT NOW();") { }
+        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
+        SQLPanel.record("SELECT NOW();") { }
+        response = get_via_rack "/"
+        response.should have_row("#sql", "SELECT NOW();")
+      end
+
+      it "displays the time of each executed SQL query" do
+        SQLPanel.record("SELECT NOW();") { }
+        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!(:each).and_yield(*rows)
+      return result
+    end
+
+    def expect_query(sql, results)
+      conn = stub("connection")
+      ActiveRecord::Base.stub!(:connection => conn)
+      conn.should_receive(:execute).with(sql).and_return(stub_result(results))
+    end
+
+    describe "execute_sql" do
+      it "displays the query results" do
+        rack_env "rack-bug.secret_key", "abc"
+        expect_query "SELECT username FROM users",
+          [["username"],
+           ["bryan"]]
+
+        response = get_via_rack "/__rack_bug__/execute_sql", {:query => "SELECT username FROM users",
+          :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"}, {: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
+        rack_env "rack-bug.secret_key", 'abc'
+
+        lambda {
+          get_via_rack "/__rack_bug__/execute_sql", {:query => "SELECT username FROM users",
+            :hash => "foobar"}, {:xhr => true}
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the rack-bug.secret_key is nil" do
+        rack_env "rack-bug.secret_key", nil
+
+        lambda {
+          get_via_rack "/__rack_bug__/execute_sql", {:query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"}, {:xhr => true}
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the rack-bug.secret_key is an empty string" do
+        rack_env "rack-bug.secret_key", ""
+
+        lambda {
+          get_via_rack "/__rack_bug__/execute_sql", {:query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"}, {:xhr => true}
+        }.should raise_error(SecurityError)
+      end
+    end
+
+    describe "explain_sql" do
+      it "displays the query explain plan" do
+        rack_env "rack-bug.secret_key", "abc"
+        expect_query "EXPLAIN SELECT username FROM users",
+          [["table"],
+           ["users"]]
+
+        response = get_via_rack "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+          :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        response.should contain("SELECT username FROM users")
+        response.should be_ok
+      end
+
+      it "is forbidden when the hash is missing or wrong" do
+        rack_env "rack-bug.secret_key", 'abc'
+
+        lambda {
+          get_via_rack "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+            :hash => "foobar"
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the rack-bug.secret_key is nil" do
+        rack_env "rack-bug.secret_key", nil
+
+        lambda {
+          get_via_rack "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+
+      it "is not available when the rack-bug.secret_key is an empty string" do
+        rack_env "rack-bug.secret_key", ""
+
+        lambda {
+          get_via_rack "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+class Rack::Bug
+  describe TemplatesPanel do
+    before do
+      TemplatesPanel.reset
+      rack_env "rack-bug.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
+
+    describe "content" do
+      it "displays the template paths" do
+        TemplatesPanel.record("users/show") { }
+        response = get_via_rack "/"
+        response.should contain("users/show")
+      end
+
+      it "displays the template children" do
+        TemplatesPanel.record("users/show") do
+          TemplatesPanel.record("users/toolbar") { }
+        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
+          TemplatesPanel.record("users/show") do
+            TemplatesPanel.record("users/toolbar") { }
+          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
+          TemplatesPanel.record("users/show") do
+            TemplatesPanel.record("users/toolbar") { }
+          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
+          TemplatesPanel.record("users/show") { }
+
+          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/bug/panels/timer_panel_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+class Rack::Bug
+  describe TimerPanel do
+    before do
+      rack_env "rack-bug.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/rack/bug_spec.rb

@@ -0,0 +1,137 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rack::Bug do
+  it "inserts the Rack::Bug toolbar" do
+    response = get "/"
+    response.should have_selector("div#rack_bug")
+  end
+
+  it "updates the Content-Length" do
+    response = get "/"
+    response["Content-Length"].should == response.body.size.to_s
+  end
+
+  it "serves the Rack::Bug assets under /__rack_bug__/" do
+    response = get "/__rack_bug__/bug.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#rack_bug")
+  end
+
+  it "does not modify XMLHttpRequest responses" do
+    response = get "/", {}, { :xhr => true }
+    response.should_not have_selector("div#rack_bug")
+  end
+
+  it "modifies XHTML responses" do
+    response = get "/", :content_type => "application/xhtml+xml"
+    response.should have_selector("div#rack_bug")
+  end
+
+  it "does not modify non-HTML responses" do
+    response = get "/", :content_type => "text/csv"
+    response.should_not have_selector("div#rack_bug")
+  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#rack_bug")
+  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#rack_bug")
+     end
+    
+    it "does not insert the toolbar if even toolbar requested" do
+      response = get "/redirect"
+      response.should_not have_selector("div#rack_bug")
+     end
+  end
+  
+  context "redirected when configured to intercept redirects" do
+    it "shows the interception page" do
+      response = get "/redirect", {}, "rack-bug.intercept_redirects" => true
+      response.should have_selector("div#rack_bug")
+    end
+
+    it "should provide a link to the target URL" do
+      response = get "/redirect", {}, "rack-bug.intercept_redirects" => true
+      response.should have_selector("a[href='/']")
+    end
+    
+    it "inserts the toolbar if requested" do
+      response = get "/redirect", {}, "rack-bug.intercept_redirects" => true
+      response.should have_selector("div#rack_bug")
+    end
+    
+    it "does not inserts the toolbar if not requested" do
+      header 'cookie', ""
+      response = get "/redirect", {}, "rack-bug.intercept_redirects" => true
+      response.should_not have_selector("div#rack_bug")
+    end
+  end
+
+  context "configured with an IP address restriction" do
+    before do
+      rack_env "rack-bug.ip_masks", [IPAddr.new("127.0.0.1/255.255.255.0")]
+    end
+
+    it "inserts the Rack::Bug toolbar when the IP matches" do
+      response = get_via_rack "/", {}, "REMOTE_ADDR" => "127.0.0.2"
+      response.should have_selector("div#rack_bug")
+    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#rack_bug")
+    end
+
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      rack_env "rack-bug.panel_classes", [DummyPanel]
+      get_via_rack "/", {}, "REMOTE_ADDR" => "128.0.0.1"
+    end
+  end
+
+  context "configured with a password" do
+    before do
+      rack_env "rack-bug.password", "secret"
+    end
+
+    it "inserts the Rack::Bug toolbar when the password matches" do
+      sha = "545049d1c5e2a6e0dfefd37f9a9e0beb95241935"
+      set_cookie ["rack_bug_enabled=1", "rack_bug_password=#{sha}"]
+      response = get_via_rack "/"
+      response.should have_selector("div#rack_bug")
+    end
+
+    it "is disabled when the password doesn't match" do
+      response = get_via_rack "/"
+      response.should_not have_selector("div#rack_bug")
+    end
+
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      rack_env "rack-bug.panel_classes", [DummyPanel]
+      get_via_rack "/"
+    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,44 @@
+require "rubygems"
+require "spec"
+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/bug"
+require "spec/fixtures/sample_app"
+require "spec/fixtures/dummy_panel"
+require "spec/custom_matchers"
+
+Spec::Runner.configure do |config|
+  TIME_MS_REGEXP = /\d+\.\d{2}ms/
+
+  config.include Rack::Test::Methods
+  config.include Webrat::Matchers
+  config.include CustomMatchers
+
+  config.before do
+    # This allows specs to record data outside the request
+    Rack::Bug.enable
+
+    # Set the cookie that triggers Rack::Bug under normal conditions
+    set_cookie "rack_bug_enabled=1"
+  end
+
+  def app
+    SampleApp
+  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