mole 1.0.5 → 1.0.6

data/samples/railsapp/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/railsapp/script/about

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

data/samples/railsapp/script/console

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

data/samples/railsapp/script/destroy

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

data/samples/railsapp/script/generate

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

data/samples/railsapp/script/performance/benchmarker

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

data/samples/railsapp/script/performance/profiler

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

data/samples/railsapp/script/performance/request

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

data/samples/railsapp/script/plugin

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

data/samples/railsapp/script/process/inspector

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

data/samples/railsapp/script/process/reaper

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

data/samples/railsapp/script/process/spawner

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

data/samples/railsapp/script/runner

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

data/samples/railsapp/script/server

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

data/samples/railsapp/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 Test::Unit::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/rubyapp/README

@@ -0,0 +1,22 @@
+Sample MOled Ruby App
+
+Launch the app using either of the following cmd line
+
+> cd samples/rubyapp
+
+
+To mole a regular method
+
+> ./bin/ruby_app --feature
+
+
+
+To mole a slow method
+
+> ./bin/ruby_app --slow
+
+
+
+To mole a hosed method that will throw an uncaught exception
+
+> ./bin/ruby_app --hosed

data/samples/rubyapp/bin/ruby_app

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require File.join( File.dirname(__FILE__), %w[.. lib fred] )
+require 'rubygems'
+
+# Initializes the MOle. The configuration file will be read from config/mole_conf.rb.
+require 'mole'
+::Mole.initialize( :moleable       => true, 
+                   :application    => "RubyApp",
+                   :perf_threshold => 2,
+                   :mole_config    => File.join( File.dirname(__FILE__), %w[.. config mole_conf.rb]) )
+::Mole.dump
+::Mole.load_mole_configuration                   
+                   
+class Runner
+  def initialize( args )
+    check_args( args )
+    fred = RubyApp::Fred.new
+    case args.first
+      when "--feature": fred.my_feature( 10, "Hello", 20 ) { puts "Hello" }
+      when "--slow"   : fred.my_slow_feature( "World" )
+      when "--hosed"  : fred.my_hosed_feature( "Boom" ) rescue nil
+    end
+  end
+  
+  def check_args( args )
+    print_usage if !args or args.empty? or !["--feature", "--slow", "--hosed"].include?( args.first )
+  end
+  
+  def print_usage
+    puts "Please enter one of the following options: --feature | --slow | --hosed"
+  end
+end
+
+Runner.new( ARGV )
+

data/samples/rubyapp/config/mole_conf.rb

@@ -0,0 +1,31 @@
+# Mole a feature called 'my_feature' on class Fred
+RubyApp::Fred.mole_after( :feature => :my_feature ) { |context, feature, ret, block, *args|
+  ::Mole::Moler.mole_it( 
+    context                       , # Calling context => Fred instance
+    feature                       , # Method called on Fred => my_feature
+    "AppBreaker"                  , # If we had real user information we would put it here...
+    :args     => args.join( ", " ), # The args passed into my_feature
+    :returned => ret              ) # The value returned by my_feature call
+ }
+
+# Monitor perf on all instance methods defined on Fred
+RubyApp::Fred.mole_perf do |context, feature, elapsed_time, ret, block, *args|
+  ::Mole::Moler.perf_it( 
+    context                                 , 
+    "AppBreaker"                            , # User info
+    :controller   => context.class.name     ,
+    :feature      => feature                ,
+    :args         => args                   ,
+    :returned     => ret                    ,
+    :elapsed_time => "%3.3f" % elapsed_time )
+end
+
+# Monitors unchecked exceptions raise in Fred
+RubyApp::Fred.mole_unchecked do |context, feature, boom, ret, block, *args|
+  ::Mole::Moler.check_it( 
+    context                          , 
+    "AppBreaker"                     , # User info
+    :controller => context.class.name,
+    :feature    => feature           ,
+    :boom       => boom              )
+end

data/samples/rubyapp/lib/fred.rb

@@ -0,0 +1,22 @@
+# Sample ruby class that is used in our ruby applications
+# We will MOle this class and capture the essence of the interactions
+module RubyApp
+  class Fred
+    
+    # Pure feature
+    def my_feature( arg1, arg2, arg3, &block )
+      "#{arg1}--#{arg2}--#{arg3}"
+    end
+    
+    # Slow feature
+    def my_slow_feature( arg1 )
+      sleep( 2 )
+      "slow returned #{arg1}"
+    end
+    
+    # Hose feature
+    def my_hosed_feature( arg1 )
+      raise "This will hose your app"
+    end
+  end
+end

data/spec/config/auto_mole_config.rb

@@ -0,0 +1,26 @@
+::Mole.auto_perf( File.join( File.dirname(__FILE__), %w[.. data] ) ) do |context, feature, elapsed_time, ret_val, block, *args|
+  ::Mole::Moler.perf_it( 
+    context                            , 
+    "AppBreaker"                       ,
+    :controller   => context.class.name,
+    :feature      => feature           ,
+    :args         => args              ,
+    :elapsed_time => "%3.3f" % elapsed_time )
+end
+
+::Mole.auto_check( File.join( File.dirname(__FILE__), %w[.. data] ) ) do |context, feature, boom, ret_val, block, *args|
+  ::Mole::Moler.check_it( 
+    context                          , 
+    "AppBreaker"                     ,
+    :controller => context.class.name,
+    :feature    => feature           ,
+    :boom       => boom )
+end  
+  
+::Mole.auto_mole( File.join( File.dirname(__FILE__), %w[.. data] ) ) do |context, feature, ret, block, *args|
+  ::Mole::Moler.mole_it( 
+    context     , 
+    feature     ,
+    "AppBreaker",
+    :args        => context.params[:id] )
+end

data/spec/data/blee.rb

@@ -11,7 +11,7 @@ class Blee
   end
   
   def blee_no_args                 
-    # puts ">>> Blee_No_Args"
+    10
   end             
   
   def blee_args( a, b, c, d )

data/spec/module_spec.rb

@@ -9,12 +9,12 @@ describe Module do
                     
   before( :each ) do
     @blee = Blee.new    
-    CallStackChecker.reset                                                                   
+    CallStackChecker.reset!                                                                 
   end                    
 
   it "should trap mole before handler exceptions" do
     Blee.mole_before( :feature => :crap_out ) { |context, feature, *args| 
-      raise "Before - Something did crap out"
+      raise "LEGIT !! - Before - Something did crap out"
       CallStackChecker.called
     }              
     @blee.crap_out                      
@@ -23,7 +23,7 @@ describe Module do
 
   it "should trap mole after handler exceptions" do
     Blee.mole_after( :feature => :crap_out ) { |context, feature, *args| 
-      raise "After - Something did crap out"
+      raise "LEGIT !! - After - Something did crap out"
       CallStackChecker.called
     }              
     @blee.crap_out                      
@@ -32,7 +32,7 @@ describe Module do
 
   it "should trap mole handler exceptions" do
     Blee.mole_unchecked( :features => [:blee_raise_too] ) { |context, feature, *args| 
-      raise "Unchecked - Something did crap out"
+      raise "-- LEGIT !! - Unchecked - Something did crap out"
       CallStackChecker.called
     }                           
     @blee.blee_raise_too rescue nil                    
@@ -41,7 +41,7 @@ describe Module do
 
   it "should trap a perf handler exception" do
     Blee.mole_perf( :features => [:blee_slow_too] ) do |context, feature, elapsed_time, args, block|
-      raise "Perf - Something did crap out"      
+      raise "---LEGIT !! - Perf - Something did crap out"      
       CallStackChecker.called
     end         
     @blee.blee_slow_too
@@ -124,7 +124,7 @@ describe Module do
       args[3].should       == "Day"            
       CallStackChecker.called
     end         
-    @blee.blee_block( "Hello", "World", "Good", "Day" ) { "Do it already!!" } rescue nil
+    @blee.blee_block( "Hello", "World", "Good", "Day" ) { "Do it already!!" }
     CallStackChecker.should be_called    
   end 
   
@@ -158,7 +158,7 @@ describe Module do
       args[3].should       == "Day"            
       CallStackChecker.called
     end         
-    @blee.blee_block( "Hello", "World", "Good", "Day" ) { "Do it already!!" } rescue nil
+    @blee.blee_block( "Hello", "World", "Good", "Day" ) { "Do it already!!" }
     CallStackChecker.should be_called    
   end 
   
@@ -172,7 +172,7 @@ describe Module do
       elapsed_time.should  > 1      
       CallStackChecker.called
     end         
-    @blee.blee_slow rescue nil
+    @blee.blee_slow
     CallStackChecker.should be_called    
   end 
   

data/spec/mole_spec.rb

@@ -35,7 +35,76 @@ describe Mole do
     Mole.dump
   end
   
-  describe "load_mole_configuration" do
+  it "should locate controller classes correctly" do
+    classes = Mole.find_controller_classes( File.join(File.dirname(__FILE__), %w[data] ) )
+    classes.should == %w[Blee]
+  end
+  
+  describe ".auto_xxx" do
+    before( :each ) do
+      ::Mole.reset_configuration!
+      ::Mole.initialize( :perf_threshold => 1, :log_level => :debug )
+      require File.join( File.dirname(__FILE__),  %w[data blee] )
+      Blee.send( :mole_clear! )
+      CallStackChecker.reset! 
+    end
+
+    it "should auto perf a set of controllers correctly" do
+      Mole.auto_perf( File.join(File.dirname(__FILE__), %w[data] ) ) do |context, feature, elapsed_time, ret_val, block, *args|  
+        context.class.should == Blee
+        block.should         be_nil      
+        args.size.should     == 0      
+        elapsed_time.should  > 1      
+        CallStackChecker.called
+      end         
+      Blee.new.blee_slow      
+      CallStackChecker.should be_called    
+      CallStackChecker.reset!
+      Blee.new.blee_slow_too  
+      CallStackChecker.should be_called          
+    end
+    
+    it "should auto check a set of controllers correctly" do
+      Mole.auto_unchecked( File.join(File.dirname(__FILE__), %w[data] ) ) do |context, feature, elapsed_time, block, *args|  
+        context.class.should == Blee
+        feature.should       == "blee_raise"      
+        block.should         be_nil      
+        args.size.should     == 0      
+        CallStackChecker.called
+      end   
+      Blee.new.blee_raise rescue nil
+      CallStackChecker.should be_called    
+    end
+
+    it "should auto before a set of controllers correctly" do
+      Mole.auto_before( File.join(File.dirname(__FILE__), %w[data] ) ) do |context, feature, block, *args|  
+        context.class.should == Blee
+        feature.should       == "blee_no_args"      
+        block.should         be_nil      
+        args.size.should     == 0      
+        CallStackChecker.called
+      end   
+      Blee.new.blee_no_args
+      CallStackChecker.should be_called    
+    end
+
+    it "should auto after a set of controllers correctly" do
+      Mole.auto_after( File.join(File.dirname(__FILE__), %w[data] ) ) do |context, feature, ret_val, block, *args|  
+        context.class.should == Blee
+        feature.should       == "blee_no_args"      
+        ret_val.should       == 10
+        block.should         be_nil      
+        args.size.should     == 0      
+        CallStackChecker.called
+      end   
+      Blee.mole_dump( "After" )
+      Blee.new.blee_no_args
+      CallStackChecker.should be_called    
+    end
+    
+  end
+    
+  describe ".load_mole_configuration" do
     before( :each ) do
       ::Mole.reset_configuration!
     end

data/spec/spec_helper.rb

@@ -20,7 +20,7 @@ class CallStackChecker
       @called = 1
     end
     
-    def reset
+    def reset!
       @called = 0
     end
     

data/spec/utils/framework_spec.rb

@@ -1,24 +1,60 @@
 require File.join(File.dirname(__FILE__), %w[.. spec_helper] )
-require 'merb'
-require 'action_controller'
 
 describe Mole::Utils::Frameworks do     
   before( :all ) do        
     ::Mole.reset_configuration!
     ::Mole.initialize( :moleable => true )
   end
-                                 
-  it "should retrieve Merb controller actions correctly" do
-    actions = Mole::Utils::Frameworks.merb_actions( MerbController )
-    actions.sort.should == %w[blee fred]
+         
+  describe ".features_for" do
+    it "should find the correct features for a merb controller" do
+      features = Mole::Utils::Frameworks.features_for( MerbController )
+      features.sort.should == %w[blee fred]      
+    end
+    it "should find the correct features for a rails controller" do
+      features = Mole::Utils::Frameworks.features_for( RailsController )
+      features.sort.should == %w[blee fred]      
+    end
+    it "should find the correct features for a plain old ruby object" do
+      features = Mole::Utils::Frameworks.features_for( Poro )
+      features.sort.should == %w[blee duh]      
+    end    
   end
-
-  it "should retrieve Rails controller actions correctly" do
-    actions = Mole::Utils::Frameworks.rails_actions( RailsController )
-    actions.sort.should == %w[blee fred]
+           
+  describe ".merb_actions" do                                 
+    it "should retrieve Merb controller actions correctly" do
+      actions = Mole::Utils::Frameworks.merb_actions( MerbController )
+      actions.sort.should == %w[blee fred]
+    end
+    it "should raise an exception if it is not a merb controller" do
+      lambda { Mole::Utils::Frameworks.merb_actions( String ) }.should raise_error( "Invalid Merb Controller class `String" )
+    end    
+  end
+  
+  describe ".rails_actions" do
+    it "should retrieve Rails controller actions correctly" do
+      actions = Mole::Utils::Frameworks.rails_actions( RailsController )
+      actions.sort.should == %w[blee fred]
+    end
+    
+    it "should raise an exception if it is not a rails controller" do
+      lambda { Mole::Utils::Frameworks.rails_actions( String ) }.should raise_error( "Invalid Rails Controller class `String" )
+    end
+  end
+  
+  class Poro
+    def blee
+    end
+    
+    def duh
+    end
   end
   
-  class MerbController < Merb::Controller  
+  class MerbController
+    def self.callable_actions
+      { 'fred' => nil, 'blee' => nil }
+    end
+    
     def fred
     end
     
@@ -31,7 +67,11 @@ describe Mole::Utils::Frameworks do
     end
   end      
   
-  class RailsController < ActionController::Base
+  class RailsController 
+    def self.action_methods
+      %w[fred blee]
+    end
+    
     def fred
     end