logical-insight 0.4.0

data/spec/insight/panels/active_record_panel_spec.rb

@@ -0,0 +1,42 @@
+require File::expand_path("../../../spec_helper", __FILE__)
+module Insight
+  describe "ActiveRecordPanel" do
+    before do
+      mock_constant("ActiveRecord::Base")
+      reset_insight :panel_classes => [ActiveRecordPanel]
+    end
+
+    def mock_model(name)
+      model = stub("model")
+      model.stub!(:name => name)
+      obj = stub(name)
+      obj.stub!(:base_class => model)
+      obj
+    end
+
+    describe "heading" do
+      it "displays the total number of instantiated AR objects" do
+        app.before_return do
+          mock_method_call("ActiveRecord::Base", "allocate", [], :class, mock_model("User"))
+          mock_method_call("ActiveRecord::Base", "allocate", [], :class, mock_model("Group"))
+        end
+
+        response = get_via_rack "/"
+        response.should have_heading("2 AR Objects")
+      end
+    end
+
+    describe "content" do
+      it "displays the count of instantiated objects for each class" do
+        app.before_return do
+          mock_method_call("ActiveRecord::Base", "allocate", [], :class, mock_model("User"))
+          mock_method_call("ActiveRecord::Base", "allocate", [], :class, mock_model("User"))
+          mock_method_call("ActiveRecord::Base", "allocate", [], :class, mock_model("Group"))
+        end
+        response = get_via_rack "/"
+        response.should have_row("#active_record", "User", "2")
+        response.should have_row("#active_record", "Group", "1")
+      end
+    end
+  end
+end

data/spec/insight/panels/cache_panel_spec.rb

@@ -0,0 +1,176 @@
+module Insight
+  describe "CachePanel" do
+    before do
+      mock_constant("Rails")
+      mock_constant("Memcached")
+      mock_constant("MemCache")
+      reset_insight :panel_classes => [CachePanel]
+    end
+
+    describe "heading" do
+      it "displays the total memcache time" do
+        response = get_via_rack "/"
+        response.should have_heading("Cache: 0.00ms")
+      end
+    end
+
+    describe "content" do
+      describe "usage table" do
+        it "displays the total number of memcache calls" do
+          app.before_return do
+            mock_method_call("Memcached", "get", ["user:1"])
+          end
+          response = get_via_rack "/"
+
+          # This causes a bus error:
+          # response.should have_selector("th:content('Total Calls') + td", :content => "1")
+
+          response.should have_row("#cache_usage", "Total Calls", "1")
+        end
+
+        it "displays the total memcache time" do
+          response = get_via_rack "/"
+          response.should have_row("#cache_usage", "Total Time", "0.00ms")
+        end
+
+        it "dispays the number of memcache hits" do
+          app.before_return do
+            mock_method_call("Memcached", "get", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_usage", "Hits", "0")
+        end
+
+        it "displays the number of memcache misses" do
+          app.before_return do
+            mock_method_call("Memcached", "get", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_usage", "Misses", "1")
+        end
+
+        it "displays the number of memcache gets" do
+          app.before_return do
+            mock_method_call("Memcached", "get", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_usage", "gets", "1")
+        end
+
+        it "displays the number of memcache sets" do
+
+          app.before_return do
+            mock_method_call("Memcached", "set", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_usage", "sets", "1")
+        end
+
+        it "displays the number of memcache deletes" do
+          app.before_return do
+            mock_method_call("Memcached", "delete", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_usage", "deletes", "1")
+        end
+
+        it "displays the number of memcache get_multis" do
+          app.before_return do
+            mock_method_call("MemCache", "get_multi", ["user:1", "user:2"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_usage", "get_multis", "1")
+        end
+      end
+
+      describe "breakdown" do
+        it "displays each memcache operation" do
+          app.before_return do
+            mock_method_call("Memcached", "get", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_breakdown", "get")
+        end
+
+        it "displays the time for each memcache call" do
+          app.before_return do
+            mock_method_call("Memcached", "get", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_breakdown", "user:1", TIME_MS_REGEXP)
+        end
+
+        it "displays the keys for each memcache call" do
+          app.before_return do
+            mock_method_call("Memcached", "get", ["user:1"])
+          end
+          response = get_via_rack "/"
+          response.should have_row("#cache_breakdown", "user:1", "get")
+        end
+      end
+    end
+
+    describe "cache operations" do
+      before do
+        rack_env "insight.secret_key", 'abc'
+        response = get_via_rack "/"
+      end
+
+
+      describe "expire_all" do
+        it "expires the cache keys" do
+          Rails.stub!(:cache => mock("cache"))
+          Rails.cache.should_receive(:delete).with("user:1")
+          Rails.cache.should_receive(:delete).with("user:2")
+          Rails.cache.should_receive(:delete).with("user:3")
+          Rails.cache.should_receive(:delete).with("user:4")
+
+          get_via_rack "/__insight__/delete_cache_list",
+            :keys_1 => "user:1", :keys_2 => "user:2", :keys_3 => "user:3", :keys_4 => "user:4",
+            :hash => Digest::SHA1.hexdigest("abc:user:1:user:2:user:3:user:4")
+        end
+
+        it "returns OK" do
+          Rails.stub!(:cache => mock("cache", :delete => nil))
+          response = get_via_rack "/__insight__/delete_cache_list",
+            :keys_1 => "user:1", :keys_2 => "user:2", :keys_3 => "user:3", :keys_4 => "user:4",
+            :hash => Digest::SHA1.hexdigest("abc:user:1:user:2:user:3:user:4")
+          response.should contain("OK")
+        end
+      end
+
+      describe "expire" do
+        it "expires the cache key" do
+          Rails.stub!(:cache => mock("cache"))
+          Rails.cache.should_receive(:delete).with("user:1")
+          get_via_rack "/__insight__/delete_cache", :key => "user:1",
+            :hash => Digest::SHA1.hexdigest("abc:user:1")
+        end
+
+        it "returns OK" do
+          Rails.stub!(:cache => mock("cache", :delete => nil))
+          response = get_via_rack "/__insight__/delete_cache", :key => "user:1",
+            :hash => Digest::SHA1.hexdigest("abc:user:1")
+          response.should contain("OK")
+        end
+      end
+
+      describe "view_cache" do
+        it "renders the cache key" do
+          Rails.stub!(:cache => mock("cache", :read => "cache body"))
+          response = get_via_rack "/__insight__/view_cache", :key => "user:1",
+            :hash => Digest::SHA1.hexdigest("abc:user:1")
+          response.should contain("cache body")
+        end
+
+        it "renders non-String cache values properly" do
+          Rails.stub!(:cache => mock("cache", :read => [1, 2]))
+          response = get_via_rack "/__insight__/view_cache", :key => "user:1",
+            :hash => Digest::SHA1.hexdigest("abc:user:1")
+          response.should contain("[1, 2]")
+        end
+      end
+
+    end
+  end
+end

data/spec/insight/panels/log_panel_spec.rb

@@ -0,0 +1,44 @@
+require File::expand_path('../../../spec_helper', __FILE__)
+
+module Insight
+  describe "LogPanel" do
+    before do
+      reset_insight :panel_classes => [LogPanel]
+    end
+
+    describe "heading" do
+      it "displays 'Log'" do
+        response = get_via_rack "/"
+        response.should have_heading("Log")
+      end
+    end
+
+    describe "content" do
+      it "displays recorded log lines" do
+        app.before_return do
+          mock_method_call("Logger", "add", [0, "This is a logged message"])
+        end
+        response = get_via_rack "/"
+        response.should contain("This is a logged message")
+        response.should contain("DEBUG")
+      end
+    end
+
+    describe "Extended Logger" do
+      it "does still return true/false for #add if class Logger" do
+        #AS::BufferedLogger returns the added string, Logger returns true/false
+        LOGGER.add(0, "foo").should  == true
+      end
+    end
+
+
+    describe "With no logger defined" do
+      it "does not err out" do
+        logger = LOGGER
+        Object.send :remove_const, :LOGGER
+        lambda{ load("insight/panels/log_panel.rb") }.should_not raise_error
+        ::LOGGER = logger
+      end
+    end
+  end
+end

data/spec/insight/panels/memory_panel_spec.rb

@@ -0,0 +1,19 @@
+module Insight
+  describe "MemoryPanel" do
+    before do
+      reset_insight :panel => [MemoryPanel]
+    end
+
+    describe "heading" do
+      it "displays the total memory" do
+        response = get_via_rack "/"
+        response.should have_heading(/\d+ KB total/)
+      end
+
+      it "displays the memory change during the request" do
+        response = get_via_rack "/"
+        response.should have_heading(/\d+ KB/)
+      end
+    end
+  end
+end

data/spec/insight/panels/mongo_panel_spec_pending.rb

@@ -0,0 +1,50 @@
+if defined? Mongo
+  module Insight
+    describe "MongoPanel" do
+      before do
+        MongoPanel.reset
+        rack_env "insight.panel_classes", [MongoPanel]
+      end
+
+      describe "heading" do
+        it "displays the total mongo time" do
+          response = get_via_rack "/"
+          response.should have_heading("Mongo: 0.00ms")
+        end
+      end
+
+      describe "content" do
+        describe "usage table" do
+          it "displays the total number of mongo calls" do
+            MongoPanel.record("db.user.user.find()") { }
+            response = get_via_rack "/"
+
+            # This causes a bus error:
+            # response.should have_selector("th:content('Total Calls') + td", :content => "1")
+
+            response.should have_row("#mongo_usage", "Total Calls", "1")
+          end
+
+          it "displays the total mongo time" do
+            response = get_via_rack "/"
+            response.should have_row("#mongo_usage", "Total Time", "0.00ms")
+          end
+        end
+
+        describe "breakdown" do
+          it "displays each mongo operation" do
+            MongoPanel.record("db.user.user.find()") { }
+            response = get_via_rack "/"
+            response.should have_row("#mongo_breakdown", "db.user.user.find()")
+          end
+
+          it "displays the time for mongo call" do
+            MongoPanel.record("db.user.user.find()") { }
+            response = get_via_rack "/"
+            response.should have_row("#mongo_breakdown", "db.user.user.find()", TIME_MS_REGEXP)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/insight/panels/rails_info_panel_spec.rb

@@ -0,0 +1,27 @@
+module Insight
+  describe "RailsInfoPanel" do
+    before do
+      mock_constant("Rails::Info")
+      reset_insight :panel_classes => [RailsInfoPanel]
+
+      Rails::Info.stub!(:properties => [])
+    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/insight/panels/redis_panel_spec.rb

@@ -0,0 +1,66 @@
+require File::expand_path("../../../spec_helper", __FILE__)
+module Insight
+  describe "RedisPanel" do
+    before do
+      reset_insight :panel_files => %w[redis_panel]
+    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/insight/panels/sql_panel_spec.rb

@@ -0,0 +1,145 @@
+require File::expand_path("../../../spec_helper", __FILE__)
+module 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
+        rack_env "insight.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
+        rack_env "insight.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
+        rack_env "insight.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
+        rack_env "insight.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
+        rack_env "insight.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
+        rack_env "insight.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
+        rack_env "insight.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
+        rack_env "insight.secret_key", ""
+
+        lambda {
+          get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",
+          :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+    end
+  end
+end