test-loop 12.0.2 → 12.0.3

data/LICENSE

@@ -2,6 +2,7 @@
 
 Copyright 2010 Suraj N. Kurapati <sunaku@gmail.com>
 Copyright 2011 Brian D. Burns <burns180@gmail.com>
+Copyright 2011 Daniel Pittman <daniel@rimspace.net>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

data/README.md

@@ -89,7 +89,7 @@ Operation
   * Press Control-Z or send the SIGTSTP signal to forcibly run all
     tests, even if there are no changes in your Ruby application.
 
-  * Press Control-\ or send the SIGQUIT signal to forcibly reabsorb
+  * Press Control-\\ or send the SIGQUIT signal to forcibly reabsorb
     the test execution overhead, even if its sources have not changed.
 
   * Press Control-C or send the SIGINT signal to quit the test loop.
@@ -211,7 +211,7 @@ preset does this for you):
 
         message = test_file
 
-        Thread.new do # run in background
+        fork do # run in background
           system 'notify-send', '-i', 'dialog-error', title, message or
           system 'growlnotify', '-a', 'Xcode', '-m', message, title or
           system 'xmessage', '-timeout', '5', '-title', title, message
@@ -233,7 +233,7 @@ configuration file:
 
       message = test_file
 
-      Thread.new do # run in background
+      fork do # run in background
         system 'notify-send', '-i', "dialog-#{success ? 'information' : 'error'}", title, message or
         system 'growlnotify', '-a', 'Xcode', '-m', message, title or
         system 'xmessage', '-timeout', '5', '-title', title, message

data/bin/test-loop

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
 require 'test/loop'
 Test::Loop.run
-exit! true # skip at_exit() handlers registered in the master process

data/lib/test/loop.rb

@@ -49,11 +49,12 @@ module Test
 
   class << Loop
     def run
-      initialize_vars
-      register_signals
+      init_shared_vars
+      trap_user_signals
       load_user_config
-      absorb_overhead
-      run_test_loop
+      load_user_overhead
+      init_worker_queue
+      enter_testing_loop
 
     rescue Interrupt
       # allow user to break the loop
@@ -64,7 +65,7 @@ module Test
       reload_master_process
 
     ensure
-      kill_workers
+      stop_worker_queue
       notify 'Goodbye!'
     end
 
@@ -78,7 +79,8 @@ module Test
     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)
+    Worker = Struct.new(:test_file, :log_file, :started_at, :finished_at,
+                        :exit_status)
 
     def notify message
       # using print() because puts() is not an atomic operation.
@@ -87,64 +89,33 @@ module Test
       print "#{ANSI_CLEAR_LINE}test-loop: #{message}\n"
     end
 
-    def initialize_vars
-      @running_files = []
+    def pause_momentarily
+      sleep 1
+    end
+
+    def init_shared_vars
       @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'
-
-      trap :CHLD do
-        finished_at = Time.now
-
-        begin
-          worker_pid = Process.wait
-          run_status = $?
-
-          if worker = @worker_by_pid.delete(worker_pid)
-            @running_files.delete worker.test_file
-
-            # 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, finished_at - worker.started_at
-            end
-          end
-        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
-
-      trap(:INT)  { raise Interrupt }
+    def trap_user_signals
+      trap(:INT) { raise Interrupt }
       trap(:TSTP) { forcibly_run_all_tests }
       trap(:QUIT) { reload_master_process }
     end
 
-    def kill_workers
-      notify 'Stopping tests...'
-      Process.kill :TERM, -$$
-      Process.waitall
+    def forcibly_run_all_tests
+      notify 'Running all tests...'
+      @last_ran_at = Time.at(0)
+      @lines_by_file.clear
     end
 
     # 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 = []
-      test_files.concat @running_files
-      kill_workers
+      test_files.concat currently_running_test_files
+      stop_worker_queue
       ENV.replace MASTER_ENV.merge(RESUME_ENV_KEY => test_files.inspect)
       exec(*MASTER_EXECV)
     end
@@ -156,7 +127,7 @@ module Test
       end
     end
 
-    def absorb_overhead
+    def load_user_overhead
       notify 'Absorbing overhead...'
       $LOAD_PATH.unshift 'lib', 'test', 'spec'
       Dir[*overhead_file_globs].each do |file|
@@ -164,19 +135,11 @@ module Test
       end
     end
 
-    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
-
-    def run_test_loop
+    def enter_testing_loop
       notify 'Ready for testing!'
       loop do
+        reap_worker_queue
+
         # 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 }.
@@ -200,42 +163,85 @@ module Test
 
         # fork workers to run the test files in parallel,
         # excluding test files that are already running
-        test_files -= @running_files
+        test_files -= currently_running_test_files
         unless test_files.empty?
           @last_ran_at = Time.now
-          test_files.each {|file| run_test_file file }
+          test_files.each {|file| fork_worker Worker.new(file) }
         end
 
         pause_momentarily
       end
     end
 
-    def run_test_file test_file
-      notify "TEST #{test_file}"
+    def currently_running_test_files
+      @worker_by_pid.values.map(&:test_file)
+    end
+
+    def init_worker_queue
+      # collect children (of which some may be workers) for reaping below
+      @exited_child_infos = []
+      trap :CHLD do
+        finished_at = Time.now
+        begin
+          while wait2_array = Process.wait2(-1, Process::WNOHANG)
+            @exited_child_infos.push [wait2_array, finished_at]
+          end
+        rescue SystemCallError
+          # raised by wait() when there are no child processes at all
+        end
+      end
+    end
+
+    # reap finished workers from previous iterations of the loop
+    def reap_worker_queue
+      while info = @exited_child_infos.shift
+        (child_pid, exit_status), finished_at = info
+        if worker = @worker_by_pid.delete(child_pid)
+          worker.exit_status = exit_status
+          worker.finished_at = finished_at
+          reap_worker worker
+        end
+      end
+    end
+
+    def stop_worker_queue
+      notify 'Stopping tests...'
+      trap :CHLD, 'DEFAULT'
+      @worker_by_pid.each_key do |worker_pid|
+        begin
+          Process.kill :TERM, -worker_pid
+        rescue SystemCallError
+          # worker is already terminated
+        end
+      end
+      Process.waitall
+    end
+
+    def fork_worker worker
+      notify "TEST #{worker.test_file}"
 
-      @running_files.push test_file
-      log_file = test_file + '.log'
+      worker.log_file = worker.test_file + '.log'
 
       # cache the contents of the test file for diffing below
-      new_lines = File.readlines(test_file)
-      old_lines = @lines_by_file[test_file] || new_lines
-      @lines_by_file[test_file] = new_lines
+      new_lines = File.readlines(worker.test_file)
+      old_lines = @lines_by_file[worker.test_file] || new_lines
+      @lines_by_file[worker.test_file] = new_lines
 
-      started_at = Time.now
-      worker_pid = fork do
+      worker.started_at = Time.now
+      pid = fork do
         # detach worker from master's terminal device so that
         # it does not receieve the user's control-key presses
         Process.setsid
 
         # unregister signal handlers inherited from master process
-        [:TERM, :CHLD, :INT, :TSTP, :QUIT].each {|sig| trap sig, 'DEFAULT' }
+        [:INT, :TSTP, :QUIT].each {|sig| trap sig, 'DEFAULT' }
 
         # 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(worker.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|
@@ -251,18 +257,35 @@ module Test
         end.compact.uniq
 
         # tell the testing framework to run only the changed test blocks
-        before_each_test.each {|f| f.call test_file, log_file, test_names }
+        before_each_test.each do |hook|
+          hook.call worker.test_file, worker.log_file, test_names
+        end
 
         # make the process title Test::Unit friendly and ps(1) searchable
-        $0 = "test-loop #{test_file}"
+        $0 = "test-loop #{worker.test_file}"
 
         # after loading the user's test file, the at_exit() hook of the
         # user's testing framework will take care of running the tests and
         # reflecting any failures in the worker process' exit status
-        load test_file
+        load worker.test_file
       end
 
-      @worker_by_pid[worker_pid] = Worker.new(test_file, log_file, started_at)
+      @worker_by_pid[pid] = worker
+    end
+
+    def reap_worker worker
+      # report test results along with any failure logs
+      if worker.exit_status.success?
+        notify ANSI_GREEN % "PASS #{worker.test_file}"
+      elsif worker.exit_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, worker.exit_status,
+                  worker.started_at, worker.finished_at - worker.started_at
+      end
     end
   end
 end

data/lib/test/loop/notify.rb

@@ -5,7 +5,7 @@ Test::Loop.after_each_test.push lambda {
   unless run_status.success? or run_status.signaled?
     title = 'FAIL at %s in %0.1fs' % [started_at.strftime('%r'), elapsed_time]
     message = test_file
-    Thread.new do # run in background
+    fork do # run in background
       system 'notify-send', '-i', 'dialog-error', title, message or
       system 'growlnotify', '-a', 'Xcode', '-m', message, title or
       system 'xmessage', '-timeout', '5', '-title', title, message

metadata

@@ -2,17 +2,17 @@
 name: test-loop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 12.0.2
+  version: 12.0.3
 platform: ruby
 authors: 
 - Suraj N. Kurapati
 - Brian D. Burns
+- Daniel Pittman
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-04-21 00:00:00 -07:00
-default_executable: 
+date: 2011-04-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: diff-lcs
@@ -40,7 +40,6 @@ files:
 - lib/test/loop.rb
 - lib/test/loop/notify.rb
 - lib/test/loop/rails.rb
-has_rdoc: true
 homepage: http://github.com/sunaku/test-loop
 licenses: []
 
@@ -64,9 +63,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Continuous testing for Ruby with fork/eval
 test_files: []
 
+has_rdoc: