test-loop 9.2.0 → 9.3.0

data/README.md

@@ -1,5 +1,5 @@
 test-loop - Continuous testing for Ruby with fork/eval
-======================================================
+==============================================================================
 
 test-loop is a fast continuous testing tool for Ruby that automatically
 detects and tests changes in your application in an efficient manner:
@@ -8,9 +8,9 @@ detects and tests changes in your application in an efficient manner:
 2. Forks to run your test files without overhead and in parallel.
 3. Avoids running unchanged test blocks inside changed test files.
 
-
+------------------------------------------------------------------------------
 Features
---------
+------------------------------------------------------------------------------
 
 * Tests *changes* in your Ruby application: avoids running (1) unchanged
   test files and (2) unchanged test blocks inside changed test files.
@@ -30,11 +30,11 @@ Features
 
 * Configurable through a `.test-loop` file in your current working directory.
 
-* Implemented in less than 150 lines (SLOC) of pure Ruby code! :-)
-
+* Implemented in less than 200 lines (SLOC) of pure Ruby code! :-)
 
+------------------------------------------------------------------------------
 Installation
-------------
+------------------------------------------------------------------------------
 
 As a Ruby gem:
 
@@ -43,12 +43,11 @@ As a Ruby gem:
 As a Git clone:
 
     gem install diff-lcs -v '>= 1.1.2'
-    gem install ansi -v '>= 1.2.2'
     git clone git://github.com/sunaku/test-loop
 
-
+------------------------------------------------------------------------------
 Invocation
-----------
+------------------------------------------------------------------------------
 
 If installed as a Ruby gem:
 
@@ -58,9 +57,13 @@ If installed as a Git clone:
 
     env RUBYLIB=lib ruby bin/test-loop
 
+You can monitor your test processes in another terminal:
+
+    watch "ps xf | egrep 'test-loop|(test|spec)/.+\.rb' | sed '1,3d'"
 
+------------------------------------------------------------------------------
 Operation
----------
+------------------------------------------------------------------------------
 
 * Press Control-Z or send the SIGTSTP signal to forcibly run all
   tests, even if there are no changes in your Ruby application.
@@ -70,25 +73,9 @@ Operation
 
 * Press Control-C or send the SIGINT signal to quit the test loop.
 
-
-Configuration Presets
----------------------
-
-The following sub-libraries provide "preset" configurations.  To use them,
-simply add the require() lines shown below to your `.test-loop` file or to
-your `{test,spec}/{test,spec}_helper.rb` files.
-
-* Defaults for Ruby on Rails testing:
-
-    require 'test/loop/rails'
-
-* OSD notifications on test failures:
-
-    require 'test/loop/notify'
-
-
+------------------------------------------------------------------------------
 Configuration
--------------
+------------------------------------------------------------------------------
 
 test-loop looks for a configuration file named `.test-loop` in the current
 working directory.  This configuration file is a normal Ruby script in which
@@ -112,8 +99,8 @@ you can query and modify the `Test::Loop` OpenStruct configuration as follows:
   For example, if test files had the same names as their source files followed
   by an underscore and the file name in reverse like this:
 
-  * lib/hello.rb => test/hello_olleh.rb
-  * app/world.rb => spec/world_ldrow.rb
+  * `lib/hello.rb` => `test/hello_olleh.rb`
+  * `app/world.rb` => `spec/world_ldrow.rb`
 
   Then you would add the following to your configuration file:
 
@@ -161,6 +148,13 @@ you can query and modify the `Test::Loop` OpenStruct configuration as follows:
   execution began, and (5) how many seconds it took for the overall test
   execution to complete.
 
+  For example, to delete log files for successful tests, add the following to
+  your configuration file:
+
+      Test::Loop.after_each_test = lambda do |test_file, log_file, run_status, started_at, elapsed_time|
+        File.delete(log_file) if run_status.success?
+      end
+
   For example, to see on-screen-display notifications only about test
   failures, add the following to your configuration file:
 
@@ -178,6 +172,10 @@ you can query and modify the `Test::Loop` OpenStruct configuration as follows:
         end
       end
 
+  Note that the above functionality is available as a configuration preset:
+
+      require 'test/loop/notify'
+
   For example, to see on-screen-display notifications about completed test
   runs, regardless of whether they passed or failed, add the following to your
   configuration file:
@@ -197,9 +195,27 @@ you can query and modify the `Test::Loop` OpenStruct configuration as follows:
         end
       end
 
+------------------------------------------------------------------------------
+Configuration Presets
+------------------------------------------------------------------------------
 
+The following sub-libraries provide "preset" configurations.  To use them,
+simply add the require() lines shown below to your `.test-loop` file or to
+your application's `test/test_helper.rb` or `spec/spec_helper.rb` file.
+
+* Support for Ruby on Rails testing:
+
+      require 'test/loop/rails'
+
+* On-screen-display notifications for test failures:
+
+      require 'test/loop/notify'
+
+------------------------------------------------------------------------------
 Known issues
-------------
+------------------------------------------------------------------------------
+
+If using Ruby on Rails:
 
 * Ensure that your `config/environments/test.rb` file disables class caching:
 
@@ -214,8 +230,8 @@ Known issues
   adapter for SQLite3]( https://github.com/mvz/memory_test_fix ) or by using
   different database software (such as MySQL) for your test environment.
 
-
+------------------------------------------------------------------------------
 License
--------
+------------------------------------------------------------------------------
 
-Released under the ISC license.  See the `bin/test-loop` file for details.
+Released under the ISC license.  See the LICENSE file for details.

data/lib/test/loop.rb

@@ -1,29 +1,5 @@
-#
-# test-loop - Continuous testing for Ruby with fork/eval
-#             https://github.com/sunaku/test-loop#readme
-#
-####
-#
-# (the ISC license)
-#
-# Copyright 2010 Suraj N. Kurapati <sunaku@gmail.com>
-#
-# Permission to use, copy, modify, and/or distribute this software for any
-# purpose with or without fee is hereby granted, provided that the above
-# copyright notice and this permission notice appear in all copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-#
-
 require 'ostruct'
 require 'diff/lcs'
-require 'ansi'
 
 module Test
   Loop = OpenStruct.new
@@ -77,6 +53,9 @@ module Test
       load_user_config
       absorb_overhead
       run_test_loop
+    rescue SystemExit
+      # allow exit() to terminate the test loop
+      notify 'Goodbye!'
     rescue Exception => error
       STDERR.puts error.inspect, error.backtrace
       pause_momentarily
@@ -86,31 +65,47 @@ module Test
     private
 
     EXEC_VECTOR = [$0, *ARGV].map {|s| s.dup.freeze }.freeze
+    RESUME_ENV_KEY = 'TEST_LOOP_RESUME_FILES'.freeze
+
+    ANSI_CLEAR_LINE = "\e[2K\e[0G".freeze
+    ANSI_GREEN = "\e[32m%s\e[0m".freeze
+    ANSI_RED = "\e[31m%s\e[0m".freeze
 
     def notify message
       # using print() because puts() is not an atomic operation
       print "test-loop: #{message}\n"
     end
 
+    def init_test_loop
+      @running_files = []
+      @running_files_lock = Mutex.new
+      @lines_by_file = {} # path => readlines
+      @last_ran_at = @started_at = Time.now
+    end
+
     def register_signals
-      # puts newline to shield normal output from control-key interference:
+      # clear line to shield normal output from control-key interference:
       # some shells like BASH emit text when control-key combos are pressed
-      trap(:INT) { puts; kill_master_and_workers }
-      trap(:QUIT) { puts; reload_master_process }
-      trap(:TSTP) { puts; forcibly_run_all_tests }
-    end
+      trap(:INT)  { print ANSI_CLEAR_LINE; kill_workers; exit }
+      trap(:QUIT) { print ANSI_CLEAR_LINE; reload_master_process }
+      trap(:TSTP) { print ANSI_CLEAR_LINE; forcibly_run_all_tests }
 
-    def kill_master_and_workers
-      Process.kill :KILL, -$$
+      master_pid = $$
+      trap(:TERM) { exit unless $$ == master_pid }
     end
 
-    def reload_master_process
-      notify 'Restarting loop...'
-      exec(*EXEC_VECTOR)
+    def kill_workers
+      notify 'Stopping tests...'
+      Process.kill :TERM, -$$
+      Process.waitall
     end
 
-    def pause_momentarily
-      sleep 1
+    # The given test files are passed down (along with currently running
+    # test files) to the next incarnation of test-loop for resumption.
+    def reload_master_process test_files = []
+      @running_files_lock.synchronize { test_files.concat @running_files }
+      kill_workers
+      exec({RESUME_ENV_KEY => test_files.inspect}, *EXEC_VECTOR)
     end
 
     def load_user_config
@@ -128,14 +123,12 @@ module Test
       end
     end
 
-    def init_test_loop
-      @running_files = []
-      @running_files_lock = Mutex.new
-      @lines_by_file = {} # path => readlines
-      @last_ran_at = @started_at = Time.now
+    def pause_momentarily
+      sleep 1
     end
 
     def forcibly_run_all_tests
+      notify 'Running all tests...'
       @last_ran_at = Time.at(0)
       @lines_by_file.clear
     end
@@ -143,22 +136,36 @@ module Test
     def run_test_loop
       notify 'Ready for testing!'
       loop do
-        # figure out what test files need to be run
+        # find test files that have been modified since the last run
         test_files = test_file_matchers.map do |source_glob, test_matcher|
           Dir[source_glob].select {|file| File.mtime(file) > @last_ran_at }.
           map {|path| Dir[test_matcher.call path] }
         end.flatten.uniq
 
+        # resume test files stopped by the previous incarnation of test-loop
+        if ENV.key? RESUME_ENV_KEY
+          resume_files = eval(ENV.delete(RESUME_ENV_KEY))
+          unless resume_files.empty?
+            notify 'Resuming tests...'
+            test_files.concat(resume_files).uniq!
+          end
+        end
+
+        # reabsorb test execution overhead as necessary
+        if Dir[*reabsorb_file_globs].any? {|f| File.mtime(f) > @started_at }
+          notify 'Overhead changed!'
+          reload_master_process test_files
+        end
+
+        # fork workers to run the test files in parallel,
+        # excluding test files that are already running
         test_files = @running_files_lock.
           synchronize { test_files - @running_files }
 
-        # fork worker processes to run the test files in parallel
-        @last_ran_at = Time.now
-        test_files.each {|file| run_test_file file }
-
-        # reabsorb test execution overhead as necessary
-        reload_master_process if Dir[*reabsorb_file_globs].
-          any? {|file| File.mtime(file) > @started_at }
+        unless test_files.empty?
+          @last_ran_at = Time.now
+          test_files.each {|file| run_test_file file }
+        end
 
         pause_momentarily
       end
@@ -213,9 +220,9 @@ module Test
 
         # report test results along with any failure logs
         if run_status.success?
-          notify ANSI::Code.green("PASS #{test_file}")
+          notify ANSI_GREEN % "PASS #{test_file}"
         else
-          notify ANSI::Code.red("FAIL #{test_file}")
+          notify ANSI_RED % "FAIL #{test_file}"
           STDERR.print File.read(log_file)
         end
 

metadata

@@ -2,15 +2,16 @@
 name: test-loop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 9.2.0
+  version: 9.3.0
 platform: ruby
 authors: 
 - Suraj N. Kurapati
+- Brian D. Burns
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 -07:00
+date: 2011-04-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,17 +25,6 @@ dependencies:
         version: 1.1.2
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ansi
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.2
-  type: :runtime
-  version_requirements: *id002
 description: 
 email: 
 executables: