test-loop 3.0.2 → 4.0.0

data/README.md

@@ -6,28 +6,33 @@ and tests changes in your Ruby application in an efficient manner, whereby it:
 
 1. Absorbs the test execution overhead into the main Ruby process.
 2. Forks to evaluate your test files directly and without overhead.
+3. Tries to run only the test blocks that changed in your test files.
 
 It relies on file modification times to determine what parts of your Ruby
-application have changed and then uses a simple lambda mapping function to
-determine which test files in your test suite correspond to those changes.
+application have changed, applies a lambda mapping function to determine which
+test files in your test suite correspond to those changes, and uses diffing to
+find and run only those test blocks that have changed inside your test files.
 
 
 Features
 --------
 
-* Tests *changes* in your Ruby application; does not run all tests every time.
+* Tests *changes* in your Ruby application: ignores unmodified test files
+  as well as unmodified test blocks inside modified test files.
 
 * Reabsorbs test execution overhead if the test or spec helper file changes.
 
+* Evaluates test files in parallel, making full use of multiple processors.
+
 * Mostly I/O bound, so you can have it always running without CPU slowdowns.
 
-* Supports any testing framework that (1) reflects failures in the process'
-  exit status and (2) is loaded by your application's `test/test_helper.rb`
-  or `spec/spec_helper.rb` file.
+* Supports Test::Unit, RSpec, and any other testing framework that (1)
+  reflects failures in the process' exit status and (2) is loaded by your
+  application's `test/test_helper.rb` or `spec/spec_helper.rb` file.
 
 * Configurable through a `.test-loop` file in your current working directory.
 
-* Implemented in less than 60 (SLOC) lines of code! :-)
+* Implemented in less than 100 (SLOC) lines of code! :-)
 
 
 Installation
@@ -98,25 +103,51 @@ define the following instance variables:
         end
       }
 
-* `@after_test_execution` is a lambda function that is executed after tests
-  are run.  It is passed three things: the status of the test execution
-  subprocess, the time when the tests were run, and the list of test files
-  that were run.
-
-  For example, to get on-screen-display notifications through libnotify,
-  add the following to your `.test-loop` file:
-
-      @after_test_execution = lambda do |status, ran_at, files|
-        if status.success?
-          result, icon = 'PASS', 'apple-green'
-        else
-          result, icon = 'FAIL', 'apple-red'
+* `@test_name_parser` is a lambda function that is passed a line of source
+  code to determine whether that line can be considered as a test definition,
+  in which case it must return the name of the test being defined.
+
+* `@before_each_test` is a lambda function that is executed inside the worker
+  process before loading the test file.  It is passed the path to the test
+  file and the names of tests (identified by `@test_name_parser`) inside the
+  test file that have changed since the last time the test file was run.
+
+  These test names should be passed down to your chosen testing library,
+  instructing it to skip all other tests except those passed down to it.  This
+  accelerates your test-driven development cycle and improves productivity!
+
+* `@after_all_tests` is a lambda function that is executed inside the master
+  process after all tests have finished running.  It is passed four things:
+  whether all tests had passed, the time when test execution began, a list of
+  test files, and the exit statuses of the worker processes that evaluated
+  those test files.
+
+  For example, to display a summary of the test execution results as an OSD
+  notification via libnotify, add the following to your `.test-loop` file:
+
+      @after_all_tests = lambda do |success, ran_at, files, statuses|
+        icon = success ? 'apple-green' : 'apple-red'
+        title = "#{success ? 'PASS' : 'FAIL'} at #{ran_at}"
+        details = files.zip(statuses).map do |file, status|
+          "#{status.success? ? '✔' : '✘'} #{file}"
         end
-        system 'notify-send', '-i', icon, "#{result} at #{ran_at}", files.join("\n")
+        system 'notify-send', '-i', icon, title, details.join("\n")
       end
 
+  Also add the following at the very top if you use Ruby 1.9.x:
+
+      # encoding: utf-8
+
+  That will prevent the following errors from occurring:
+
+      invalid multibyte char (US-ASCII)
+
+      syntax error, unexpected $end, expecting ':'
+      "#{status.success? ? '✔' : '✘'} #{file}"
+                            ^>
+
 
 License
 -------
 
-See the `bin/test-loop` file.
+Released under the ISC license.  See the `bin/test-loop` file for details.

data/bin/test-loop

@@ -24,9 +24,12 @@
 
 process_invocation_vector = [$0, *ARGV].map! {|s| s.dup }
 
+require 'diff'
+
 begin
   notify = lambda {|message| puts "test-loop: #{message}" }
 
+  # load user's configuration and supply default values
   notify.call 'Loading configuration...'
   config_file = File.join(Dir.pwd, '.test-loop')
   load config_file if File.exist? config_file
@@ -34,8 +37,7 @@ begin
   (@overhead_file_globs ||= []).
     push('{test,spec}/*{test,spec}_helper.rb').uniq!
 
-  (@reabsorb_file_globs ||= []).
-    concat(@overhead_file_globs).
+  (@reabsorb_file_globs ||= []).concat(@overhead_file_globs).
     push(config_file, 'config/*.{rb,yml}', 'Gemfile').uniq!
 
   (@source_file_to_test_file_mapping ||= {}).merge!(
@@ -50,7 +52,30 @@ begin
     '{test,spec}/**/*_{test,spec}.rb' => lambda {|path| path }
   )
 
-  @after_test_execution ||= lambda {|status, ran_at, files|}
+  @test_file_cache = {} # path => readlines
+
+  @test_name_parser ||= lambda do |line|
+    case line
+    when /^\s*def test_(\w+)/ then $1
+    when /^\s*(test|context|should|describe|it)\b (['"])(.*?)\2/ then $3
+    end
+  end
+
+  @before_each_test ||= lambda do |test_file, test_names|
+    unless test_names.empty?
+      case File.basename(test_file)
+
+      when /(\b|_)test(\b|_)/ # Minitest
+        test_methods = test_names.map {|name| name.strip.gsub(/\W+/, '_') }
+        ARGV.push '-n', "/#{test_methods.join('|')}/"
+
+      when /(\b|_)spec(\b|_)/ # RSpec
+        ARGV.push '-e', test_names.map {|name| Regexp.quote(name) }.join('|')
+      end
+    end
+  end
+
+  @after_all_tests ||= lambda {|success, ran_at, files, statuses|}
 
   # absorb test execution overhead into master process
   $LOAD_PATH.unshift 'lib' # for non-Rails applications
@@ -65,25 +90,66 @@ begin
   epoch_time = Time.at(0)
   started_at = last_ran_at = Time.now
   trap(:QUIT) { started_at = epoch_time }
-  trap(:TSTP) { last_ran_at = epoch_time }
+  trap(:TSTP) { last_ran_at = epoch_time; @test_file_cache.clear }
 
   notify.call 'Ready for testing!'
   loop do
     # figure out what test files need to be run
     test_files = @source_file_to_test_file_mapping.
-    map do |source_file_glob, test_file_glob_mapper|
-      Dir[source_file_glob].
-      select {|file| File.mtime(file) > last_ran_at }.
-      map {|path| Dir[test_file_glob_mapper.call(path)] }
-    end.flatten.uniq
+      map do |source_file_glob, test_file_glob_mapper|
+        Dir[source_file_glob].
+        select {|file| File.mtime(file) > last_ran_at }.
+        map {|path| Dir[test_file_glob_mapper.call(path)] }
+      end.flatten.uniq
 
-    # fork worker process to run the test files
+    # fork worker processes to run the test files in parallel
     unless test_files.empty?
       notify.call 'Running tests...'
       last_ran_at = Time.now
-      fork { test_files.each {|file| notify.call file; load file } }
-      Process.wait
-      @after_test_execution.call($?, last_ran_at, test_files)
+
+      test_files.each do |test_file|
+        notify.call test_file
+
+        # cache the contents of the test file for diffing below
+        new_lines = File.readlines(test_file)
+        old_lines = @test_file_cache[test_file] || new_lines
+        @test_file_cache[test_file] = new_lines
+
+        fork do
+          # determine which test blocks have changed inside the test file
+          test_names = Diff.new(old_lines, new_lines).diffs.map do |diff|
+            catch :found do
+              # search backwards from the line that changed up to
+              # the first line in the file for test definitions
+              diff[0][1].downto(0) do |i| # [[+/-, line number, line value]]
+                if test_name = @test_name_parser.call(new_lines[i])
+                  throw :found, test_name
+                end
+              end; nil # prevent unsuccessful search from returning an integer
+            end
+          end.compact.uniq
+
+          @before_each_test.call test_file, test_names
+
+          load test_file
+
+          # at this point, the at_exit() hook of the testing framework used by
+          # the user's test suite will take care of running all tests defined
+          # by the test file loaded above and will also reflect any failures
+          # in the worker's exit status
+        end
+      end
+
+      # wait for worker processes to finish and report results
+      statuses = Process.waitall.map {|pid, status| status }
+
+      success = true
+      test_files.zip(statuses).map do |file, status|
+        success &&= test_passed = status.success?
+        notify.call "#{test_passed ? 'PASS' : 'FAIL'} #{file}"
+      end
+
+      @after_all_tests.call(success, last_ran_at, test_files, statuses)
     end
 
     # reabsorb test execution overhead as necessary

metadata

@@ -3,10 +3,10 @@ name: test-loop
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 3
+  - 4
   - 0
-  - 2
-  version: 3.0.2
+  - 0
+  version: 4.0.0
 platform: ruby
 authors: 
 - Suraj N. Kurapati
@@ -14,10 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -08:00
+date: 2011-01-13 00:00:00 -08:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: diff
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: 
 executables: