rspec-multiprocess_runner 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 185d6d6ded0da773c7c679f4be6f3fdfb2b1001f
-  data.tar.gz: 1cbda7661ed4231a77716bba89b1a9404d3a3c56
+SHA256:
+  metadata.gz: 2f561425e9f9c62eba1610b84278f1f3d86a5448d0c671324125bb88c0150f81
+  data.tar.gz: 3b79c2b0e07224cc2fe64204b0adf5e7ca90099846e84cc2078ad771c617c05d
 SHA512:
-  metadata.gz: 1af1843259763c862b5e09603420e9969af398adbbd25b49dff3c8dfe54b48ceee9d57f8410d94ba0a3fadf95d0759c851518f87a4d2b836e05e891b30988e1b
-  data.tar.gz: d08ecf9ca8d527298b06e900c276035c7eb5b7fb40413c526ef475801a0489a9f49436f5cff58d9d1da890fa33f327ef04446dce774b0ef8e2c35773d1b643a1
+  metadata.gz: ea71c613e8309da1d384f2c04778dce6871131bfa623ab4edabd4df6226d3393b39b6a1d3f688146881827650c56490a5b688139ba5c8bbcb76a199bced318d5
+  data.tar.gz: 0db27a58d409e7485c4c4ae934f59f53ea86d63fa2125194813fbbefdd28f39db90ea59355cf205e6b39610f344b99447d112d72adc293a12b303f29b2df1f1c

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.3.0
+
+* Add file output option
+
+# 1.2.4
+
 # 1.2.3
 
 * Fix time library sporadic failure

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    rspec-multiprocess_runner (1.3.0)
+      rspec (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+    stub_env (1.0.4)
+      rspec (>= 2.0, < 4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.10)
+  pry-byebug
+  rake (~> 10.0)
+  rspec-multiprocess_runner!
+  stub_env
+
+BUNDLED WITH
+   2.0.2

data/exe/multirspec

@@ -9,19 +9,7 @@ exit(64) unless options
 coordinator = RSpec::MultiprocessRunner::Coordinator.new(
   options.worker_count,
   options.files_to_run,
-  {
-    file_timeout_seconds: options.file_timeout_seconds,
-    example_timeout_seconds: options.example_timeout_seconds,
-    test_env_number_first_is_1: options.first_is_1,
-    rspec_options: options.rspec_options,
-    log_failing_files: options.log_failing_files,
-    use_given_order: options.use_given_order,
-    head_node: options.head_node,
-    port: options.port,
-    hostname: options.hostname,
-    max_nodes: options.max_nodes,
-    run_identifier: options.run_identifier
-  }
+  options
 )
 
 trap("INT") do

data/lib/rspec/multiprocess_runner/command_line_options.rb

@@ -3,12 +3,11 @@ require 'optparse'
 require 'pathname'
 
 module RSpec::MultiprocessRunner
-  # @private
   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,
-      :run_identifier
+      :run_identifier, :summary_filename
 
     DEFAULT_WORKER_COUNT = 3
 
@@ -25,6 +24,7 @@ module RSpec::MultiprocessRunner
       self.hostname = "localhost"
       self.head_node = true
       self.max_nodes = 5
+      self.summary_filename = nil
     end
 
     def parse(command_line_args, error_stream=$stderr)
@@ -144,6 +144,10 @@ module RSpec::MultiprocessRunner
           self.run_identifier = string
         end
 
+        parser.on("-f", "--summary-filename STRING", "Save summary to a file") do |string|
+          self.summary_filename = string
+        end
+
         parser.on_tail("-h", "--help", "Prints this help") do
           help_requested!
         end

data/lib/rspec/multiprocess_runner/coordinator.rb

@@ -5,13 +5,10 @@ require 'rspec/multiprocess_runner/file_coordinator'
 
 module RSpec::MultiprocessRunner
   class Coordinator
-    def initialize(worker_count, files, options={})
-      @worker_count = worker_count
-      @file_timeout_seconds = options[:file_timeout_seconds]
-      @example_timeout_seconds = options[:example_timeout_seconds]
-      @test_env_number_first_is_1 = options[:test_env_number_first_is_1]
-      @log_failing_files = options[:log_failing_files]
-      @rspec_options = options[:rspec_options]
+    attr_accessor :options
+
+    def initialize(worker_count, files, options)
+      self.options = options
       @file_buffer = []
       @workers = []
       @stopped_workers = []
@@ -55,10 +52,10 @@ module RSpec::MultiprocessRunner
         end_workers_in_parallel(@workers.dup, :kill_now)
       else
         @shutting_down = true
-        print "Shutting down #{pluralize(@workers.size, "worker")} …" if options[:print_summary]
+        print "Shutting down #{pluralize(@workers.size, "worker")} …" if options.print_summary
         # end_workers_in_parallel modifies @workers, so dup before sending in
         end_workers_in_parallel(@workers.dup, :shutdown_now)
-        if options[:print_summary]
+        if options.print_summary
           puts " done"
           print_summary
         end
@@ -175,19 +172,13 @@ module RSpec::MultiprocessRunner
     end
 
     def expected_worker_numbers
-      (1..@worker_count).to_a
+      (1..options.worker_count).to_a
     end
 
     def create_and_start_worker_if_necessary(n)
       if work_left_to_do?
         $stderr.puts "(Re)starting worker #{n}"
-        new_worker = Worker.new(
-          n,
-          file_timeout_seconds: @file_timeout_seconds,
-          example_timeout_seconds: @example_timeout_seconds,
-          rspec_options: @rspec_options,
-          test_env_number_first_is_1: @test_env_number_first_is_1
-        )
+        new_worker = Worker.new(n, options)
         @workers << new_worker
         new_worker.start
         file = get_file
@@ -196,7 +187,7 @@ module RSpec::MultiprocessRunner
     end
 
     def start_missing_workers
-      if @workers.size < @worker_count && work_left_to_do?
+      if @workers.size < options.worker_count && work_left_to_do?
         running_process_numbers = @workers.map(&:environment_number)
         missing_process_numbers = expected_worker_numbers - running_process_numbers
         missing_process_numbers.each do |n|
@@ -218,16 +209,20 @@ module RSpec::MultiprocessRunner
         idx[result.status] << result
       end
 
-      print_skipped_files_details
-      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(&:filename).uniq  + @file_coordinator.missing_files.to_a) if @log_failing_files
-      print_failed_process_details
-      puts
-      print_elapsed_time(elapsed)
-      puts failed? ? "FAILURE" : "SUCCESS"
-      print_example_counts(by_status_and_time)
+      outputs = [STDOUT]
+      outputs << File.new(options.summary_filename, 'w') if (options.summary_filename)
+      outputs.each do |output|
+        print_skipped_files_details(output)
+        print_pending_example_details(output, by_status_and_time["pending"])
+        print_failed_example_details(output, by_status_and_time["failed"])
+        print_missing_files(output)
+        log_failed_files(by_status_and_time["failed"].map(&:filename).uniq  + @file_coordinator.missing_files.to_a) if options.log_failing_files
+        print_failed_process_details(output)
+        output.puts
+        print_elapsed_time(output, elapsed)
+        output.puts failed? ? "FAILURE" : "SUCCESS"
+        print_example_counts(output, by_status_and_time)
+      end
     end
 
     def combine_example_results
@@ -238,41 +233,41 @@ module RSpec::MultiprocessRunner
       @file_coordinator.results.detect { |r| r.status == "failed" }
     end
 
-    def print_skipped_files_details
+    def print_skipped_files_details(output)
       return if !work_left_to_do?
-      puts
-      puts "Skipped files:"
+      output.puts
+      output.puts "Skipped files:"
       @file_coordinator.remaining_files.each do |spec_file|
-        puts "  - #{spec_file}"
+        output.puts "  - #{spec_file}"
       end
     end
 
-    def print_pending_example_details(pending_example_results)
+    def print_pending_example_details(output, pending_example_results)
       return if pending_example_results.nil?
-      puts
-      puts "Pending:"
+      output.puts
+      output.puts "Pending:"
       pending_example_results.each do |pending|
-        puts
-        puts pending.details.sub(/^\s*Pending:\s*/, '')
+        output.puts
+        output.puts pending.details.sub(/^\s*Pending:\s*/, '')
       end
     end
 
-    def print_failed_example_details(failed_example_results)
+    def print_failed_example_details(output, failed_example_results)
       return if failed_example_results.nil?
-      puts
-      puts "Failures:"
+      output.puts
+      output.puts "Failures:"
       failed_example_results.each_with_index do |failure, i|
-        puts
-        puts "  #{i.next}) #{failure.description}"
-        puts failure.details
+        output.puts
+        output.puts "  #{i.next}) #{failure.description}"
+        output.puts failure.details
       end
     end
 
     def log_failed_files(failed_files)
       return if failed_files.nil?
-      puts
-      puts "Writing failures to file: #{@log_failing_files}"
-      File.open(@log_failing_files, "w+") do |io|
+      output.puts
+      output.puts "Writing failures to file: #{options.log_failing_files}"
+      File.open(options.log_failing_files, "w+") do |io|
         failed_files.each do |file|
           io << file
           io << "\n"
@@ -285,7 +280,7 @@ module RSpec::MultiprocessRunner
       "#{count} #{string}#{'s' unless count.to_f == 1}"
     end
 
-    def print_example_counts(by_status_and_time)
+    def print_example_counts(output, by_status_and_time)
       example_count = by_status_and_time.map { |status, results| results.size }.inject(0) { |sum, ct| sum + ct }
       failure_count = by_status_and_time["failed"] ? by_status_and_time["failed"].size : 0
       pending_count = by_status_and_time["pending"] ? by_status_and_time["pending"].size : 0
@@ -300,26 +295,26 @@ module RSpec::MultiprocessRunner
       summary << ", " << pluralize(process_failure_count, "failed proc") if process_failure_count > 0
       summary << ", " << pluralize(skipped_count, "skipped file") if skipped_count > 0
       summary << ", " << pluralize(missing_count, "missing file") if missing_count > 0
-      puts summary
+      output.puts summary
     end
 
-    def print_failed_process_details
+    def print_failed_process_details(output)
       return if failed_workers.empty?
-      puts
-      puts "Failed processes:"
+      output.puts
+      output.puts "Failed processes:"
       failed_workers.each do |worker|
-        puts "  - #{worker.node}:#{worker.pid} (env #{worker.environment_number}) #{worker.deactivation_reason} on #{worker.current_file}"
+        output.puts "  - #{worker.node}:#{worker.pid} (env #{worker.environment_number}) #{worker.deactivation_reason} on #{worker.current_file}"
       end
     end
 
-    def print_missing_files
+    def print_missing_files(output)
       return if @file_coordinator.missing_files.empty?
-      puts
-      puts "Missing files from disconnects:"
-      @file_coordinator.missing_files.each { |file| puts "  + #{file} was given to a node, which disconnected" }
+      output.puts
+      output.puts "Missing files from disconnects:"
+      @file_coordinator.missing_files.each { |file| output.puts "  + #{file} was given to a node, which disconnected" }
     end
 
-    def print_elapsed_time(seconds_elapsed)
+    def print_elapsed_time(output, seconds_elapsed)
       minutes = seconds_elapsed.to_i / 60
       seconds = seconds_elapsed % 60
       m =
@@ -330,7 +325,7 @@ module RSpec::MultiprocessRunner
         if seconds > 0
           "%.2f second%s" % [seconds, seconds == 1 ? '' : 's']
         end
-      puts "Finished in #{[m, s].compact.join(", ")}"
+      output.puts "Finished in #{[m, s].compact.join(", ")}"
     end
   end
 end

data/lib/rspec/multiprocess_runner/file_coordinator.rb

@@ -1,10 +1,12 @@
 # encoding: utf-8
 require 'rspec/multiprocess_runner'
 require 'socket'
+require 'set'
 
 module RSpec::MultiprocessRunner
   class FileCoordinator
     attr_reader :results, :failed_workers
+    attr_accessor :options
 
     COMMAND_FILE = "file"
     COMMAND_RESULTS = "results"
@@ -17,14 +19,10 @@ module RSpec::MultiprocessRunner
       @results = Set.new
       @threads = []
       @failed_workers = []
+      self.options = options
       @spec_files_reference = files.to_set
-      @hostname = options[:hostname]
-      @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)
+      if options.head_node
+        @spec_files = options.use_given_order ? files : sort_files(files)
         Thread.start { run_tcp_server }
         @node_socket, head_node_socket = Socket.pair(:UNIX, :STREAM)
         Thread.start { server_connection_established(head_node_socket) }
@@ -32,7 +30,7 @@ module RSpec::MultiprocessRunner
         count = 100
         while @node_socket.nil? do
           begin
-            @node_socket = TCPSocket.new @hostname, @port
+            @node_socket = TCPSocket.new options.hostname, options.port
             raise unless start?
           rescue BadStartStringError
             @node_socket.close if @node_socket
@@ -55,7 +53,7 @@ module RSpec::MultiprocessRunner
     end
 
     def missing_files
-      if @head_node
+      if options.head_node
         @spec_files_reference - @results.map(&:filename) - @failed_workers.map(&:current_file) - @spec_files
       else
         []
@@ -85,7 +83,7 @@ module RSpec::MultiprocessRunner
     end
 
     def finished
-      if @head_node
+      if options.head_node
         if @tcp_server_running
          @tcp_server_running = false
          @threads.each(&:join)
@@ -108,10 +106,10 @@ module RSpec::MultiprocessRunner
     end
 
     def run_tcp_server
-      server = TCPServer.new @port
+      server = TCPServer.new options.port
       @tcp_server_running = true
       ObjectSpace.define_finalizer( self, proc { server.close } )
-      while @threads.size < @max_threads && @tcp_server_running
+      while @threads.size < options.max_nodes && @tcp_server_running
         @threads << Thread.start(server.accept) do |client|
           server_connection_established(client) if @tcp_server_running
         end
@@ -124,7 +122,7 @@ module RSpec::MultiprocessRunner
         break unless raw_response
         command, results, node = JSON.parse(raw_response)
         if command == COMMAND_START
-          if results == @start_string
+          if results == options.start_string
             socket.puts COMMAND_START
           else
             socket.puts COMMAND_FINISHED
@@ -145,7 +143,7 @@ module RSpec::MultiprocessRunner
 
     def start?
       begin
-        @node_socket.puts [COMMAND_START, @start_string].to_json
+        @node_socket.puts [COMMAND_START, options.start_string].to_json
         response = @node_socket.gets
         response = response.chomp if response
         raise BadStartStringError if response == COMMAND_FINISHED

data/lib/rspec/multiprocess_runner/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module MultiprocessRunner
-    VERSION = "1.2.3"
+    VERSION = "1.3.0"
   end
 end

data/lib/rspec/multiprocess_runner/worker.rb

@@ -22,7 +22,7 @@ module RSpec::MultiprocessRunner
   # @private
   class Worker
     attr_reader :pid, :environment_number, :example_results, :current_file
-    attr_accessor :deactivation_reason
+    attr_accessor :deactivation_reason, :options
 
     COMMAND_QUIT = "quit"
     COMMAND_RUN_FILE = "run_file"
@@ -33,10 +33,8 @@ module RSpec::MultiprocessRunner
     def initialize(environment_number, options)
       @environment_number = environment_number
       @worker_socket, @coordinator_socket = Socket.pair(:UNIX, :STREAM)
-      @rspec_arguments = (options[:rspec_options] || []) + ["--format", ReportingFormatter.to_s]
-      @example_timeout_seconds = options[:example_timeout_seconds]
-      @file_timeout_seconds = options[:file_timeout_seconds]
-      @test_env_number_first_is_1 = options[:test_env_number_first_is_1]
+      @rspec_arguments = (options.rspec_options || []) + ["--format", ReportingFormatter.to_s]
+      self.options = options
       @example_results = []
     end
 
@@ -52,7 +50,7 @@ module RSpec::MultiprocessRunner
     end
 
     def test_env_number
-      if environment_number == 1 && !@test_env_number_first_is_1
+      if environment_number == 1 && !options.first_is_1
         ""
       else
         environment_number.to_s
@@ -120,12 +118,12 @@ module RSpec::MultiprocessRunner
 
     def stalled?
       file_stalled =
-        if @file_timeout_seconds
-          working? && (Time.now - @current_file_started_at > @file_timeout_seconds)
+        if options.file_timeout_seconds
+          working? && (Time.now - @current_file_started_at > options.file_timeout_seconds)
         end
       example_stalled =
-        if @example_timeout_seconds
-          working? && (Time.now - @current_example_started_at > @example_timeout_seconds)
+        if options.example_timeout_seconds
+          working? && (Time.now - @current_example_started_at > options.example_timeout_seconds)
         end
       file_stalled || example_stalled
     end

data/rspec-multiprocess_runner.gemspec

@@ -6,21 +6,21 @@ require 'rspec/multiprocess_runner/version'
 Gem::Specification.new do |spec|
   spec.name          = "rspec-multiprocess_runner"
   spec.version       = RSpec::MultiprocessRunner::VERSION
-  spec.authors       = ["Rhett Sutphin"]
-  spec.email         = ["rhett@detailedbalance.net"]
+  spec.authors       = ["Rhett Sutphin", 'Jacob Bloom', 'Peter Nyberg', 'Kurt Werle']
+  spec.email         = ["rspec-multiprocess_runner@collaborativedrug.com"]
 
   spec.summary       = %q{A runner for RSpec 3 that uses multiple processes to execute specs in parallel}
   spec.homepage      = "https://github.com/cdd/rspec-multiprocess_runner"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|manual_test_specs)/}) }
+  spec.files         = Dir.glob('{bin,lib,exe}/**/*') + %w[rspec-multiprocess_runner.gemspec Gemfile Gemfile.lock Rakefile CHANGELOG.md LICENSE.txt README.md TODO.md]
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rspec", ">= 2.99"
+  spec.add_dependency "rspec", ">= 3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler", ">= 1.10"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "stub_env"

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rspec-multiprocess_runner
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Rhett Sutphin
+- Jacob Bloom
+- Peter Nyberg
+- Kurt Werle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,26 +19,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
@@ -82,17 +85,15 @@ dependencies:
         version: '0'
 description: 
 email:
-- rhett@detailedbalance.net
+- rspec-multiprocess_runner@collaborativedrug.com
 executables:
 - multirspec
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -131,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A runner for RSpec 3 that uses multiple processes to execute specs in parallel

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/spec/tmp
-/tmp/
-/manual_test_specs/*
-!/manual_test_specs/.keep
-/vendor

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-before_install: gem install bundler -v 1.10.6