tork 19.11.1 → 20.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96f14406f95dcddafe9baa541a2ae220956c76f5
-  data.tar.gz: fe2256cb537e4e0a947f96e8255769963ca2718d
+  metadata.gz: 988c5ed6c085e6de19928b5f04c85cea9bfbe6eb
+  data.tar.gz: b853a4b2203626de84ef575def8797fb08491f7b
 SHA512:
-  metadata.gz: ea4534fb9de012f896e7444a8af834d380217dfdba07bbdbd4f15f49b86aca7d62e17315e31cf3043bf41ff3029dbbe41be43502c9444fabf0c30329e5d116cb
-  data.tar.gz: 556b26331f1fa0e3067ec6ff809bd88f3cd0617e37844f5c247af007bbba9916987a573d5ffa716a25c8d3cc187793c5d014e69ee9dc251b573b2a3db987f596
+  metadata.gz: 495c35b54ac9bcae981101907bb412315e8bf2a31968808d0cb141028e85e2aceb881a65249d8c18ae2074e1a60e39fa6f5f0bfef6e60a8b49bf8692879c18d7
+  data.tar.gz: dc868b471d3c70a3b12ee6f79708ec988f81eae6cd002e554f129fdf3b47ca6ec87bc144da15474daeaf74457b0803000e8554a39353b51aec197008ba74471f

data/VERSION.markdown

@@ -1,3 +1,58 @@
+## Version 20.0.0 (2014-10-26)
+
+### Major:
+
+  * tork-runner(1): percentage lied; print counts instead.
+
+    The percentage of completion is not accurate because it only measures
+    how many tests that have started running _so far_ have been completed.
+    This makes the percentage jump from 100% to lesser values as tests run.
+
+    Also drop the `tork-runner:` prefix from progress messages and replace
+    VT100 escape codes for reprinting in-place with a \r (carriage return).
+
+  * Shorten all status message tokens to ~4 characters.
+
+    * In tork-driver(1):
+      * `reabsorb` is now `over`
+
+    * In tork-engine(1):
+      * `idle` is now `done`
+      * `pass_now_fail` is now `fail!`
+      * `fail_now_pass` is now `pass!`
+
+    * In tork-master(1):
+      * `absorb` is now `boot`
+
+  * Shorten all commands names down to ~4 characters.
+
+    * In tork(1):
+      * the `o` input command character is now named `b`
+
+    * In tork-driver(1):
+      * the `run_all_test_files` command is now named `test!`
+      * the `over` message is now named `boot!`
+
+    * In tork-engine(1):
+      * the `reabsorb_overhead` command is now named `boot!`
+      * the `run_test_file` command is now named `test`
+      * the `run_test_files` command is now named `test`
+      * the `stop_running_test_files` command is now named `stop`
+      * the `rerun_passed_test_files` command is now named `pass!`
+      * the `rerun_failed_test_files` command is now named `fail!`
+      * the `list_failed_test_files` command is now named `fail?`
+      * the `over` status message is now named `boot!`
+
+### Minor:
+
+  * tork-engine(1): add `test?` and `pass?` listing commands.
+
+  * tork(1): emit "tork:" prefix on all messages sent to user.
+
+### Other:
+
+  * Upgrade to md2man 4.0 and binman 4.0.
+
 ## Version 19.11.1 (2014-10-24)
 
 This release improves support for RSpec 3 and Rails 4.

data/bin/tork

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK 1 2014-10-24 19.11.1
+# TORK 1 2014-10-26 20.0.0
 
 ## NAME
 

data/bin/tork-driver

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-DRIVER 1 2014-10-24 19.11.1
+# TORK-DRIVER 1 2014-10-26 20.0.0
 
 ## NAME
 
@@ -25,7 +25,7 @@ stdin that are single-line JSON arrays, it splits each of them into an array
 of words, using the same word-splitting algorithm as sh(1), before processing
 them.  For example, the line `a "b c"` is split into the `["a", "b c"]` array.
 
-`["run_all_test_files"]`
+`["test!"]`
   Runs all test files found within and beneath the current working directory.
 
 *...*
@@ -36,9 +36,8 @@ them.  For example, the line `a "b c"` is split into the `["a", "b c"]` array.
 This program prints the following messages, which are single-line JSON arrays,
 to stdout.
 
-`["reabsorb",` *overhead_file*`]`
-  Test execution overhead is being reabsorbed because *overhead_file* has
-  changed.
+`["boot!",` *overhead_file*`]`
+  Reabsorbing test execution overhead because *overhead_file* has changed.
 
 *...*
   Messages from tork-engine(1) and tork-master(1) are also reproduced here.

data/bin/tork-engine

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-ENGINE 1 2014-10-24 19.11.1
+# TORK-ENGINE 1 2014-10-26 20.0.0
 
 ## NAME
 
@@ -25,30 +25,34 @@ stdin that are single-line JSON arrays, it splits each of them into an array
 of words, using the same word-splitting algorithm as sh(1), before processing
 them.  For example, the line `a "b c"` is split into the `["a", "b c"]` array.
 
-`["reabsorb_overhead"]`
+`["boot!"]`
   Stops any test files that are currently running, reabsorbs the test
   execution overhead, and then re-runs those stopped test files.
 
-`["run_test_file"`, *test_file*`,` *line_numbers*...`]`
+`["test"`, *test_file*`,` *line_numbers*...`]`
+`["test"`, `[`*test_file*`,` *line_numbers*...`]`...`]`
   Runs tests that correspond to the given sequence of *line_numbers* in the
   given *test_file*.  If no *line_numbers* are given, then only those lines
   that have changed since the last run of *test_file* will be substituted.
   If any *line_numbers* are zero, then the entire *test_file* will be run.
 
-`["run_test_files"`, *test\_files\_with\_optional\_line\_numbers*`]`
-  Calls the `run_test_file` command once for each item in the given array.
+`["test?"]`
+  Lists all test files that are currently running.
 
-`["stop_running_test_files"`, *signal*`]`
+`["stop"`, *signal*`]`
   Stops test files that are currently running by sending the given *signal*
   (optional; defaults to "SIGTERM") to their respective worker processes.
 
-`["rerun_passed_test_files"]`
+`["pass!"]`
   Runs all test files that have passed during their most recent run.
 
-`["rerun_failed_test_files"]`
+`["pass?"]`
+  Lists all test files that have passed during their most recent run.
+
+`["fail!"]`
   Runs all test files that have failed during their most recent run.
 
-`["list_failed_test_files"]`
+`["fail?"]`
   Lists all test files that have failed during their most recent run.
 
 `["quit"]`
@@ -59,15 +63,15 @@ them.  For example, the line `a "b c"` is split into the `["a", "b c"]` array.
 This program prints the following messages, which are single-line JSON arrays,
 to stdout.
 
-`["idle",` *ran_test_files*`,` *passed_test_files*`,` *failed_test_files*`]`
+`["done",` *ran_test_files*`,` *passed_test_files*`,` *failed_test_files*`]`
   All queued tests have finished running and no new tests have been queued.
   In particular, *ran_test_files* test files have run, *passed_test_files*
   test files have passed, and *failed_test_files* test files have failed.
 
-`["pass_now_fail",` *test_file*`,` *message*`]`
+`["fail!",` *test_file*`,` *message*`]`
   A previously passing *test_file* has now failed.  See *message* for details.
 
-`["fail_now_pass",` *test_file*`,` *message*`]`
+`["pass!",` *test_file*`,` *message*`]`
   A previously failing *test_file* has now passed.  See *message* for details.
 
 *...*

data/bin/tork-herald

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-HERALD 1 2014-10-24 19.11.1
+# TORK-HERALD 1 2014-10-26 20.0.0
 
 ## NAME
 

data/bin/tork-master

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-MASTER 1 2014-10-24 19.11.1
+# TORK-MASTER 1 2014-10-26 20.0.0
 
 ## NAME
 
@@ -45,7 +45,7 @@ them.  For example, the line `a "b c"` is split into the `["a", "b c"]` array.
 This program prints the following messages, which are single-line JSON arrays,
 to stdout.
 
-`["absorb"]`
+`["boot"]`
   Test execution overhead has been absorbed.  We are ready for testing!
 
 `["test",` *test_file*`,` *line_numbers*`,` *log_file*`,` *worker_number*`]`

data/bin/tork-notify

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-NOTIFY 1 2014-10-24 19.11.1
+# TORK-NOTIFY 1 2014-10-26 20.0.0
 
 ## NAME
 
@@ -46,8 +46,8 @@ IO.popen('tork-remote tork-engine', 'r+') do |remote|
     # make notifications edge-triggered: pass => fail or vice versa.
     # we do not care about pass => pass or fail => fail transitions.
     icon = case event.to_sym
-           when :fail_now_pass then 'dialog-information'
-           when :pass_now_fail then 'dialog-error'
+           when :pass! then 'dialog-information'
+           when :fail! then 'dialog-error'
            end
 
     if icon

data/bin/tork-runner

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-RUNNER 1 2014-10-24 19.11.1
+# TORK-RUNNER 1 2014-10-26 20.0.0
 
 ## NAME
 
@@ -30,8 +30,8 @@ This program prints the following messages to stdout.
 
 This program prints the following messages to stderr if it is a TTY device.
 
-`tork-runner:` *NN.N*`% tested`
-  *NN.N* percent of test files were tested so far.
+*T* `tested,` *P* `passed,` *F* `failed`
+  So far, *T* test files were tested, *P* of them passed, *F* of them failed.
 
 ## OPTIONS
 
@@ -68,13 +68,13 @@ IO.popen('tork-driver', 'w+') do |driver|
   test_files = Dir[*ARGV]
   command =
     if test_files.empty?
-      [:run_all_test_files]
+      [:test!]
     else
-      [:run_test_files, test_files]
+      [:test, test_files]
     end
   driver.puts JSON.dump(command)
 
-  # track test runs & exit when finished
+  # track test runs and show the progress
   tested, passed, failed = 0, 0, []
   while line = driver.gets
     response = JSON.parse(line)
@@ -82,15 +82,22 @@ IO.popen('tork-driver', 'w+') do |driver|
     when :test then tested += 1
     when :pass then passed += 1
     when :fail then failed << response[3]
-    when :idle then
-      puts failed.map {|log| [nil, ">> #{log} <<", File.read(log)] }, nil,
-           "#{tested} tested, #{passed} passed, #{failed.count} failed"
-      exit! failed.empty?
+    when :done then break
     end
 
-    # tell user how many tests (percentage) have finished running;
-    # see http://www.termsys.demon.co.uk/vtansi.htm for ANSI VT100
-    STDERR.printf "\e[s\e[K%s: %02.1f%% tested\e[u", $0,
-      ((passed + failed.count) / tested.to_f) * 100 if STDERR.tty?
+    progress = "#{tested} tested, #{passed} passed, #{failed.length} failed"
+    #
+    # show testing progress if we are connected to a terminal device
+    #
+    # NOTE: \r (carriage return) moves cursor to beginning of line so we end
+    #       up overwriting any previously printed progress message; we don't
+    #       need to erase the line because message length is non-decreasing:
+    #       i.e. the counts shown in the message can only increase over time
+    #
+    STDERR.print "\r", progress if STDERR.tty?
   end
+
+  # report failures and exit accordingly
+  puts failed.map {|log| [nil, ">> #{log} <<", File.read(log)] }, nil, progress
+  exit! failed.empty?
 end

data/lib/tork/cliapp.rb

@@ -4,7 +4,7 @@ module Tork
 class CLIApp < Server
 
   def loop
-    tell @clients, 'Absorbing test execution overhead...', false
+    tell @clients, 'Absorbing test execution overhead...'
     @driver = popen('tork-driver')
     super
   ensure
@@ -22,17 +22,20 @@ protected
     Regexp.union(File.expand_path('../../..', __FILE__), TORK_DOLLAR_ZERO)
   }[^:]*:\d+:.+$/
 
+  # remove Ruby's built-in Kernel#test() method so our test() method works
+  undef test
+
   def recv client, message
     case client
     when @driver
       event, *details = message
 
       case event_sym = event.to_sym
-      when :absorb
-        tell @clients, 'Overhead absorbed. Ready for testing!', false
+      when :boot
+        tell @clients, 'Test execution overhead absorbed; ready to test!'
 
-      when :reabsorb
-        tell @clients, 'Reabsorbing changed overhead files...', false
+      when :boot!
+        tell @clients, 'Test execution overhead changed; re-absorbing...'
 
       when :test, :pass, :fail
         test_file, line_numbers, log_file, worker_number, exit_status = details
@@ -53,17 +56,18 @@ protected
 
         tell @clients, message, false
 
-      when :idle
+      when :done
         tested, passed, failed = details.map(&:length)
         tell @clients, "#{tested} tested, #{passed} passed, #{failed} failed"
       end
+
     else
       key = message.shift.lstrip[0,1].downcase
       cmd = Array(COMMANDS.fetch(key, [:help, client])) + message
       if respond_to? cmd.first, true
         __send__(*cmd)
       else
-        tell @clients, "Sending #{cmd.inspect} command...", false
+        tell @clients, "Sending #{cmd.inspect} command..."
         send @driver, cmd
       end
     end
@@ -72,27 +76,27 @@ protected
 private
 
   COMMANDS = {
-    't' => :run_test_file,
-    'a' => :run_all_test_files,
-    's' => :stop_running_test_files,
-    'k' => [:stop_running_test_files, :SIGKILL],
-    'p' => :rerun_passed_test_files,
-    'f' => :rerun_failed_test_files,
-    'l' => :list_failed_test_files,
-    'o' => :reabsorb_overhead,
+    't' => :test,
+    'a' => :test!,
+    's' => :stop,
+    'k' => [:stop, :SIGKILL],
+    'p' => :pass!,
+    'f' => :fail!,
+    'l' => :fail?,
+    'b' => :boot!,
     'q' => :quit,
   }
 
   def help client
-    tell client, <<HELP, false
-Type a then ENTER to run all test files.
+    tell client, <<HELP
+Type a then ENTER to run all available test files.
 Type t then SPACE then a filename then ENTER to run a specific test file.
 Type s then ENTER to stop currently running test files.
 Type k then ENTER to kill currently running test files.
 Type p then ENTER to re-run currently passing test files.
 Type f then ENTER to re-run currently failing test files.
 Type l then ENTER to list currently failing test files.
-Type o then ENTER to re-absorb test execution overhead.
+Type b then ENTER to re-absorb test execution overhead.
 Type h then ENTER to see this help message.
 Type q then ENTER to quit.
 HELP

data/lib/tork/driver.rb

@@ -25,11 +25,11 @@ class Driver < Server
     pclose @engine
   end
 
-  def run_all_test_files
+  def test!
     test_files_found = false
     Dir.glob(ALL_TEST_FILE_GLOBS) do |test_file|
       next if overhead_file? test_file
-      run_test_file test_file
+      test test_file
       test_files_found = true
     end
     tell @client, 'There are no test files to run.' unless test_files_found
@@ -59,8 +59,8 @@ protected
 
         # reabsorb text execution overhead if overhead files changed
         if overhead_file? changed_file
-          send @clients, [:reabsorb, changed_file]
-          reabsorb_overhead
+          send @clients, [:boot!, changed_file]
+          boot!
         else
           run_non_overhead_test_files find_dependent_test_files(changed_file)
         end
@@ -74,7 +74,7 @@ protected
 private
 
   def run_non_overhead_test_files test_files
-    run_test_files test_files.reject {|f| overhead_file? f }
+    test test_files.reject {|f| overhead_file? f }
   end
 
   def overhead_file? file

data/lib/tork/engine.rb

@@ -25,18 +25,22 @@ class Engine < Server
     pclose @master
   end
 
-  def reabsorb_overhead
+  def boot!
     @master.reconnect
 
     # resume running all previously running test files and
     # all previously failed test files in the new master
-    resume = @running_test_files + @failed_test_files
+    resumable = @running_test_files + @failed_test_files
     @running_test_files.clear
-    run_test_files resume
+    test resumable
   end
 
-  def run_test_file test_file, *line_numbers
-    if File.exist? test_file and @running_test_files.add? test_file
+  def test test_file, *line_numbers
+    # a list of tests was passed in for the first argument
+    if test_file.respond_to? :each and line_numbers.empty?
+      test_file.each {|args| test(*args) }
+
+    elsif File.exist? test_file and @running_test_files.add? test_file
       if line_numbers.empty?
         line_numbers = find_changed_line_numbers(test_file)
       else
@@ -47,11 +51,15 @@ class Engine < Server
     end
   end
 
-  def run_test_files test_files_with_optional_line_numbers
-    test_files_with_optional_line_numbers.each {|f| run_test_file(*f) }
+  def test?
+    if @running_test_files.empty?
+      tell @client, 'There are no running test files to list.'
+    else
+      tell @client, @running_test_files.sort, false
+    end
   end
 
-  def stop_running_test_files signal=nil
+  def stop signal=nil
     if @running_test_files.empty?
       tell @client, 'There are no running test files to stop.'
     else
@@ -60,23 +68,31 @@ class Engine < Server
     end
   end
 
-  def rerun_passed_test_files
+  def pass!
     if @passed_test_files.empty?
       tell @client, 'There are no passed test files to re-run.'
     else
-      run_test_files @passed_test_files
+      test @passed_test_files
+    end
+  end
+
+  def pass?
+    if @passed_test_files.empty?
+      tell @client, 'There are no passed test files to list.'
+    else
+      tell @client, @passed_test_files.sort, false
     end
   end
 
-  def rerun_failed_test_files
+  def fail!
     if @failed_test_files.empty?
       tell @client, 'There are no failed test files to re-run.'
     else
-      run_test_files @failed_test_files
+      test @failed_test_files
     end
   end
 
-  def list_failed_test_files
+  def fail?
     if @failed_test_files.empty?
       tell @client, 'There are no failed test files to list.'
     else
@@ -100,14 +116,14 @@ protected
           @recently_failed_test_files.add file
           was_pass = @passed_test_files.delete? file
           now_fail = @failed_test_files.add? file
-          send @clients, [:pass_now_fail, file, message] if was_pass and now_fail
+          send @clients, [:fail!, file, message] if was_pass and now_fail
 
         elsif line_numbers.empty?
           # only whole test file runs should qualify as pass
           @recently_passed_test_files.add file
           was_fail = @failed_test_files.delete? file
           now_pass = @passed_test_files.add? file
-          send @clients, [:fail_now_pass, file, message] if was_fail and now_pass
+          send @clients, [:pass!, file, message] if was_fail and now_pass
         end
 
         # notify user when all test files have finished running
@@ -119,7 +135,7 @@ protected
           @recently_failed_test_files.clear
 
           tested = passed + failed
-          send @clients, [:idle, tested, passed, failed]
+          send @clients, [:done, tested, passed, failed]
         end
       end