test-loop 11.0.1 → 12.0.0

data/LICENSE

@@ -0,0 +1,16 @@
+(the ISC license)
+
+Copyright 2010 Suraj N. Kurapati <sunaku@gmail.com>
+Copyright 2011 Brian D. Burns <burns180@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.

data/README.md

@@ -32,6 +32,12 @@ Features
 
 * Implemented in less than 250 lines (SLOC) of pure Ruby code! :-)
 
+------------------------------------------------------------------------------
+Prerequisites
+------------------------------------------------------------------------------
+
+* Operating system that supports POSIX signals and the `fork()` system call.
+
 ------------------------------------------------------------------------------
 Installation
 ------------------------------------------------------------------------------
@@ -61,6 +67,10 @@ You can monitor your test processes in another terminal:
 
     watch 'ps xf | grep test-loop | sed 1,3d'
 
+If it stops responding, you can annihilate test-loop from another terminal:
+
+    pkill -9 -f test-loop
+
 ------------------------------------------------------------------------------
 Operation
 ------------------------------------------------------------------------------
@@ -220,7 +230,7 @@ configuration file:
     }
 
 ------------------------------------------------------------------------------
-Configuration Presets
+Configuration presets
 ------------------------------------------------------------------------------
 
 The following sub-libraries provide "preset" configurations.  To use them,
@@ -231,26 +241,30 @@ your application's `test/test_helper.rb` or `spec/spec_helper.rb` file.
 
 Shows on-screen-display notifications for test failures.
 
+### require 'test/loop/rails'
+
+Provides support for the Ruby on Rails web framework.
+
 ------------------------------------------------------------------------------
 Known issues
 ------------------------------------------------------------------------------
 
 ### Ruby on Rails
 
-* Ensure that your `config/environments/test.rb` file disables class caching
-  as follows (**NOTE:** this is done automatically for you if you use Rails
-  3):
+  * Ensure that your `config/environments/test.rb` file disables class caching
+    as follows (**NOTE:** if you are using Rails 3, the `test/loop/rails`
+    preset will automatically do this for you):
 
-      config.cache_classes = false
+        config.cache_classes = false
 
-  Otherwise, test-loop will appear to ignore source-code changes in your
-  models, controllers, helpers, and other Ruby source files.
+    Otherwise, test-loop will appear to ignore source-code changes in your
+    models, controllers, helpers, and other Ruby source files.
 
-* SQLite3 [raises `SQLite3::BusyException: database is locked` errors](
-  https://github.com/sunaku/test-loop/issues/2 ) because test-loop runs your
-  test files in parallel.  You can work around this by using an [in-memory
-  adapter for SQLite3]( https://github.com/mvz/memory_test_fix ) or by using
-  different database software (such as MySQL) for your test environment.
+  * SQLite3 [raises `SQLite3::BusyException: database is locked` errors](
+    https://github.com/sunaku/test-loop/issues/2 ) because test-loop runs your
+    test files in parallel.  You can work around this by using an [in-memory
+    adapter for SQLite3]( https://github.com/mvz/memory_test_fix ) or by using
+    different database software (such as MySQL) for your test environment.
 
 ------------------------------------------------------------------------------
 License

data/lib/test/loop.rb

@@ -49,19 +49,14 @@ module Test
 
   class << Loop
     def run
-      @running_files = []
-      @running_files_lock = Mutex.new
-      @lines_by_file = {} # path => readlines
-      @last_ran_at = @started_at = Time.now
-
+      initialize_vars
       register_signals
       load_user_config
       absorb_overhead
-      load_lib_support
       run_test_loop
 
     rescue Interrupt
-      # allow user to break the loop by pressing Ctrl-C or sending SIGINT
+      # allow user to break the loop
 
     rescue Exception => error
       STDERR.puts error.inspect, error.backtrace
@@ -75,13 +70,16 @@ module Test
 
     private
 
-    EXEC_VECTOR = [$0, *ARGV].map {|s| s.dup.freeze }.freeze
+    MASTER_ARGV = [$0, *ARGV].map {|s| s.dup.freeze }.freeze
     RESUME_ENV_KEY = 'TEST_LOOP_RESUME_FILES'.freeze
+    MASTER_ENV = ENV.to_hash.delete_if {|k,v| k == RESUME_ENV_KEY }.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
 
+    Worker = Struct.new(:test_file, :log_file, :started_at)
+
     def notify message
       # using print() because puts() is not an atomic operation.
       # also, clear the line before printing because some shells emit
@@ -89,25 +87,53 @@ module Test
       print "#{ANSI_CLEAR_LINE}test-loop: #{message}\n"
     end
 
+    def initialize_vars
+      @running_files = []
+      @lines_by_file = {} # path => readlines
+      @last_ran_at = @started_at = Time.now
+      @worker_by_pid = {}
+    end
+
     def register_signals
       # this signal is ignored in master and honored in workers, so all
       # workers can be killed by sending it to the entire process group
       trap :TERM, :IGNORE
 
-      master_pid = $$
-      master_trap = lambda do |signal, &handler|
-        trap signal do
-          if $$ == master_pid
-            handler.call
-          else
-            # ignore future ocurrences of this signal in worker processes
-            trap signal, :IGNORE
+      trap :CHLD do
+        finished_at = Time.now
+
+        begin
+          worker_pid = Process.wait
+          run_status = $?
+
+          worker = @worker_by_pid.delete(worker_pid)
+          elapsed_time = finished_at - worker.started_at
+
+          # report test results along with any failure logs
+          if run_status.success?
+            notify ANSI_GREEN % "PASS #{worker.test_file}"
+          elsif run_status.exited?
+            notify ANSI_RED % "FAIL #{worker.test_file}"
+            STDERR.print File.read(worker.log_file)
+          end
+
+          after_each_test.each do |hook|
+            hook.call worker.test_file, worker.log_file, run_status,
+                      worker.started_at, elapsed_time
           end
+
+          @running_files.delete worker.test_file
+
+        rescue Errno::ECHILD
+          # could not get the terminated child's PID.
+          # Ruby's backtick operator can cause this:
+          # http://stackoverflow.com/questions/1495354
         end
       end
 
-      master_trap.call(:QUIT) { reload_master_process }
-      master_trap.call(:TSTP) { forcibly_run_all_tests }
+      trap(:INT)  { raise Interrupt }
+      trap(:QUIT) { reload_master_process }
+      trap(:TSTP) { forcibly_run_all_tests }
     end
 
     def kill_workers
@@ -119,9 +145,10 @@ module Test
     # 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 }
+      test_files.concat @running_files
       kill_workers
-      exec({RESUME_ENV_KEY => test_files.inspect}, *EXEC_VECTOR)
+      exec MASTER_ENV.merge(RESUME_ENV_KEY => test_files.inspect),
+           *MASTER_ARGV, {:unsetenv_others => true}
     end
 
     def load_user_config
@@ -139,10 +166,6 @@ module Test
       end
     end
 
-    def load_lib_support
-      Dir[File.expand_path '../loop/support/*.rb', __FILE__].each {|f| load f }
-    end
-
     def pause_momentarily
       sleep 1
     end
@@ -179,9 +202,7 @@ module Test
 
         # 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 }
-
+        test_files -= @running_files
         unless test_files.empty?
           @last_ran_at = Time.now
           test_files.each {|file| run_test_file file }
@@ -192,7 +213,9 @@ module Test
     end
 
     def run_test_file test_file
-      @running_files_lock.synchronize { @running_files.push test_file }
+      notify "TEST #{test_file}"
+
+      @running_files.push test_file
       log_file = test_file + '.log'
 
       # cache the contents of the test file for diffing below
@@ -200,17 +223,24 @@ module Test
       old_lines = @lines_by_file[test_file] || new_lines
       @lines_by_file[test_file] = new_lines
 
+      started_at = Time.now
       worker_pid = fork do
-        # this signal is ignored in master and honored in workers, so all
-        # workers can be killed by sending it to the entire process group
-        trap :TERM, :DEFAULT
+        # handle signals meant for worker process
+        [:TERM, :CHLD].each {|sig| trap sig, :DEFAULT }
 
-        # this signal is honored by master and ignored in workers
-        trap :INT, :IGNORE
+        # ignore signals meant for master process
+        [:INT, :QUIT, :TSTP].each {|sig| trap sig, :IGNORE }
+
+        # detach worker from master's terminal device so that
+        # it does not receieve the user's control-key presses
+        Process.setsid
+
+        # detach worker from master's standard input stream
+        STDIN.reopen IO.pipe.first
 
         # capture test output in log file because tests are run in parallel
         # which makes it difficult to understand interleaved output thereof
-        $stderr.reopen($stdout.reopen(log_file, 'w')).sync = true
+        STDERR.reopen(STDOUT.reopen(log_file, 'w')).sync = true
 
         # determine which test blocks have changed inside the test file
         test_names = Diff::LCS.diff(old_lines, new_lines).flatten.map do |change|
@@ -237,29 +267,7 @@ module Test
         load test_file
       end
 
-      # monitor and report on the worker's progress
-      Thread.new do
-        notify "TEST #{test_file}"
-
-        # wait for worker to finish
-        Process.waitpid worker_pid
-        run_status = $?
-        elapsed_time = Time.now - @last_ran_at
-
-        # report test results along with any failure logs
-        if run_status.success?
-          notify ANSI_GREEN % "PASS #{test_file}"
-        elsif run_status.exited?
-          notify ANSI_RED % "FAIL #{test_file}"
-          STDERR.print File.read(log_file)
-        end
-
-        after_each_test.each do |f|
-          f.call test_file, log_file, run_status, @last_ran_at, elapsed_time
-        end
-
-        @running_files_lock.synchronize { @running_files.delete test_file }
-      end
+      @worker_by_pid[worker_pid] = Worker.new(test_file, log_file, started_at)
     end
   end
 end

data/lib/test/loop/rails.rb

@@ -0,0 +1,20 @@
+require 'test/loop'
+
+Test::Loop.reabsorb_file_globs.push(
+  'config/**/*.{rb,yml}',
+  'test/factories/*.rb',
+  'Gemfile.lock'
+)
+
+Test::Loop.test_file_matchers['app/**/*.rb'] =
+  Test::Loop.test_file_matchers['lib/**/*.rb']
+
+require 'rails/railtie'
+Class.new Rails::Railtie do
+  config.before_initialize do |app|
+    if app.config.cache_classes
+      warn "test-loop: Setting #{app.class}.config.cache_classes = false"
+      app.config.cache_classes = false
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: test-loop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 11.0.1
+  version: 12.0.0
 platform: ruby
 authors: 
 - Suraj N. Kurapati
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 -07:00
+date: 2011-04-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,13 +34,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- LICENSE
 - README.md
 - bin/test-loop
 - lib/test/loop.rb
 - lib/test/loop/notify.rb
-- lib/test/loop/support/rails.rb
-- lib/test/loop/support/minitest.rb
-- lib/test/loop/support/testunit.rb
+- lib/test/loop/rails.rb
 has_rdoc: true
 homepage: http://github.com/sunaku/test-loop
 licenses: []

data/lib/test/loop/support/minitest.rb

@@ -1,5 +0,0 @@
-if defined? MiniTest::Unit
-  Test::Loop.before_each_test.push proc {
-    MiniTest::Unit.output = $stdout
-  }
-end

data/lib/test/loop/support/rails.rb

@@ -1,21 +0,0 @@
-if defined? Rails
-  Test::Loop.reabsorb_file_globs.push(
-    'config/**/*.{rb,yml}',
-    'test/factories/*.rb',
-    'Gemfile.lock'
-  )
-
-  Test::Loop.test_file_matchers['app/**/*.rb'] =
-    Test::Loop.test_file_matchers['lib/**/*.rb']
-
-  if defined? Rails::Railtie
-    Class.new Rails::Railtie do
-      config.before_initialize do |app|
-        if app.config.cache_classes
-          warn "test-loop: Setting #{app.class}.config.cache_classes = false"
-          app.config.cache_classes = false
-        end
-      end
-    end
-  end
-end

data/lib/test/loop/support/testunit.rb

@@ -1,7 +0,0 @@
-if defined? Test::Unit::AutoRunner
-  Test::Loop.before_each_test.push proc {
-    Test::Unit::AutoRunner.prepare do |config|
-      config.runner_options[:output] = $stdout
-    end
-  }
-end