heckle 1.2.0 → 1.3.0

data/History.txt

@@ -1,3 +1,16 @@
+== 1.3.0 / 2007-02-12
+
+* 1 major enhancement:
+  * Unified diffs for mutatated methods
+* 4 minor enhancements:
+  * Now returns exit status 1 if failed.
+  * Added a simple report at the end.
+  * Runs are now sorted by method.
+  * Autodetects rails and changes test_pattern accordingly.
+* 2 bug fixes:
+  * Aborts when an unknown method is supplied.
+  * Escapes slashes in random regexps.
+  
 == 1.2.0 / 2007-01-15
 
 * 2 major enhancements:

data/bin/heckle

@@ -9,7 +9,7 @@ opts = OptionParser.new do |opts|
   opts.on( "-v", "--verbose", "Loudly explain heckle run" ) do |opt|
     TestUnitHeckler.debug = true
   end
-  
+
   opts.on( "-V", "--version", "Prints Heckle's version number") do |opt|
     puts "Heckle #{Heckle::VERSION}"
     exit 0
@@ -28,7 +28,7 @@ opts = OptionParser.new do |opts|
 
     Heckle::MUTATABLE_NODES.replace [:if, :while, :until]
   end
-  
+
   opts.on( "-T", "--timeout SECONDS", "The maximum time for a test run in seconds",
                                      "Used to catch infinite loops") do |timeout|
     Heckle.timeout = timeout.to_i
@@ -41,6 +41,9 @@ opts = OptionParser.new do |opts|
   end
 end
 
+looks_like_rails = test ?f, 'config/environment.rb'
+TestUnitHeckler.test_pattern = "test/**/*.rb" if looks_like_rails
+
 opts.parse!
 
 impl = ARGV.shift
@@ -51,4 +54,4 @@ unless impl then
   exit 1
 end
 
-TestUnitHeckler.validate(impl, meth)
+exit TestUnitHeckler.validate(impl, meth) ? 0 : 1

data/lib/heckle.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'parse_tree'
 require 'ruby2ruby'
 require 'timeout'
+require 'tempfile'
 
 class String
   def to_class
@@ -10,10 +11,11 @@ class String
 end
 
 class Heckle < SexpProcessor
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
   MUTATABLE_NODES = [:if, :lit, :str, :true, :false, :while, :until]
   WINDOZE = RUBY_PLATFORM =~ /mswin/
   NULL_PATH = WINDOZE ? 'NUL:' : '/dev/null'
+  DIFF = WINDOZE ? 'diff.exe' : 'diff'
 
   attr_accessor(:klass_name, :method_name, :klass, :method, :mutatees,
                 :original_tree, :mutation_count, :node_count,
@@ -111,10 +113,13 @@ class Heckle < SexpProcessor
     unless @failures.empty?
       @reporter.no_failures
       @failures.each do |failure|
-        @reporter.failure(failure)
+        original = RubyToRuby.new.process(@original_tree.deep_clone)
+        @reporter.failure(original, failure)
       end
+      false
     else
       @reporter.no_surviving_mutants
+      true
     end
   end
 
@@ -123,14 +128,16 @@ class Heckle < SexpProcessor
   end
 
   def heckle(exp)
-    orig_exp = exp.deep_clone
+    exp_copy = exp.deep_clone
     src = begin
             RubyToRuby.new.process(exp)
           rescue => e
-            puts "Error: #{e.message} with: #{klass_name}##{method_name}: #{orig_exp.inspect}"
+            puts "Error: #{e.message} with: #{klass_name}##{method_name}: #{exp_copy.inspect}"
             raise e
           end
-    @reporter.replacing(klass_name, method_name, src) if @@debug
+
+    original = RubyToRuby.new.process(@original_tree.deep_clone)
+    @reporter.replacing(klass_name, method_name, original, src) if @@debug
 
     clean_name = method_name.to_s.gsub(/self\./, '')
     self.count += 1
@@ -170,7 +177,7 @@ class Heckle < SexpProcessor
     when Symbol
       [:lit, rand_symbol]
     when Regexp
-      [:lit, /#{Regexp.escape(rand_string)}/]
+      [:lit, Regexp.new(Regexp.escape(rand_string.gsub(/\//, '\\/')))]
     when Range
       [:lit, rand_range]
     end
@@ -344,7 +351,7 @@ class Heckle < SexpProcessor
   end
 
   def rand_number
-    (rand(10) + 1)*((-1)**rand(2))
+    (rand(100) + 1)*((-1)**rand(2))
   end
 
   def rand_string
@@ -404,7 +411,6 @@ class Heckle < SexpProcessor
     end
 
     def warning(message)
-      puts
       puts "!" * 70
       puts "!!! #{message}"
       puts "!" * 70
@@ -412,7 +418,6 @@ class Heckle < SexpProcessor
     end
 
     def info(message)
-      puts
       puts "*"*70
       puts "***  #{message}"
       puts "*"*70
@@ -420,19 +425,42 @@ class Heckle < SexpProcessor
     end
 
     def no_failures
-      puts "\nThe following mutations didn't cause test failures:\n"
+      puts
+      puts "The following mutations didn't cause test failures:"
+      puts
+    end
+
+    def diff(original, mutation)
+      length = [original.split(/\n/).size, mutation.split(/\n/).size].max
+
+      Tempfile.open("orig") do |a|
+        a.puts(original)
+        a.flush
+
+        Tempfile.open("fail") do |b|
+          b.puts(mutation)
+          b.flush
+
+          diff_flags = " "
+
+          output = `#{Heckle::DIFF} -U #{length} --label original #{a.path} --label mutation #{b.path}`
+          puts output.sub(/^@@.*?\n/, '')
+          puts
+        end
+      end
     end
 
-    def failure(failure)
-      puts "\n#{failure}\n"
+    def failure(original, failure)
+      self.diff original, failure
     end
 
     def no_surviving_mutants
       puts "No mutants survived. Cool!\n\n"
     end
 
-    def replacing(klass_name, method_name, src)
-      puts "Replacing #{klass_name}##{method_name} with:\n\n#{src}\n"
+    def replacing(klass_name, method_name, original, src)
+      puts "Replacing #{klass_name}##{method_name} with:\n\n"
+      diff(original, src)
     end
 
     def report_test_failures

data/lib/test_unit_heckler.rb

@@ -20,32 +20,59 @@ class TestUnitHeckler < Heckle
   def self.validate(klass_name, method_name = nil)
     load_test_files
     klass = klass_name.to_class
-    
+
+    # Does the method exist?
+    klass_methods = klass.singleton_methods(false).collect {|meth| "self.#{meth}"}
+    if method_name
+      if method_name =~ /self\./
+        abort "Unknown method: #{klass_name}.#{method_name.gsub('self.', '')}" unless klass_methods.include? method_name
+      else
+        abort "Unknown method: #{klass_name}##{method_name}" unless klass.instance_methods(false).include? method_name
+      end
+    end
+
     initial_time = Time.now
 
     unless self.new(klass_name).tests_pass? then
       abort "Initial run of tests failed... fix and run heckle again"
     end
-    
+
     if self.guess_timeout?
       running_time = (Time.now - initial_time)
       adjusted_timeout = (running_time * 2 < 5) ? 5 : (running_time * 2)
       self.timeout = adjusted_timeout
       puts "Setting timeout at #{adjusted_timeout} seconds." if @@debug
-      
+
     end
-    
-    puts "Initial tests pass. Let's rumble."
+
     self.timeout = adjusted_timeout
-    
+
     puts "Initial tests pass. Let's rumble."
-    
-    klass_methods = klass.singleton_methods(false).collect {|meth| "self.#{meth}"}
+    puts
+
     methods = method_name ? Array(method_name) : klass.instance_methods(false) + klass_methods
-    
-    methods.each do |method_name|
-      self.new(klass_name, method_name).validate
+
+    counts = Hash.new(0)
+    methods.sort.each do |method_name|
+      result = self.new(klass_name, method_name).validate
+      counts[result] += 1
     end
+    all_good = counts[false] == 0
+
+    puts "Heckle Results:"
+    puts
+    puts "Passed    : %3d" % counts[true]
+    puts "Failed    : %3d" % counts[false]
+    puts "Thick Skin: %3d" % counts[nil]
+    puts
+
+    if all_good then
+      puts "All heckling was thwarted! YAY!!!"
+    else
+      puts "Improve the tests and try again."
+    end
+
+    all_good
   end
 
   def initialize(klass_name=nil, method_name=nil)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0.9
 specification_version: 1
 name: heckle
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
-date: 2007-01-15 00:00:00 -08:00
+  version: 1.3.0
+date: 2007-02-13 00:00:00 -08:00
 summary: Unit Test Sadism
 require_paths: 
 - lib
@@ -71,5 +71,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.7
+        version: 1.2.0
     version: