rspec-multiprocess_runner 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da6e498842698e2a4d310674c27cace4b39ca99d
-  data.tar.gz: dbc698c179206e1233bdb6448bc01611ca5aa036
+  metadata.gz: e7232c081ac1d6c3946e41139e61f7eabd655fac
+  data.tar.gz: 9a2a5afdf4915f7fc0ba5453a657da788817bce9
 SHA512:
-  metadata.gz: ef0ef92395a94c984f6f253cddbec507aac1f4f4e0d330009e2a383063fc35be8d3d7463892ad45a8d7c3810b09724de08ec323f4f551ff1641d7070f682c489
-  data.tar.gz: 87582349643f471ba15e90da662ab759539572eebc42f47af8f719b491bac36a2764aaf098da705f18d025f738583dc97bb4493b136d82eeb78a423e4d206383
+  metadata.gz: 4639ae0212bf4cdc713f1e2738a683e55d561fea521ddb0221e539f23679d917e59ff7d28f8d06c21b72aec7ee1d1ee06399380cef948548ea7b27fa4471cae2
+  data.tar.gz: 5698b967a5ff5791ef8ec29f8811502233bd8793c12d8686702c920817b062782da2ec27fece84d937a778a6ae9343745803d28fc6e553774ebca989bfe80c76

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.2.1
+
+* Fix missing files being triggered by empty files
+
+* Fix missing files also being skipped files
+
+* Add run identifier option to prevent incorrect spec version execution
+
 # 1.2.0
 
 * Can now run tests on multiple machines at a time by running in head node mode

data/README.md

@@ -101,6 +101,12 @@ A corresponding set up for a node node using SSH would be:
 
 N.B. Ensure that the head node has tcp local port forwarding permitted.
 
+A set of nodes and head node can be given a unique string in case multiple spec
+file versions may be tested near simultaneously to prevent execution of the
+wrong version.
+
+    $ multirspec -r a_git_commit_hash
+
 ### Rake
 
 There is a rake task wrapper for `multirspec`:

data/exe/multirspec

@@ -19,7 +19,8 @@ coordinator = RSpec::MultiprocessRunner::Coordinator.new(
     head_node: options.head_node,
     port: options.port,
     hostname: options.hostname,
-    max_nodes: options.max_nodes
+    max_nodes: options.max_nodes,
+    run_identifier: options.run_identifier
   }
 )
 

data/lib/rspec/multiprocess_runner/command_line_options.rb

@@ -7,7 +7,8 @@ module RSpec::MultiprocessRunner
   class CommandLineOptions
     attr_accessor :worker_count, :file_timeout_seconds, :example_timeout_seconds,
       :rspec_options, :explicit_files_or_directories, :pattern, :log_failing_files,
-      :first_is_1, :use_given_order, :port, :head_node, :hostname, :max_nodes
+      :first_is_1, :use_given_order, :port, :head_node, :hostname, :max_nodes,
+      :run_identifier
 
     DEFAULT_WORKER_COUNT = 3
 
@@ -139,6 +140,10 @@ module RSpec::MultiprocessRunner
           self.max_nodes = max_nodes
         end
 
+        parser.on("-r", "--run-identifier STRING", "A unique string used by nodes to confirm identity (e.g. a git commit hash)") do |string|
+          self.run_identifier = string
+        end
+
         parser.on_tail("-h", "--help", "Prints this help") do
           help_requested!
         end

data/lib/rspec/multiprocess_runner/coordinator.rb

@@ -27,7 +27,7 @@ module RSpec::MultiprocessRunner
       run_loop
       quit_all_workers
       @file_coordinator.finished
-      if @file_coordinator.missing_files.any?
+      if @file_coordinator.remaining_files.any?
         run_loop
         quit_all_workers
         @file_coordinator.finished
@@ -222,7 +222,7 @@ module RSpec::MultiprocessRunner
       print_pending_example_details(by_status_and_time["pending"])
       print_failed_example_details(by_status_and_time["failed"])
       print_missing_files
-      log_failed_files(by_status_and_time["failed"].map(&:file_path).uniq  + @file_coordinator.missing_files.to_a) if @log_failing_files
+      log_failed_files(by_status_and_time["failed"].map(&:filename).uniq  + @file_coordinator.missing_files.to_a) if @log_failing_files
       print_failed_process_details
       puts
       print_elapsed_time(elapsed)
@@ -231,7 +231,7 @@ module RSpec::MultiprocessRunner
     end
 
     def combine_example_results
-      @file_coordinator.results.sort_by { |r| r.time_finished }
+      @file_coordinator.results.select { |r| r.run_status == "example_complete" }.sort_by { |r| r.time_finished }
     end
 
     def any_example_failed?

data/lib/rspec/multiprocess_runner/file_coordinator.rb

@@ -22,6 +22,7 @@ module RSpec::MultiprocessRunner
       @port = options[:port]
       @max_threads = options[:max_nodes]
       @head_node = options[:head_node]
+      @start_string = options[:run_identifier]
       if @head_node
         @spec_files = options[:use_given_order] ? files : sort_files(files)
         Thread.start { run_tcp_server }
@@ -33,7 +34,11 @@ module RSpec::MultiprocessRunner
           begin
             @node_socket = TCPSocket.new @hostname, @port
             raise unless start?
+          rescue BadStartStringError
+            @node_socket.close if @node_socket
+            raise
           rescue
+            @node_socket.close if @node_socket
             @node_socket = nil
             raise if count < 0
             count -= 1
@@ -51,7 +56,7 @@ module RSpec::MultiprocessRunner
 
     def missing_files
       if @head_node
-        @spec_files_reference - @results.map(&:file_path) - @failed_workers.map(&:current_file)
+        @spec_files_reference - @results.map(&:filename) - @failed_workers.map(&:current_file) - @spec_files
       else
         []
       end
@@ -81,9 +86,11 @@ module RSpec::MultiprocessRunner
 
     def finished
       if @head_node
-        @tcp_server_running = false
-        @threads.each(&:join)
-        @spec_files += missing_files.to_a
+        if @tcp_server_running
+         @tcp_server_running = false
+         @threads.each(&:join)
+         @spec_files += missing_files.to_a
+        end
       else
         @node_socket.puts [COMMAND_FINISHED].to_json
       end
@@ -117,13 +124,18 @@ module RSpec::MultiprocessRunner
         break unless raw_response
         command, results, node = JSON.parse(raw_response)
         if command == COMMAND_START
-          socket.puts COMMAND_START
+          if results == @start_string
+            socket.puts COMMAND_START
+          else
+            socket.puts COMMAND_FINISHED
+            break
+          end
         elsif command == COMMAND_FILE
           socket.puts @spec_files.shift
         elsif command == COMMAND_PROCESS && results
           @failed_workers << MockWorker.from_json_parse(results, node || "unknown")
         elsif command == COMMAND_RESULTS && results = results.map { |result|
-          ExampleResult.from_json_parse(result) }
+          Result.from_json_parse(result) }
           @results += results
         elsif command == COMMAND_FINISHED
           break
@@ -131,18 +143,22 @@ module RSpec::MultiprocessRunner
       end
     end
 
-    def work_left_to_do?
-      !@spec_files.empty?
-    end
-
     def start?
       begin
-        @node_socket.puts [COMMAND_START].to_json
+        @node_socket.puts [COMMAND_START, @start_string].to_json
         response = @node_socket.gets
-        response && response.chomp == COMMAND_START
+        response = response.chomp if response
+        raise BadStartStringError if response == COMMAND_FINISHED
+        response == COMMAND_START
       rescue Errno::EPIPE
         false
       end
     end
   end
+
+  class BadStartStringError < StandardError
+    def initialize(msg="An incorrect unique string was passed by the head node.")
+      super
+    end
+  end
 end

data/lib/rspec/multiprocess_runner/rake_task.rb

@@ -77,6 +77,9 @@ module RSpec::MultiprocessRunner
     # Max number of connections to head_node. Defaults to `5`
     attr_accessor :max_nodes
 
+    #Unique string used by nodes to confirm identity
+    attr_accessor :run_identifier
+
     def initialize(*args, &task_block)
       @name            = args.shift || :multispec
       @verbose         = true
@@ -150,6 +153,9 @@ module RSpec::MultiprocessRunner
       if max_nodes
         cmd_parts << '--max-nodes' << max_nodes.to_s
       end
+      if run_identifier
+        cmd_parts << '--run-identifier' << run-identifier.to_s
+      end
       if files_or_directories
         cmd_parts.concat(files_or_directories)
       end

data/lib/rspec/multiprocess_runner/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module MultiprocessRunner
-    VERSION = "1.2.0"
+    VERSION = "1.2.1"
   end
 end

data/lib/rspec/multiprocess_runner/worker.rb

@@ -175,11 +175,12 @@ module RSpec::MultiprocessRunner
       return :dead unless message_hash # ignore EOF
       case message_hash["status"]
       when STATUS_RUN_COMPLETE
+        example_results << Result.new(message_hash)
         @current_file = nil
         @current_file_started_at = nil
         @current_example_started_at = nil
       when STATUS_EXAMPLE_COMPLETE
-        example_results << ExampleResult.new(message_hash)
+        example_results << Result.new(message_hash)
         suffix =
           case message_hash["example_status"]
           when "failed"
@@ -219,7 +220,7 @@ module RSpec::MultiprocessRunner
         description: description,
         line_number: line_number,
         details: details,
-        file_path: @current_file
+        filename: @current_file
       )
     end
 
@@ -321,15 +322,16 @@ module RSpec::MultiprocessRunner
   end
 
   # @private
-  class ExampleResult
-    attr_reader :status, :description, :details, :file_path, :time_finished
-
-    def initialize(example_complete_message, time = Time.now)
-      @hash = example_complete_message
-      @status = example_complete_message["example_status"]
-      @description = example_complete_message["description"]
-      @details = example_complete_message["details"]
-      @file_path = example_complete_message["file_path"]
+  class Result
+    attr_reader :run_status, :status, :description, :details, :filename, :time_finished
+
+    def initialize(complete_message, time = Time.now)
+      @hash = complete_message
+      @run_status = complete_message["status"]
+      @status = complete_message["example_status"]
+      @description = complete_message["description"]
+      @details = complete_message["details"]
+      @filename = complete_message["filename"]
       @time_finished = time
     end
 
@@ -338,7 +340,7 @@ module RSpec::MultiprocessRunner
     end
 
     def self.from_json_parse(hash)
-      ExampleResult.new(hash["hash"], Time.iso8601(hash["time"]))
+      Result.new(hash["hash"], Time.iso8601(hash["time"]))
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-multiprocess_runner
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Rhett Sutphin