ZenTest 3.0.0 → 3.1.0

data/History.txt

@@ -1,3 +1,25 @@
+*** 3.1.0 / 2006-03-29
+
++ 2 major enhancements
+	+ Added multiruby! YAY!
+	+ Massive improvements to autotest: speed, reliability, reporting, etc.
++ 10 minor enhancements
+	+ multiruby builds in a centralized location. YAY!
+	+ multiruby now allows reinstalls quickly and easily (can even skip config).
+	+ multiruby exits with total sum of exit codes.
+	+ autotest file search is muuuuch faster.
+	+ autotest automatically detects rails mode.
+	+ autotest deals with rails dependencies much better.
+	+ autotest reruns a full suite after you go green to ensure full coverage.
+	+ autotest always runs with unit_diff -u.
+	+ autotest can now run cvs/svn/p4 up periodically to be a mini-tinderbox.
+	+ autotest now has real help.
++ 4 bug fixes
+	- ZenTest is now zentest. Yay for consistency! (do a rake uninstall to clean)
+	- ZenTest excludes pretty_print methods.
+	- Fixed unary operator issues (they were backwards... oops!) for ZenTest.
+	- unit_diff now runs diff.exe on Windoze. dunno if that will work.
+
 *** 3.0.0 / 2006-03-06
 
 + 2 major enhancements

data/Manifest.txt

@@ -3,23 +3,36 @@ LinuxJournalArticle.txt
 Manifest.txt
 README.txt
 Rakefile
-bin/ZenTest
 bin/autotest
+bin/multiruby
 bin/unit_diff
+bin/zentest
 example.txt
 example1.rb
 example2.rb
-lib/ZenTest.rb
 lib/autotest.rb
 lib/rails_autotest.rb
 lib/unit_diff.rb
+lib/zentest.rb
+test/data/normal/lib/.#photo.rb
+test/data/normal/lib/blah.rb
 test/data/normal/lib/photo.rb
 test/data/normal/test/test_camelcase.rb
 test/data/normal/test/test_photo.rb
 test/data/normal/test/test_route.rb
 test/data/normal/test/test_user.rb
+test/data/rails/app/controllers/admin/theme_controller.rb
+test/data/rails/app/controllers/route_controller.rb
+test/data/rails/app/models/flickr_photo.rb
+test/data/rails/app/models/route.rb
+test/data/rails/config/environment.rb
+test/data/rails/config/routes.rb
 test/data/rails/test/fixtures/routes.yml
+test/data/rails/test/functional/admin/themes_controller_test.rb
+test/data/rails/test/functional/dummy_controller_test.rb
 test/data/rails/test/functional/route_controller_test.rb
+test/data/rails/test/unit/flickr_photo_test.rb
+test/data/rails/test/unit/photo_test.rb
 test/data/rails/test/unit/route_test.rb
 test/test_autotest.rb
 test/test_rails_autotest.rb

data/README.txt

@@ -18,6 +18,9 @@ autotest is a continous testing facility meant to be used during
 development. As soon as you save a file, autotest will run the
 corresponding dependent tests.
 
+multiruby runs anything you want on multiple versions of ruby. Great
+for compatibility checking!
+
 There are two strategies intended for ZenTest: test conformance
 auditing and rapid XP.
 
@@ -35,14 +38,20 @@ implementation.
 * Scans your ruby code and tests and generates missing methods for you.
 * Includes a very helpful filter for Test::Unit output called unit_diff.
 * Continually and intelligently test only those files you change with autotest.
+* Test against multiple versions with multiruby.
+- Not the best doco in the world (my fault)
 * Includes a LinuxJournal article on testing with ZenTest written by Pat Eyler.
+* See also: http://blog.zenspider.com/archives/zentest/
 
 == SYNOPSYS
 
   ZenTest MyProject.rb TestMyProject.rb > missing.rb
-  # edit missing.rb and merge appropriate parts into the above files.
+
   ./TestMyProject.rb | unit_diff
-  # Use unit_diff.rb to show you the actual differences in your failures.
+
+  autotest
+
+  multiruby ./TestMyProject.rb
 
 == RULES
 

data/Rakefile

@@ -6,8 +6,7 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rbconfig'
 
-$: << 'lib'
-require 'ZenTest'
+require './lib/zentest.rb'
 
 $VERBOSE = nil
 
@@ -19,7 +18,7 @@ spec = Gem::Specification.new do |s|
 
   s.files = File.read('Manifest.txt').split($/)
   s.require_path = 'lib'
-  s.executables = %w[ZenTest unit_diff autotest]
+  s.executables = %w[ZenTest unit_diff autotest multiruby]
 
   paragraphs = File.read("README.txt").split(/\n\n+/)
   s.instance_variable_set "@description", paragraphs[3..9].join("\n\n")
@@ -55,10 +54,10 @@ end
 desc 'Generate RDoc'
 Rake::RDocTask.new :rdoc do |rd|
   rd.rdoc_dir = 'doc'
-  rd.rdoc_files.add 'lib', 'README.txt', 'History.txt',
-                    'LinuxJournalArticle.txt'
+  rd.rdoc_files.add 'lib', 'README.txt', 'History.txt', 'LinuxJournalArticle.txt'
   rd.main = 'README.txt'
-  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-d' if `which dot` =~ /\/dot/ unless RUBY_PLATFORM =~ /win32/
+  rd.options << '-t "ZenTest RDoc"'
 end
 
 desc 'Build Gem'
@@ -69,8 +68,8 @@ end
 $prefix = ENV['PREFIX'] || Config::CONFIG['prefix']
 $bin  = File.join($prefix, 'bin')
 $lib  = Config::CONFIG['sitelibdir']
-$bins = %w(ZenTest autotest unit_diff)
-$libs = %w(ZenTest.rb autotest.rb rails_autotest.rb unit_diff.rb)
+$bins = %w(zentest autotest unit_diff multiruby)
+$libs = %w(zentest.rb autotest.rb rails_autotest.rb unit_diff.rb)
 
 task :install do
   $bins.each do |f|
@@ -83,6 +82,10 @@ task :install do
 end
 
 task :uninstall do
+  # add old versions
+  $bins << "ZenTest"
+  $libs << "ZenTest.rb"  
+
   $bins.each do |f|
     rm_f File.join($bin, f)
   end
@@ -94,5 +97,5 @@ end
 
 desc 'Clean up'
 task :clean => [ :clobber_rdoc, :clobber_package ] do
-  rm_rf %w(*~ doc)
+  rm_f Dir["**/*~"]
 end

data/bin/ZenTest

@@ -1,6 +1,6 @@
 #!/usr/local/bin/ruby -swI .
 
-require 'ZenTest'
+require 'zentest'
 
 $TESTING = true # for ZenWeb and any other testing infrastructure code
 

data/bin/autotest

@@ -1,8 +1,43 @@
 #!/usr/local/bin/ruby -ws
 
-$rails ||= false
+$h    ||= false
+$help ||= false
 
-if $rails then
+if $h or $help then
+  help = []
+  help << "autotest [options]"
+  help << nil
+  help << "options:"
+  help << "\t-h"
+  help << "\t-help\t\tYou're looking at it."
+  help << nil
+  help << "\t-v\t\tBe verbose."
+  help << "\t\t\tPrints files that autotest doesn't know how to map to"
+  help << "\t\t\ttests."
+  help << nil
+  help << "\t-rails\t\tForce rails mode."
+  help << "\t\t\tRails will be automatically detected by the presence of"
+  help << "\t\t\tconfig/environment.rb"
+  help << nil
+  help << "\t-vcs=NAME\tVersion control system to update."
+  help << "\t\t\tAutotest will automatically update every vcstime"
+  help << "\t\t\tseconds."
+  help << "\t\t\tAutotest understands Perforce (p4), CVS (cvs) and"
+  help <<  "\t\t\tSubversion (svn)."
+  help << nil
+  help << "\t-vcstime=N\tUpdate source control every N seconds."
+  help << "\t\t\tDefaults to every five minutes (300 seconds)."
+  STDERR.puts help.join("\n")
+  exit 1
+end
+
+$v       ||= false
+$rails   ||= false
+$vcs     ||= nil
+$vcstime ||= 300
+$vcstime = $vcstime.to_i
+
+if $rails or File.exist? 'config/environment.rb' then
   require 'rails_autotest'
   RailsAutotest.run
 else

data/bin/multiruby

@@ -0,0 +1,82 @@
+#!/usr/local/bin/ruby -w
+
+require 'fileutils'
+
+def run(cmd)
+  puts "Running command: #{cmd}"
+  raise "ERROR: Command failed with exit code #{$?}" unless system cmd
+end
+
+root_dir = File.expand_path(ENV['MULTIRUBY'] || File.join(ENV['HOME'], ".multiruby"))
+unless test ?d, root_dir then
+  puts "creating #{root_dir}"
+  Dir.mkdir root_dir, 0700
+end
+
+versions = []
+Dir.chdir root_dir do
+  %w(build install versions).each do |dir|
+    unless test ?d, dir then
+      puts "creating #{dir}"
+      Dir.mkdir dir 
+      if dir == "versions" then
+        file = "ruby-#{RUBY_VERSION}.tar.gz"
+        puts "  downloading #{file} via HTTP... this might take a while."
+        puts "  Put other ruby tarballs in versions to use them."
+        
+        Dir.chdir dir do
+          require 'open-uri'
+          open("http://ftp.ruby-lang.org/pub/ruby/#{file}") do |f|
+            File.open file, 'w' do |out|
+              out.write f.read
+            end
+          end
+        end
+      end
+    end
+  end
+
+  Dir.chdir "build" do
+    Dir["../versions/ruby*.tar.gz"].each do |tarball|
+      build_dir = File.basename tarball, ".tar.gz"
+      version = build_dir.sub(/^ruby-?/, '')
+      versions << version
+      inst_dir = "#{root_dir}/install/#{version}"
+      unless test ?d, inst_dir then
+        unless test ?d, build_dir then
+          puts "creating #{inst_dir}"
+          Dir.mkdir inst_dir
+          puts "unpacking #{tarball}"
+          system "tar zxf #{tarball}"
+        end
+        Dir.chdir build_dir do
+          run "autoconf" unless test ?f, "configure"
+          FileUtils.rm_r "ext/readline" if test ?d, "ext/readline"
+          run "./configure --prefix #{inst_dir} &> log.configure"
+          run "make -j4 &> log.build"
+          run "make install &> log.install"
+        end
+      end
+    end
+  end
+end
+
+results = versions.map do |version|
+  ruby = "#{root_dir}/install/#{version}/bin/ruby"
+  puts
+  puts "VERSION = #{version}"
+  puts
+  system ruby, *ARGV
+  puts
+  puts "RESULT = #{$?}"
+  $?
+end
+
+result = results.select { |n| n != 0 }.size
+
+puts
+puts "TOTAL RESULT = #{result} failures"
+
+exit result
+
+

data/bin/zentest

@@ -0,0 +1,28 @@
+#!/usr/local/bin/ruby -swI .
+
+require 'zentest'
+
+$TESTING = true # for ZenWeb and any other testing infrastructure code
+
+if defined? $v then
+  puts "#{File.basename $0} v#{ZenTest::VERSION}"
+  exit 0
+end
+
+if defined? $h then
+  puts "usage: #{File.basename $0} [-h -v] test-and-implementation-files..."
+  puts "  -h display this information"
+  puts "  -v display version information"
+  puts "  -r Reverse mapping (ClassTest instead of TestClass)"
+  puts "  -e (Rapid XP) eval the code generated instead of printing it"
+  exit 0
+end
+
+code = ZenTest.fix(*ARGV)
+if defined? $e then
+  require 'test/unit'
+  eval code
+else
+  print code
+end
+

data/lib/autotest.rb

@@ -22,6 +22,17 @@ require 'find'
 # * Implementation files must match up with a test file named
 #   test_.*implementation.rb
 
+# New (proposed) strategy:
+#
+# 1) find all files and associate them from impl <-> test
+# 2) run all tests
+# 3) scan for failures
+# 4) detect changes in ANY (ruby?) file, rerun all failures + changed files
+#    NOTE: this runs in a loop, loop handling should be improved slightly to
+#          have less crap (ruby command, failure count).
+# 5) until 0 defects, goto 3
+# 6) when 0 defects, goto 2
+
 class Autotest
   
   def self.run
@@ -39,20 +50,66 @@ class Autotest
   end
 
   ##
-  # Maps failed class +klass+ to test files in +tests+ that have been updated.
-
-  def failed_test_files(klass, tests)
-    failed_klass = klass.sub('Test', '').gsub(/(.)([A-Z])/, '\1_?\2').downcase
-    # tests that match this failure
-    failed_files = tests.select { |test| test =~ /#{failed_klass}/ }
-    # updated implementations that match this failure
-    changed_impls = @files.keys.select do |file|
-      file =~ %r%^lib.*#{failed_klass}.rb$% and updated? file
+  # Consolidates failed tests +failed+ for the same test class into a single
+  # test runner filter.  Also maps failed class to its file regexp.
+
+  def consolidate_failures(failed)
+    filters = Hash.new { |h,k| h[k] = [] }
+
+    failed.each do |method, klass|
+      failed_file = klass.sub('Test', '').gsub(/(.)([A-Z])/, '\1_?\2')
+      filters[failed_file.downcase] << method
+    end
+
+    return filters.map do |klass, methods|
+      ["'/^(#{methods.join('|')})/'", /#{klass}/]
     end
-    tests_to_run = map_file_names(changed_impls).flatten
-    # add updated tests
-    failed_files.each { |f| tests_to_run << f if updated? f }
-    return tests_to_run.uniq
+  end
+
+
+  ##
+  # Selects test files to run that match failures in +failed_file+ based on
+  # +updated_files+ and +tests+.
+  #
+  # Only test files matching +failed_file+ will be returned so the test
+  # runner's -n flag will correctly match the failed tests.
+  #--
+  # failed_test_files must never check for updated files, retest_failed reuses
+  # +updated_files+.
+
+  def failed_test_files(failed_file, tests, updated_files)
+    return [] if updated_files.empty?
+
+    updated_tests = updated_files.select { |f| f =~ /^test/ }
+
+    tests_to_filter = if updated_files == updated_tests then
+                        updated_tests
+                      else
+                        files = (updated_files + tests).uniq
+                        tests_to_filter = map_file_names(files).flatten.uniq
+                      end
+
+    return tests_to_filter.select { |test| test =~ failed_file }
+  end
+
+  ##
+  # Returns a report of remaining failures in +failures+.
+
+  def failure_report(failed)
+    out = []
+    out << "# failures remain in #{failed.length} files:"
+    failed.each do |filter, failed_test|
+      tests = @files.keys.select { |file| file =~ /^test.*#{failed_test}/ }
+      test = tests.sort_by { |f| f.length }.first
+
+      filter =~ /\((.*)\)/
+      filter = $1.split('|')
+
+      out << "#  #{test}:"
+      out << "#    #{filter.join "\n#    "}"
+    end
+
+    return out.join("\n")
   end
 
   ##
@@ -75,34 +132,61 @@ class Autotest
       when %r%^(doc|pkg)/% then
         # ignore
       else
-        STDERR.puts "Dunno! #{filename}" # What are you trying to pull?
+        STDERR.puts "Dunno! #{filename}" if $v or $TESTING
       end
     end
 
     return [tests]
   end
 
+  ##
+  # Resets all file timestamps in the list
+
+  def reset_times
+    ago = Time.at 0
+    @files.each_key { |file| @files[file] = ago }
+  end
+
   ##
   # Retests failed tests.
+  #--
+  # Runs through each failure and runs tests matching the failure.  If an
+  # implementation file was updated all failed tests should be run.
+  #
+  # TODO collapse multiple failures in the same file (in test) and use | in
+  # the filter.
 
   def retest_failed(failed, tests)
+    puts "# Waiting for changes"
+
     # -t and -n includes all tests that match either filter, not tests that
     # match both filters, so figure out which TestCase to run from the filename,
     # and use -n on that.
     until failed.empty? do
       sleep 5 unless $TESTING
 
-      failed.map! do |method, klass|
-        failed_files = failed_test_files klass, tests
-        break [method, klass] if failed_files.empty?
+      updated = updated_files
+
+      # REFACTOR
+      failed.map! do |filter, failed_test|
+        failed_files = failed_test_files failed_test, tests, updated
+        break [filter, failed_test] if failed_files.empty?
+
         puts "# Rerunning failures: #{failed_files.join ' '}"
-        filter = "-n #{method} " unless method == 'default_test'
-        cmd = "ruby -Ilib:test -S testrb #{filter}#{failed_files.join ' '}"
+
+        test_filter = " -n #{filter}" unless filter == "'/^(default_test)/'"
+        cmd = "ruby -Ilib:test #{failed_files.join ' '}#{test_filter} | unit_diff -u"
+
         puts "+ #{cmd}"
-        system(cmd) ? nil : [method, klass] # clever
+        result = `#{cmd}`
+        puts result
+        status = result.split($/).last
+        rerun = status =~ / 0 failures, 0 errors/ ? nil : [filter, failed_test]
+        puts "# Waiting for changes" if rerun
+        rerun # needed for map!
       end
 
-      failed.compact!
+      puts failure_report(failed) if failed.compact! and not failed.empty?
     end
   end
 
@@ -115,6 +199,7 @@ class Autotest
         puts "# Ok, you really want to quit, doing so"
         exit
       end
+      # STDERR.puts "\t#{caller.join "\n\t"}"
       puts "# hit ^C again to quit"
       sleep 1.5 # give them enough time to hit ^C again
       @interrupt = true # if they hit ^C again, 
@@ -122,7 +207,23 @@ class Autotest
     end
       
     begin
+      last_update = Time.at 0
+
       loop do
+        if $vcs and Time.now > last_update + $vcstime then
+          last_update = Time.now
+          case $vcs
+          when 'cvs' then
+            system 'cvs up'
+          when 'p4' then
+            system 'p4 sync'
+          when 'svn' then
+            system 'svn up'
+          else
+            puts "# Sorry, I don't know what version control system \"#{$vcs}\" is"
+          end
+        end
+
         files = updated_files
         test files unless files.empty?
         sleep 5
@@ -138,12 +239,16 @@ class Autotest
   ##
   # Runs tests for files in +updated+.  Implementation files are looked up
   # with map_file_names.
+  #
+  # Returns true if any of the tests ever failed.
 
   def test(updated)
+    ever_failed = false
+
     map_file_names(updated).each do |tests|
       next if tests.empty?
       puts '# Testing updated files'
-      cmd = "ruby -Ilib:test -e '#{tests.inspect}.each { |f| load f }'"
+      cmd = "ruby -Ilib:test -e '#{tests.inspect}.each { |f| load f }' | unit_diff -u"
       puts "+ #{cmd}"
       results = `#{cmd}`
       puts results
@@ -153,18 +258,30 @@ class Autotest
         next
       end
 
+      ever_failed = true
+
       failed = results.scan(/^\s+\d+\) (?:Failure|Error):\n(.*?)\((.*?)\)/)
 
       if failed.empty? then
-        puts '# Test::Unit died, you did a really bad thing, retrying in 10'
+        puts '# Test::Unit exited without a parseable failure or error message.'
+        puts '# You probably have a syntax error in your code.'
+        puts '# I\'ll retry in 10 seconds'
         sleep 10
         redo
       end
 
+      failed = consolidate_failures(failed)
+
+      # REFACTOR: I don't think the two routines merit real differences
       retest_failed failed, tests
     end
 
+    reset_times if ever_failed
+
     puts '# All passed'
+    puts "# Waiting for changes"
+
+    return ever_failed
   end
 
   ##
@@ -187,11 +304,22 @@ class Autotest
     updated = []
 
     Find.find '.' do |f|
+
+      if @exceptions then
+        if f =~ @exceptions then
+          Find.prune if Kernel.test ?d, f
+          next
+        end
+      end
+
+      Find.prune if f =~ /(?:\.svn|CVS)$/       # version control files
+
       next if File.directory? f
-      next if f =~ /(?:swp|~|rej|orig)$/ # temporary/patch files
-      next if f =~ %r%/(?:.svn|CVS)/% # version control files
-      next if f =~ @exceptions unless @exceptions.nil? # custom exceptions
-      f = f.sub(/^\.\//, '') # trim the ./ that Find gives us
+      next if f =~ /(?:swp|~|rej|orig)$/        # temporary/patch files
+      next if f =~ /\/\.#/                      # Emacs autosave/cvs merge files
+
+      f = f.sub(/^\.\//, '')
+
       updated << f if updated? f
     end