test-queue 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbdc02f98f8e6e07a67693e13a244f5d50f5b6e5
-  data.tar.gz: 377d47b3e6b54fd3bbcb5d526d749480df6265dc
+  metadata.gz: 9254be449a22d8e9de7c7e36aa771229334e418b
+  data.tar.gz: 0ea2f7f7483c30a362c2e252f793e4e0b64fc5e7
 SHA512:
-  metadata.gz: 6bc6bc66ba5d4e4fe5a5a7c6a19522f0cf5dc1e3d044d33c9b462b36ad01097cdbaf133102f53bc61e0559bb33419574a10f4d17af0e20449b80a346eeb36440
-  data.tar.gz: 90885077e4c321b0f7c576b3ff7814e46aa43a98e7fb723cfbd770a2874f7655639cc5d4e8e1e943247779a31d092941303a03ebd8b3e886197ffbb09cd44033
+  metadata.gz: 4c75ab395ca7a1263b01f23e1208e3bc5701f65b15bdd45bbafc1ea11638bcb3e10df6f393480d5f1e5b591c0ddd40566f332b85e044d0b42b44a8645e3bfd5b
+  data.tar.gz: 62fa0a40aba6e1e0462ec04bb1b2cb6e54976d0cebc7fc7e0735b5d608b4d5f51d8d4c6b2956ab7b139f8345b76d152941056a7a122c781ef1f5c643f606ce4b

data/lib/test_queue/iterator.rb

@@ -6,7 +6,6 @@ module TestQueue
       @test_framework = test_framework
       @done = false
       @suite_stats = []
-      @procline = $0
       @sock = sock
       @filter = filter
       if @sock =~ /^(.+):(\d+)$/
@@ -20,6 +19,8 @@ module TestQueue
     def each
       fail "already used this iterator. previous caller: #@done" if @done
 
+      procline = $0
+
       while true
         # If we've hit too many failures in one worker, assume the entire
         # test suite is broken, and notify master so the run
@@ -39,7 +40,7 @@ module TestQueue
           item = Marshal.load(data)
           break if item.nil? || item.empty?
           if item == "WAIT"
-            $0 = "#{@procline} - Waiting for work"
+            $0 = "#{procline} - Waiting for work"
             sleep 0.1
             next
           end
@@ -49,7 +50,7 @@ module TestQueue
           # Maybe we were told to load a suite that doesn't exist anymore.
           next unless suite
 
-          $0 = "#{@procline} - #{suite.respond_to?(:description) ? suite.description : suite}"
+          $0 = "#{procline} - #{suite.respond_to?(:description) ? suite.description : suite}"
           start = Time.now
           if @filter
             @filter.call(suite){ yield suite }
@@ -64,6 +65,7 @@ module TestQueue
       end
     rescue Errno::ENOENT, Errno::ECONNRESET, Errno::ECONNREFUSED
     ensure
+      $0 = procline
       @done = caller.first
       File.open("/tmp/test_queue_worker_#{$$}_suites", "wb") do |f|
         Marshal.dump(@suite_stats, f)

data/lib/test_queue/runner.rb

@@ -45,7 +45,12 @@ module TestQueue
 
       @procline = $0
 
-      @whitelist = Set.new
+      @whitelist = if forced = ENV['TEST_QUEUE_FORCE']
+                     forced.split(/\s*,\s*/)
+                   else
+                     []
+                   end
+      @whitelist.freeze
 
       all_files = @test_framework.all_suite_files.to_set
       @queue = @stats.all_suites
@@ -53,14 +58,12 @@ module TestQueue
         .sort_by { |suite| -suite.duration }
         .map { |suite| [suite.name, suite.path] }
 
-      if forced = ENV['TEST_QUEUE_FORCE']
-        forced = forced.split(/\s*,\s*/)
-        @whitelist.merge(forced)
+      if @whitelist.any?
         @queue.select! { |suite_name, path| @whitelist.include?(suite_name) }
-        @queue.sort_by! { |suite_name, path| forced.index(suite_name) }
+        @queue.sort_by! { |suite_name, path| @whitelist.index(suite_name) }
       end
 
-      @whitelist.freeze
+      @awaited_suites = Set.new(@whitelist - @queue.map(&:first))
       @original_queue = Set.new(@queue).freeze
 
       @workers = {}
@@ -187,7 +190,7 @@ module TestQueue
     ensure
       stop_master
 
-      kill_workers
+      kill_subprocesses
     end
 
     def start_master
@@ -254,10 +257,24 @@ module TestQueue
     end
 
     def discover_suites
+      # Remote masters don't discover suites; the central master does and
+      # distributes them to remote masters.
       return if relay?
+
+      # No need to discover suites if all whitelisted suites are already
+      # queued.
+      return if @whitelist.any? && @awaited_suites.empty?
+
       @discovering_suites_pid = fork do
+        terminate = false
+        Signal.trap("INT") { terminate = true }
+
+        $0 = "test-queue suite discovery process"
+
         @test_framework.all_suite_files.each do |path|
           @test_framework.suites_from_file(path).each do |suite_name, suite|
+            Kernel.exit!(0) if terminate
+
             @server.connect_address.connect do |sock|
               sock.puts("NEW SUITE #{Marshal.dump([suite_name, path])}")
             end
@@ -268,6 +285,21 @@ module TestQueue
       end
     end
 
+    def awaiting_suites?
+      case
+      when @awaited_suites.any?
+        # We're waiting to find all the whitelisted suites so we can run them
+        # in the correct order.
+        true
+      when @queue.empty? && !!@discovering_suites_pid
+        # We don't have any suites yet, but we're working on it.
+        true
+      else
+        # It's fine to run any queued suites now.
+        false
+      end
+    end
+
     def enqueue_discovered_suite(suite_name, path)
       if @whitelist.any? && !@whitelist.include?(suite_name)
         return
@@ -282,6 +314,14 @@ module TestQueue
       # the front of the queue. It's better to run a fast suite early than to
       # run a slow suite late.
       @queue.unshift [suite_name, path]
+
+      if @awaited_suites.delete?(suite_name) && @awaited_suites.empty?
+        # We've found all the whitelisted suites. Sort the queue to match the
+        # whitelist.
+        @queue.sort_by! { |suite_name, path| @whitelist.index(suite_name) }
+
+        kill_suite_discovery_process("INT")
+      end
     end
 
     def after_fork_internal(num, iterator)
@@ -371,13 +411,12 @@ module TestQueue
       return if relay?
       remote_workers = 0
 
-      until @discovering_suites_pid.nil? && @queue.empty? && remote_workers == 0
+      until !awaiting_suites? && @queue.empty? && remote_workers == 0
         queue_status(@start_time, @queue.size, @workers.size, remote_workers)
 
-        # Make sure our discovery process is still doing OK.
-        if @discovering_suites_pid && Process.waitpid(@discovering_suites_pid, Process::WNOHANG) != nil
-          @discovering_suites_pid = nil
-          abort("Discovering suites failed.") unless $?.success?
+        if status = reap_suite_discovery_process(false)
+          abort("Discovering suites failed.") unless status.success?
+          abort("Failed to discover #{@awaited_suites.sort.join(", ")} specified in TEST_QUEUE_FORCE") if @awaited_suites.any?
         end
 
         if IO.select([@server], nil, nil, 0.1).nil?
@@ -388,11 +427,11 @@ module TestQueue
           case cmd
           when /^POP/
             # If we have a slave from a different test run, don't respond, and it will consider the test run done.
-            if obj = @queue.shift
+            if awaiting_suites?
+              sock.write(Marshal.dump("WAIT"))
+            elsif obj = @queue.shift
               data = Marshal.dump(obj)
               sock.write(data)
-            elsif @discovering_suites_pid
-              sock.write(Marshal.dump("WAIT"))
             end
           when /^SLAVE (\d+) ([\w\.-]+) (\w+)(?: (.+))?/
             num = $1.to_i
@@ -462,6 +501,11 @@ module TestQueue
       sock.close if sock
     end
 
+    def kill_subprocesses
+      kill_workers
+      kill_suite_discovery_process
+    end
+
     def kill_workers
       @workers.each do |pid, worker|
         Process.kill 'KILL', pid
@@ -470,6 +514,21 @@ module TestQueue
       reap_workers
     end
 
+    def kill_suite_discovery_process(signal="KILL")
+      return unless @discovering_suites_pid
+      Process.kill signal, @discovering_suites_pid
+      reap_suite_discovery_process
+    end
+
+    def reap_suite_discovery_process(blocking=true)
+      return unless @discovering_suites_pid
+      _, status = Process.waitpid2(@discovering_suites_pid, blocking ? 0 : Process::WNOHANG)
+      return unless status
+
+      @discovering_suites_pid = nil
+      status
+    end
+
     # Stop the test run immediately.
     #
     # message - String message to print to the console when exiting.
@@ -477,7 +536,7 @@ module TestQueue
     # Doesn't return.
     def abort(message)
       @aborting = true
-      kill_workers
+      kill_subprocesses
       Kernel::abort("Aborting: #{message}")
     end
 

data/test-queue.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'test-queue'
-  s.version = '0.3.0'
+  s.version = '0.3.1'
   s.summary = 'parallel test runner'
   s.description = 'minitest/rspec parallel test runner for CI environments'
 

data/test/minitest5.bats

@@ -37,6 +37,43 @@ teardown() {
   refute_output_contains "MiniTestSleep9"
 }
 
+assert_test_queue_force_ordering() {
+  run bundle exec minitest-queue "$@"
+  assert_status 0
+  assert_output_contains "Starting test-queue master"
+
+  # Turn the list of suites that were run into a comma-separated list. Input
+  # looks like:
+  #     SuiteName: .  <0.001>
+  actual_tests=$(echo "$output" | \
+                 egrep '^    .*: \.+  <' | \
+                 sed -E -e 's/^    (.*): \.+.*/\1/' | \
+                 tr '\n' ',' | \
+                 sed -e 's/,$//')
+  assert_equal "$TEST_QUEUE_FORCE" "$actual_tests"
+}
+
+@test "TEST_QUEUE_FORCE ensures test ordering" {
+  export TEST_QUEUE_WORKERS=1 TEST_QUEUE_FORCE="Meme::when asked about cheeseburgers,MiniTestEqual"
+
+  # Without stats file
+  rm -f .test_queue_stats
+  assert_test_queue_force_ordering ./test/samples/sample_minitest5.rb ./test/samples/sample_minispec.rb
+  rm -f .test_queue_stats
+  assert_test_queue_force_ordering ./test/samples/sample_minispec.rb ./test/samples/sample_minitest5.rb
+
+  # With stats file
+  assert_test_queue_force_ordering ./test/samples/sample_minitest5.rb ./test/samples/sample_minispec.rb
+  assert_test_queue_force_ordering ./test/samples/sample_minispec.rb ./test/samples/sample_minitest5.rb
+}
+
+@test "minitest-queue fails if TEST_QUEUE_FORCE specifies nonexistent tests" {
+  export TEST_QUEUE_WORKERS=1 TEST_QUEUE_FORCE="MiniTestSleep21,DoesNotExist"
+  run bundle exec minitest-queue ./test/samples/*_minitest5.rb
+  assert_status 1
+  assert_output_contains "Failed to discover DoesNotExist specified in TEST_QUEUE_FORCE"
+}
+
 @test "multi-master succeeds when all tests pass" {
   export TEST_QUEUE_RELAY_TOKEN=$(date | cksum | cut -d' ' -f1)
   TEST_QUEUE_RELAY=0.0.0.0:12345 bundle exec minitest-queue ./test/samples/sample_minitest5.rb || true &

data/test/testlib.bash

@@ -79,3 +79,11 @@ refute_output_matches() {
   }
   return 0
 }
+
+assert_equal() {
+  [ "$1" = "$2" ] || {
+    echo "Expected \"$1\" to equal \"$2\""
+    return 1
+  }
+  return 0
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-queue
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2016-09-21 00:00:00.000000000 Z
 dependencies: []
 description: minitest/rspec parallel test runner for CI environments
 email: ruby@tmm1.net