parallel_rspec 2.1.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73b85e313868cc3fb29697f15b99911c17a6ba818c80723c05ca6cf2cb450b00
-  data.tar.gz: a86b018f8fe152d0bf4203f3f076eb5e08583b65bbe4dd390220869a3292fb12
+  metadata.gz: c7a38c7f6a685aef852543e1c676aae48e0066fd98f5b6b51c3ca44ca1b8b3b0
+  data.tar.gz: 98b98c46b8ef5f8b60066a838b9e58b2df26cd2501086c86d2d7966adb2972cc
 SHA512:
-  metadata.gz: 8fa15fcdb155ba22163b604b8d2abaa7ba003e2b1c1169dd5565399b29757c714d7362626959024c26e32068fbf6974590533d0b37d7f55f7fd329d8d06755a9
-  data.tar.gz: 895f4135c2603f10a6e721c36d15cd0c0b9b7ba212e4f8b577fdc923030479332bcb55799bf12e78332649e6e6cecbca1946a7181416a567fffde27cfad50be4
+  metadata.gz: 79ab6a5abf73b8c8a788dd45626aa22d25284af00c4146ef9fa0a174adb7d1c648f5fde0399ecbca5f6103df17bd70c389ee22a9b05e88da9a98a463ee39ca21
+  data.tar.gz: 31d2d263fa915de652ce0e990b23387d3946ee1d72d265ba3ec8242a6b483cc2b0d095e02b803614a94ce5bd00a363c74714d147ddb66da2c2bef60e892d52a0

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 2.3.0
+
+* Increase default workers from 2 to 4.
+* Fix behavioral inconsistency with rspec-core in nested describe blocks on helper methods with clashing let methods.
+
+## 2.2.0
+
+* Fix incompatibility with `rspec --profile`.
+
 ## 2.1.2
 
 * Fix error when used in projects without ActiveSupport. Thanks @erikpaasonen.

data/README.md

@@ -24,13 +24,13 @@ And then execute:
 
     $ bundle
 
-This version of ParallelRSpec has been tested with RSpec 3.10.
+This version of ParallelRSpec has been tested with RSpec 3.12.
 
 ## Usage
 
-By default, ParallelRSpec will use two workers.  If you would like to use more, set an environment variable:
+By default, ParallelRSpec will use four workers.  If you would like to use more, set an environment variable:
 
-    $ export WORKERS=4
+    $ export WORKERS=8
 
 ParallelRSpec runs each worker with its own copy of the test database to avoid locking and deadlocking problems.  To create these and populate them with your schema, run:
 
@@ -59,7 +59,7 @@ By default, there's a task called `parallel_rspec` which will run all specs. To
   require 'parallel_rspec'
 
   ParallelRSpec::RakeTask.new(:prspec) do |t|
-    ENV['WORKERS'] = '4'
+    ENV['WORKERS'] = '8'
     t.pattern = "spec/**/*_spec.rb"
     t.rspec_opts = "--tag parallel"
     # etc...
@@ -82,6 +82,10 @@ You might also want to detect whether your spec suite is running under ParallelR
   do_something unless ParallelRSpec.running?
 ```
 
+## Limitations
+
+ParallelRSpec can't parallelize the specs in groups that use `before(:context)` or `after(:context)` (AKA `before(:all)` or `after(:all)`) hooks, since these may mean that there is state shared between examples.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/willbryant/parallel_rspec.

data/lib/parallel_rspec/client.rb

@@ -15,52 +15,38 @@ module ParallelRSpec
     end
 
     def example_started(example)
-      channel_to_server.write([:example_started, serialize_example(example)])
+      channel_to_server.write([:example_started, example.id, updates_from(example)])
     end
 
     def example_passed(example)
-      channel_to_server.write([:example_passed, serialize_example(example)])
+      channel_to_server.write([:example_passed, example.id, updates_from(example)])
     end
 
     def example_failed(example)
-      channel_to_server.write([:example_failed, serialize_example(example)])
+      channel_to_server.write([:example_failed, example.id, updates_from(example)])
     end
 
     def example_finished(example)
-      channel_to_server.write([:example_finished, serialize_example(example)])
+      channel_to_server.write([:example_finished, example.id, updates_from(example)])
     end
 
     def example_pending(example)
-      channel_to_server.write([:example_pending, serialize_example(example)])
+      channel_to_server.write([:example_pending, example.id, updates_from(example)])
     end
 
     def deprecation(hash)
       channel_to_server.write([:deprecation, hash])
     end
 
-    def serialize_example(example)
-      Example.new(
-        example.id,
-        example.description,
-        example.exception,
-        example.location_rerun_argument,
-        ExampleGroup.new([]),
-        example.metadata.slice(
-          :absolute_file_path,
-          :described_class,
-          :description,
-          :description_args,
+    def updates_from(example)
+      {
+        exception: example.exception,
+        metadata: example.metadata.slice(
           :execution_result,
-          :full_description,
-          :file_path,
-          :last_run_status,
-          :line_number,
-          :location,
           :pending,
-          :rerun_file_path,
-          :scoped_id,
-          :shared_group_inclusion_backtrace,
-          :type))
+          :skip,
+        )
+      }
     end
 
     def next_example_to_run

data/lib/parallel_rspec/runner.rb

@@ -58,7 +58,6 @@ module ParallelRSpec
     #   or the configured failure exit code (1 by default) if specs
     #   failed.
     def run_specs(example_groups)
-      puts "running #{@world.example_count(example_groups)}"
       @configuration.reporter.report(@world.example_count(example_groups)) do |reporter|
         @configuration.with_suite_hooks do
           with_context_hooks, without_context_hooks = example_groups.partition(&:any_context_hooks?)
@@ -78,6 +77,7 @@ module ParallelRSpec
         while next_example = client.next_example_to_run
           example_group, example_index = *next_example
           example = RSpec.world.filtered_examples[example_group][example_index]
+          example_group.parent_groups.reverse_each { |parent_group| parent_group.new("dummy instance to trigger helper loading order") }
           example_group_instance = example_group.new(example.inspect_output)
           success = example.run(example_group_instance, client) && success
         end

data/lib/parallel_rspec/server.rb

@@ -1,34 +1,34 @@
 module ParallelRSpec
   class Server
-    attr_reader :remaining_example_group_indexes, :reporter
+    attr_reader :reporter, :remaining_examples_by_group, :running_examples
 
     def initialize(reporter)
-      @remaining_example_group_indexes = RSpec.world.filtered_examples.each_with_object({}) do |(example_group, examples), results|
-        results[example_group] = examples.size unless example_group.any_context_hooks? || examples.size.zero?
+      @remaining_examples_by_group = RSpec.world.filtered_examples.each_with_object({}) do |(example_group, examples), results|
+        results[example_group] = examples unless example_group.any_context_hooks? || examples.size.zero?
       end
       @reporter = reporter
       @success = true
+      @running_examples = {}
     end
 
-    def example_started(example, channel_to_client)
-      reporter.example_started(example)
+    def example_started(example_id, example_updates, channel_to_client)
+      reporter.example_started(update_example(running_examples[example_id], example_updates))
     end
 
-    def example_passed(example, channel_to_client)
-      reporter.example_passed(example)
+    def example_finished(example_id, example_updates, channel_to_client)
+      reporter.example_finished(update_example(running_examples[example_id], example_updates))
     end
 
-    def example_failed(example, channel_to_client)
-      reporter.example_failed(example)
+    def example_passed(example_id, example_updates, channel_to_client)
+      reporter.example_passed(update_example(running_examples.delete(example_id), example_updates))
     end
 
-    def example_finished(example, channel_to_client)
-      pp example
-      reporter.example_finished(example)
+    def example_failed(example_id, example_updates, channel_to_client)
+      reporter.example_failed(update_example(running_examples.delete(example_id), example_updates))
     end
 
-    def example_pending(example, channel_to_client)
-      reporter.example_pending(example)
+    def example_pending(example_id, example_updates, channel_to_client)
+      reporter.example_pending(update_example(running_examples.delete(example_id), example_updates))
     end
 
     def deprecation(hash, channel_to_client)
@@ -36,13 +36,14 @@ module ParallelRSpec
     end
 
     def next_example_to_run(channel_to_client)
-      if remaining_example_group_indexes.empty?
+      if remaining_examples_by_group.empty?
         channel_to_client.write(nil)
       else
-        klass = remaining_example_group_indexes.keys.first
-        remaining_example_group_indexes[klass] -= 1
-        channel_to_client.write([klass, remaining_example_group_indexes[klass]])
-        remaining_example_group_indexes.delete(klass) if remaining_example_group_indexes[klass].zero?
+        example_group = remaining_examples_by_group.keys.first
+        example = remaining_examples_by_group[example_group].pop
+        running_examples[example.id] = example # cache so we don't need to look through all the examples for each message
+        channel_to_client.write([example_group, remaining_examples_by_group[example_group].size])
+        remaining_examples_by_group.delete(example_group) if remaining_examples_by_group[example_group].empty?
       end
     end
 
@@ -53,5 +54,11 @@ module ParallelRSpec
     def success?
       @success
     end
+
+    def update_example(example, data)
+      example.set_exception(data[:exception])
+      example.metadata.merge!(data[:metadata])
+      example
+    end
   end
 end

data/lib/parallel_rspec/version.rb

@@ -1,3 +1,3 @@
 module ParallelRSpec
-  VERSION = "2.1.2"
+  VERSION = "2.3.0"
 end

data/lib/parallel_rspec/workers.rb

@@ -2,7 +2,7 @@ module ParallelRSpec
   class Workers
     def self.number_of_workers
       workers = ENV['WORKERS'].to_i
-      workers = 2 if workers.zero?
+      workers = 4 if workers.zero?
       workers
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_rspec
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Will Bryant, Powershop New Zealand Ltd
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake