rackamole 0.0.1

data/samples/rails/moled/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/samples/rails/moled/script/about

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+$LOAD_PATH.unshift "#{RAILTIES_PATH}/builtin/rails_info"
+require 'commands/about'

data/samples/rails/moled/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/console'

data/samples/rails/moled/script/dbconsole

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/dbconsole'

data/samples/rails/moled/script/destroy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/destroy'

data/samples/rails/moled/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/generate'

data/samples/rails/moled/script/performance/benchmarker

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/benchmarker'

data/samples/rails/moled/script/performance/profiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/profiler'

data/samples/rails/moled/script/plugin

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/plugin'

data/samples/rails/moled/script/runner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/runner'

data/samples/rails/moled/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/server'

data/samples/rails/moled/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/samples/rails/moled/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/samples/sinatra/moled.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'sinatra'
+require 'rackamole'
+
+configure do
+  set :sessions, true
+  set :environment, :development
+  use Rack::Reloader
+  use Rack::Mole, { :app_name => "My Sinatra App", :user_key => :user_name }
+end
+
+before do
+  session[:user_name] = "Fernand"
+end
+
+get '/fred' do  
+  @blee = "No shit"
+  session[:fred] = "duh me"
+  "<h1>Hello World</h1>"
+end

data/spec/expected_results/mole_exception.log

@@ -0,0 +1,17 @@
+----------------------------------------------------------------------------------------------------
+MOLED EXCEPTION
+App_name             : "Test app"
+Environment          : :test
+Perf_issue           : false
+Ip                   : "1.1.1.1"
+Browser              : "Ibrowse"
+User_id              : 100
+User_name            : "Fernand"
+Request_time         : 1.0
+Url                  : "http://test_me/"
+Path                 : "/fred"
+Method               : "GET"
+Params               : {:blee=>"\"duh\""}
+Session              : {:fred=>"10"}
+Stack                : ["Oh snap!"]
+Ruby_version         : "ruby 1.8.6 (2007-03-13 patchlevel 0) [i686-darwin8.10.1]"

data/spec/expected_results/mole_feature.log

@@ -0,0 +1,15 @@
+----------------------------------------------------------------------------------------------------
+MOLED FEATURE
+App_name             : "Test app"
+Environment          : :test
+Perf_issue           : false
+Ip                   : "1.1.1.1"
+Browser              : "Ibrowse"
+User_id              : 100
+User_name            : "Fernand"
+Request_time         : 1.0
+Url                  : "http://test_me/"
+Path                 : "/fred"
+Method               : "GET"
+Params               : {:blee=>"\"duh\""}
+Session              : {:fred=>"10"}

data/spec/expected_results/mole_perf.log

@@ -0,0 +1,16 @@
+----------------------------------------------------------------------------------------------------
+MOLED PERFORMANCE
+App_name             : "Test app"
+Environment          : :test
+Perf_issue           : false
+Ip                   : "1.1.1.1"
+Browser              : "Ibrowse"
+User_id              : 100
+User_name            : "Fernand"
+Request_time         : 1.0
+Url                  : "http://test_me/"
+Path                 : "/fred"
+Method               : "GET"
+Params               : {:blee=>"\"duh\""}
+Session              : {:fred=>"10"}
+Performance          : true

data/spec/rackamole/interceptor_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+require 'ostruct'
+
+describe Rackamole::Interceptor do    
+  before( :all ) do
+    class Fred
+      def rescue_action_in_public( exception )
+      end
+    
+      def request
+        @request ||= OpenStruct.new( :env => {} )
+      end
+      
+      def self.alias_method_chain(target, feature)
+        alias_method "#{target}_without_#{feature}", target
+        alias_method target, "#{target}_with_#{feature}"
+      end
+    
+      include Rackamole::Interceptor      
+    end
+  end
+    
+  it "should include the correct methods" do    
+    Fred.instance_methods.should be_include( 'rescue_action_in_public_without_mole' )    
+    Fred.private_instance_methods.should be_include( 'rescue_action_in_public_with_mole' )
+  end
+    
+  it "should set the env correctly when an exception is raised" do
+    fred = Fred.new
+    fred.send( :rescue_action_in_public, "Fred" )
+    fred.request.env['mole.exception'].should == "Fred"
+  end
+end

data/spec/rackamole/logger_spec.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper] )
+
+require 'stringio'          
+
+describe Rackamole::Logger do
+  it "raises an error if the email addresses passed in is empty" do
+    lambda { Rackamole::Logger.new( { :email_alerts_to => [] } ) }.should raise_error( Rackamole::Logger::ConfigurationError )
+  end
+
+  it "configures an email appender if :email_alerts is set" do
+    l = Rackamole::Logger.new( { :logger_name => "Test2", :email_alerts_to => "fernand@invalid.address", :email_alert_level => :off })
+    l.email_appender.should_not == nil
+  end
+
+  it "does not configure an email appender if :email_alerts is not set" do
+    l = Rackamole::Logger.new( { :logger_name => "Test3" })
+    lambda { l.email_appender }.should raise_error( Rackamole::Logger::ConfigurationError )
+  end
+
+  it "raises an error if an invalid object is passed in for the :log_file" do
+    lambda { l = Rackamole::Logger.new( { :log_file => Object.new } ) }.should raise_error( Rackamole::Logger::ConfigurationError )
+  end
+
+  it "logs to an IO stream if given" do
+    io = StringIO.new
+    l  = Rackamole::Logger.new( { :log_file => io, :logger_name => "Test4"  })
+    l.info "This is a test io message"
+    io.string.split("\n").should have(1).item
+    io.string.should =~ /This is a test io message/
+    io.string.should =~ /INFO/
+  end
+
+  it "logs to a file if given a file name to log to" do
+    log_file = "/tmp/mole_logger_test.log"   
+    FileUtils.rm( log_file ) if File.exists?( log_file )
+    l = Rackamole::Logger.new({ :log_file => log_file, :logger_name => "Test5" })
+    l.info "This is a test log file message"
+
+    log_lines = IO.readlines(log_file)
+                          
+    log_lines.should have(1).items
+    log_lines.first.should =~ /This is a test log file message/
+    log_lines.first.should =~ /INFO/
+  end
+
+  it "creates a logger from another logger" do
+    io = StringIO.new
+    l  = Rackamole::Logger.new( { :log_file => io, :logger_name => 'Mole' } )
+    child_l = l.for(Rack::Mole)
+    
+    child_l.info "This is a child log message"
+    io.string.should =~ /This is a child log message/
+    io.string.should =~ /INFO/
+  end
+end

data/spec/rackamole/mole_spec.rb

@@ -0,0 +1,90 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+require 'actionpack'
+
+describe Rack::Mole do
+  include Rack::Test::Methods
+    
+  before :each do
+    @response = [ 200, {"Content-Type" => "text/plain"}, ["success"] ]
+  end
+      
+  class TestStore
+    attr_accessor :mole_result
+    
+    def mole( args )
+      @mole_result = args
+    end
+  end
+  
+  def app( opts={} )
+    response = @response
+    @app ||= Rack::Builder.new do
+      use Rack::Lint
+      use Rack::Mole, opts
+      run lambda { |env| response }
+    end
+  end
+  
+  describe 'moling a request' do
+    before :each do
+      @test_store = TestStore.new
+      @test_env   = { 'rack.session' => { :user_id => 100 }, 'HTTP_X_FORWARDED_FOR' => '1.1.1.1', 'HTTP_USER_AGENT' => "IBrowse" }
+      app( 
+        :app_name       => "Test App", 
+        :environment    => :test,
+        :perf_threshold => 0.1,
+        :user_key       => { :session_key => :user_id, :extractor => lambda{ |k| "Test user #{k}"} },
+        :store          => @test_store )
+    end
+    
+    it "should set the mole meta correctly" do
+      get "/", nil, @test_env
+      @test_store.mole_result[:app_name].should    == "Test App"
+      @test_store.mole_result[:environment].should == :test
+      @test_store.mole_result[:user_id].should     == 100
+      @test_store.mole_result[:user_name].should   == 'Test user 100'
+      @test_store.mole_result[:ip].should          == '1.1.1.1'
+      @test_store.mole_result[:browser].should     == 'IBrowse'
+      @test_store.mole_result[:method].should      == 'GET'
+      @test_store.mole_result[:url].should         == 'http://example.org/'
+      @test_store.mole_result[:path].should        == '/'
+      @test_store.mole_result[:perf_issue].should  == false
+      @test_store.mole_result[:params].should      be_nil
+      @test_store.mole_result[:session].should_not be_nil
+      @test_store.mole_result[:session].should    == { :user_id => '100' }
+    end
+    
+    it "mole an exception correctly" do
+      begin
+        raise 'Oh snap!'
+      rescue => boom
+        get "/", nil, { 'mole.exception' => boom, 'rack.session' => { :user_id => 100 }, 'HTTP_X_FORWARDED_FOR' => '1.1.1.1', 'HTTP_USER_AGENT' => "IBrowse" }
+        @test_store.mole_result[:stack].should have(4).items
+      end
+    end
+    
+    it "should capture request parameters correctly" do
+        get "/", { :blee => 'duh' }, @test_env
+        @test_store.mole_result[:params].should == { :blee => "duh".to_json }
+    end
+  end
+      
+  describe 'username in session' do
+    before :each do
+      @test_store = TestStore.new
+      @test_env   = { 'rack.session' => { :user_name => "Fernand" } }
+      app( 
+        :app_name       => "Test App", 
+        :environment    => :test,
+        :perf_threshold => 0.1,
+        :user_key       => :user_name,
+        :store          => @test_store )
+    end
+    
+    it "should mole the user correctly" do
+      get "/", nil, @test_env
+      @test_store.mole_result[:user_id].should be_nil
+      @test_store.mole_result[:user_name].should   == 'Fernand'
+    end    
+  end
+end

data/spec/rackamole/store/log_spec.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+require 'mongo/util/ordered_hash'
+
+describe Rackamole::Store::Log do  
+  describe "#mole" do
+    before( :each ) do
+      @test_file = '/tmp/test_mole.log'
+      File.delete( @test_file ) if File.exists?( @test_file )
+
+      @store = Rackamole::Store::Log.new( @test_file )
+        
+      @args = OrderedHash.new
+      @args[:app_name]     = "Test app"
+      @args[:environment]  = :test
+      @args[:perf_issue]   = false
+      @args[:ip]           = "1.1.1.1"
+      @args[:browser]      = "Ibrowse"
+      @args[:user_id]      = 100
+      @args[:user_name]    = "Fernand"
+      @args[:request_time] = 1.0
+      @args[:url]          = "http://test_me/"
+      @args[:path]         = "/fred"
+      @args[:method]       = 'GET'
+      @args[:params]       = { :blee => "duh".to_json }
+      @args[:session]      = { :fred => 10.to_json }
+    end
+    
+    it "should mole a feature correctly" do
+      @store.mole( @args )
+      results = File.read( @test_file ).gsub( /.* Mole \:\s/, '' )      
+      expected = File.read( File.join( File.dirname(__FILE__), %w[.. .. expected_results mole_feature.log] ) )    
+      expected.should == results      
+    end
+
+    it "should mole an exception correctly" do
+      @args[:stack] = [ 'Oh snap!' ]
+      @args[:ruby_version] = 'ruby 1.8.6 (2007-03-13 patchlevel 0) [i686-darwin8.10.1]'
+
+      @store.mole( @args )
+      results = File.read( @test_file ).gsub( /.* Mole \:\s/, '' )
+      expected = File.read( File.join( File.dirname(__FILE__), %w[.. .. expected_results mole_exception.log] ) )    
+      expected.should == results      
+    end
+    
+    it "should mole a performance issue correctly" do
+      @args[:performance] = true
+      @store.mole( @args )
+      results = File.read( @test_file ).gsub( /.* Mole \:\s/, '' )
+      expected = File.read( File.join( File.dirname(__FILE__), %w[.. .. expected_results mole_perf.log] ) )    
+      expected.should == results      
+    end
+  end    
+    
+end

data/spec/rackamole/store/mongo_spec.rb

@@ -0,0 +1,120 @@
+require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+require 'mongo/util/ordered_hash'
+
+describe Rackamole::Store::Log do
+  
+  describe "#mole" do
+    before( :each ) do
+      @store = Rackamole::Store::Mongo.new( :host => 'localhost', :port => 27017, :database => 'test_mole_mdb' )
+      @store.reset!
+      
+      @args = OrderedHash.new
+      @args[:app_name]     = "Test app"
+      @args[:environment]  = :test
+      @args[:perf_issue]   = false
+      @args[:ip]           = "1.1.1.1"
+      @args[:browser]      = "Ibrowse"
+      @args[:user_id]      = 100
+      @args[:user_name]    = "Fernand"
+      @args[:request_time] = 1.0
+      @args[:url]          = "http://test_me/"
+      @args[:path]         = "/fred"
+      @args[:method]       = 'GET'
+      @args[:params]       = { :blee => "duh".to_json }
+      @args[:session]      = { :fred => 10.to_json }
+    end
+    
+    it "should mole a feature correctly" do
+      @store.mole( @args )      
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one( {} )
+      feature.should_not be_nil
+      feature['app_name'].should       == 'Test app'
+      feature['context'].should        == '/fred'
+      feature['created_at'].should_not be_nil
+      feature['updated_at'].should_not be_nil
+     
+      log = @store.logs.find_one( {} )
+      log.should_not be_nil
+      log['params'].should         == { 'blee' => 'duh'.to_json }
+      log['ip'].should             == '1.1.1.1'
+      log['browser'].should        == 'Ibrowse'
+      log['environment'].should    == :test
+      log['path'].should           == '/fred'       
+      log['url'].should            == 'http://test_me/'
+      log['method'].should         == 'GET'
+      log['session'].should        == { 'fred' => '10' }
+      log['user_name'].should      == 'Fernand'
+      log['user_id'].should        == 100
+      log['request_time'].should   == 1.0       
+      log['perf_issue'].should     == false
+      log['created_at'].should_not be_nil
+      log['updated_at'].should_not be_nil                   
+      @store.connection.dereference( log['feature'] )['app_name'].should == 'Test app'
+    end
+    
+    it "should mole a rails feature correctly" do
+      @args[:path]       = '/fred/blee/duh'
+      @args[:route_info] = { :controller => 'fred', :action => 'blee', :id => 'duh' }
+      @store.mole( @args )
+      
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one( {} )
+      feature.should_not be_nil      
+      feature['controller'].should == 'fred'
+      feature['action'].should     == 'blee'
+      feature['context'].should    be_nil 
+      
+      log = @store.logs.find_one( {} )
+      log.should_not be_nil
+      log['route_info'].should_not be_nil
+    end
+    
+    it "should reuse an existing feature" do
+      @store.mole( @args )
+      @store.mole( @args )
+
+      @store.features.count.should == 1
+      @store.logs.count.should     == 2
+    end
+
+    it "should mole perf correctly" do
+      @args[:perf_issue] = true
+      @store.mole( @args )
+
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one( {} )
+      feature.should_not be_nil      
+
+      log = @store.logs.find_one( {} )
+      log.should_not be_nil
+      log['perf_issue'].should == true
+    end
+    
+    it 'should mole an exception correctly' do
+      @args[:exception] = ['fred']
+      @store.mole( @args )
+
+      @store.features.count.should == 1
+      @store.logs.count.should     == 1
+      
+      feature = @store.features.find_one( {} )
+      feature.should_not be_nil      
+
+      log = @store.logs.find_one( {} )
+      log.should_not be_nil
+      log['exception'].should == ['fred']      
+    end
+    
+    it 'should keep count an similar exceptions or perf issues' do
+      pending "NYI"
+    end
+  end
+  
+end