parallel_rspec 0.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cd859eb40b317c48862eb67b4f24f3fa50e4bea8
-  data.tar.gz: 6c04d37e7c0828a2b3bfa7112e9819a28b814c91
+SHA256:
+  metadata.gz: 83c17d292ba1b11cd79f83f1d8b795d0e7a606fe605ab998fb8e71d6876212fe
+  data.tar.gz: e6504610a0782653c34ac985fa355588f3fe75880c41cfda63c637b5520c155f
 SHA512:
-  metadata.gz: 10d65506bd40f980d529362af9b5e95e3da72d0be1eda7bdb86ec52f16ac903b38fb9a717c2ca63da7c2533e639b7a1368aa067a7623287af42337a4aa7ca076
-  data.tar.gz: ef27474707581225d8514111a55c8859459979932730dade8872f62a70781dd4318ae51db90c33405aaac2674ffb067ef9fc71b39376030084824fd4dd514414
+  metadata.gz: 50a9c698147a7d65ff0452d3c83898dc46a54173683b9fa0886fc9b50aea9daae6205664063ccaee63a936cab567e2e26a3a6ff7fdf2dbcd2e2304c06da4e697
+  data.tar.gz: a16b420371af5586f1ff8f86d398cf46344c6b292430e853c82ac349f53f28d42882eff736f416168a4fdaabf6ffe62d971bdca61410ff81ae2b363a7bc04081

data/README.md

@@ -24,17 +24,17 @@ And then execute:
 
     $ bundle
 
-This version of ParallelRSpec has been tested with RSpec 3.3.
+This version of ParallelRSpec has been tested with RSpec 3.10.
 
 ## Usage
 
 By default, ParallelRSpec will use two workers.  If you would like to use more, set an environment variable:
 
-    $ export WORKERS=2
+    $ export WORKERS=4
 
 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:
 
-    $ bundle exec db:parallel:create db:parallel:prepare
+    $ bundle exec rake db:parallel:create db:parallel:prepare
 
 ParallelRSpec will automatically make the database name for each worker based on the name you used for the `test` environment in `config/database.yml`.  For example, if your normal `test` database is `foo_test`, worker 1 will keep using `foo_test` but worker 2's database will be `foo_test2`.
 
@@ -53,11 +53,46 @@ You may like to make an alias:
 
 When you change WORKERS, don't forget to restart Spring and re-run the create and populate steps above if necessary.
 
+To set up a rake task which uses parallel_rspec, use, for example:
+
+```ruby
+  require 'parallel_rspec'
+
+  ParallelRSpec::RakeTask.new(:prspec) do |t|
+    ENV['WORKERS'] = '4'
+    t.pattern = "**/spec/*_spec.rb"
+    t.rspec_opts = "--tag parallel"
+    # etc...
+  end
+```
+
+If you'd like code to run after parallel_rspec has created each worker, you can specify a block to run:
+
+```ruby
+  ParallelRSpec.configure do |config|
+    config.after_fork do |worker_number|
+      puts "I am worker #{worker_number}"
+    end
+  end
+```
+
+You might also want to detect whether your spec suite is running under ParallelRSpec or not:
+
+```ruby
+  do_something unless ParallelRSpec.running?
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/willbryant/parallel_rspec.
 
 
+## Thanks
+
+* Charles Horn (@hornc)
+* Roger Nesbitt (@mogest)
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/parallel_rspec/client.rb

@@ -26,6 +26,10 @@ module ParallelRSpec
       channel_to_server.write([:example_failed, serialize_example(example)])
     end
 
+    def example_finished(example)
+      channel_to_server.write([:example_finished, serialize_example(example)])
+    end
+
     def example_pending(example)
       channel_to_server.write([:example_pending, serialize_example(example)])
     end
@@ -40,6 +44,7 @@ module ParallelRSpec
         example.description,
         example.exception,
         example.location_rerun_argument,
+        ExampleGroup.new([]),
         example.metadata.slice(
           :absolute_file_path,
           :described_class,
@@ -57,5 +62,14 @@ module ParallelRSpec
           :shared_group_inclusion_backtrace,
           :type))
     end
+
+    def next_example_to_run
+      channel_to_server.write([:next_example_to_run])
+      channel_to_server.read
+    end
+
+    def result(success)
+      channel_to_server.write([:result, success])
+    end
   end
 end

data/lib/parallel_rspec/config.rb

@@ -0,0 +1,13 @@
+module ParallelRSpec
+  module Config
+    @after_fork = []
+
+    def self.after_fork(&block)
+      if block
+        @after_fork << block
+      else
+        @after_fork
+      end
+    end
+  end
+end

data/lib/parallel_rspec/example.rb

@@ -1,7 +1,9 @@
 module ParallelRSpec
+  ExampleGroup = Struct.new(:parent_groups)
+
   # only the good bits of RSpec's Example class, those needed by the reporters and formatters and
   # marshallable.
-  Example = Struct.new(:id, :description, :exception, :location_rerun_argument, :metadata) do
+  Example = Struct.new(:id, :description, :exception, :location_rerun_argument, :example_group, :metadata) do
     def self.delegate_to_metadata(key)
       define_method(key) { metadata[key] }
     end
@@ -13,4 +15,4 @@ module ParallelRSpec
     delegate_to_metadata :pending
     delegate_to_metadata :skip
   end
-end
+end

data/lib/parallel_rspec/railtie.rb

@@ -1,11 +1,14 @@
-require 'rails'
+begin
+  require 'rails'
 
-module ParallelRSpec
-  class Railtie < Rails::Railtie
-    railtie_name :parallel_rspec
+  module ParallelRSpec
+    class Railtie < Rails::Railtie
+      railtie_name :parallel_rspec
 
-    rake_tasks do
-      load "parallel_rspec/tasks.rake"
+      rake_tasks do
+        load "parallel_rspec/tasks.rake"
+      end
     end
   end
+rescue LoadError
 end

data/lib/parallel_rspec/rake_task.rb

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+
+module ParallelRSpec
+  class RakeTask < RSpec::Core::RakeTask
+    def initialize(*args, &task_block)
+      super
+      self.rspec_path = File.expand_path('../../../exe/prspec', __FILE__)
+    end
+  end
+end

data/lib/parallel_rspec/runner.rb

@@ -16,6 +16,12 @@ end
 
 module ParallelRSpec
   class Runner < RSpec::Core::Runner
+    @@running = false
+
+    def self.running?
+      @@running
+    end
+
     # Runs the suite of specs and exits the process with an appropriate exit
     # code.
     def self.invoke
@@ -39,6 +45,7 @@ module ParallelRSpec
     #   or the configured failure exit code (1 by default) if specs
     #   failed.
     def self.run(args, err=$stderr, out=$stdout)
+      @@running = true
       RSpec::Core::Runner.trap_interrupt
       options = RSpec::Core::ConfigurationOptions.new(args)
       new(options).run(err, out)
@@ -66,15 +73,14 @@ module ParallelRSpec
       workers = Workers.new
       workers.run_test_workers_with_server(server) do |worker, channel_to_server|
         client = Client.new(channel_to_server)
-        index = 0
-        RSpec.world.filtered_examples.each do |group, examples|
-          examples.reject! do |example|
-            index += 1
-            (index % workers.number_of_workers) != (worker % workers.number_of_workers)
-          end
+        success = true
+        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_instance = example_group.new(example.inspect_output)
+          success = example.run(example_group_instance, client) && success
         end
-        success = example_groups.map { |g| g.run(client) }.all?
-        channel_to_server.write([:result, success])
+        client.result(success)
       end
       server.success?
     end

data/lib/parallel_rspec/server.rb

@@ -1,34 +1,52 @@
 module ParallelRSpec
   class Server
-    attr_reader :reporter
+    attr_reader :remaining_example_group_indexes, :reporter
 
     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?
+      end
       @reporter = reporter
       @success = true
     end
 
-    def example_started(example)
+    def example_started(example, channel_to_client)
       reporter.example_started(example)
     end
 
-    def example_passed(example)
+    def example_passed(example, channel_to_client)
       reporter.example_passed(example)
     end
 
-    def example_failed(example)
+    def example_failed(example, channel_to_client)
       reporter.example_failed(example)
     end
 
-    def example_pending(example)
+    def example_finished(example, channel_to_client)
+      reporter.example_finished(example)
+    end
+
+    def example_pending(example, channel_to_client)
       reporter.example_pending(example)
     end
 
-    def deprecation(hash)
+    def deprecation(hash, channel_to_client)
       reporter.deprecation(hash)
     end
 
-    def result(result)
-      @success &&= result
+    def next_example_to_run(channel_to_client)
+      if remaining_example_group_indexes.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?
+      end
+    end
+
+    def result(success, channel_to_client)
+      @success &&= success
     end
 
     def success?

data/lib/parallel_rspec/tasks.rake

@@ -22,7 +22,11 @@ db_namespace = namespace :db do
       begin
         ParallelRSpec::Workers.new.run_test_workers do |worker|
           ActiveRecord::Schema.verbose = false
-          ActiveRecord::Tasks::DatabaseTasks.load_schema_for ActiveRecord::Base.configurations['test'], :ruby, ENV['SCHEMA']
+          if ActiveRecord::Tasks::DatabaseTasks.respond_to?(:load_schema_current)
+            ActiveRecord::Tasks::DatabaseTasks.load_schema_current :ruby, ENV['SCHEMA'], 'test'
+          else
+            ActiveRecord::Tasks::DatabaseTasks.load_schema_for ActiveRecord::Base.configurations['test'], :ruby, ENV['SCHEMA']
+          end
         end
       ensure
         if should_reconnect
@@ -34,7 +38,11 @@ db_namespace = namespace :db do
     # desc "Recreate the test database from an existent structure.sql file"
     task :load_structure => %w(db:parallel:purge) do
       ParallelRSpec::Workers.new.run_test_workers do |worker|
-        ActiveRecord::Tasks::DatabaseTasks.load_schema_for ActiveRecord::Base.configurations['test'], :sql, ENV['SCHEMA']
+        if ActiveRecord::Tasks::DatabaseTasks.respond_to?(:load_schema_current)
+          ActiveRecord::Tasks::DatabaseTasks.load_schema_current :sql, ENV['SCHEMA'], 'test'
+        else
+          ActiveRecord::Tasks::DatabaseTasks.load_schema_for ActiveRecord::Base.configurations['test'], :sql, ENV['SCHEMA']
+        end
       end
     end
 

data/lib/parallel_rspec/version.rb

@@ -1,3 +1,3 @@
 module ParallelRSpec
-  VERSION = "0.3.1"
+  VERSION = "2.0.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 = 4 if workers.zero?
+      workers = 2 if workers.zero?
       workers
     end
 
@@ -30,6 +30,11 @@ module ParallelRSpec
         pid = fork do
           channel_to_client.close
           establish_test_database_connection(worker)
+
+          Config.after_fork.each do |proc|
+            proc.call(worker)
+          end
+
           yield worker, channel_to_server
         end
 
@@ -46,7 +51,7 @@ module ParallelRSpec
       while !channels.empty?
         Channel.read_select(channels).each do |channel|
           if command = channel.read
-            server.send(*command)
+            server.send(*(command + [channel]))
           else
             channels.delete(channel)
           end
@@ -56,8 +61,18 @@ module ParallelRSpec
 
     def establish_test_database_connection(worker)
       ENV['TEST_ENV_NUMBER'] = worker.to_s
-      ActiveRecord::Base.configurations['test']['database'] << worker.to_s unless worker == 1
-      ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+      if defined?(ActiveRecord)
+        if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+          ActiveRecord::Base.configurations.configs_for(env_name: 'test').each do |configuration|
+            configuration.database << worker.to_s unless worker == 1
+            ActiveRecord::Base.establish_connection(configuration)
+          end
+        else
+          configuration = ActiveRecord::Base.configurations['test']
+          configuration.with_indifferent_access['database'] << worker.to_s unless worker == 1
+          ActiveRecord::Base.establish_connection(configuration)
+        end
+      end
     end
 
     def verify_children(child_pids)

data/lib/parallel_rspec.rb

@@ -1,8 +1,20 @@
 require "parallel_rspec/version"
+require "parallel_rspec/config"
 require "parallel_rspec/channel"
 require "parallel_rspec/workers"
 require "parallel_rspec/example"
 require "parallel_rspec/server"
 require "parallel_rspec/client"
+require "parallel_rspec/rake_task"
 require "parallel_rspec/runner"
 require "parallel_rspec/railtie"
+
+module ParallelRSpec
+  def self.configure
+    yield Config
+  end
+
+  def self.running?
+    Runner.running?
+  end
+end

data/parallel_rspec.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rake", "> 10.0"
+  spec.add_dependency "rspec"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: parallel_rspec
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Will Bryant, Powershop New Zealand Ltd
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
+        version: '10.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: This gem lets you run your RSpec examples in parallel across across your
   CPUs.  Each worker automatically gets its own database to avoid conflicts.  The
   optional spring-prspec gem adds support for running under Spring.
@@ -58,8 +58,10 @@ files:
 - lib/parallel_rspec.rb
 - lib/parallel_rspec/channel.rb
 - lib/parallel_rspec/client.rb
+- lib/parallel_rspec/config.rb
 - lib/parallel_rspec/example.rb
 - lib/parallel_rspec/railtie.rb
+- lib/parallel_rspec/rake_task.rb
 - lib/parallel_rspec/runner.rb
 - lib/parallel_rspec/server.rb
 - lib/parallel_rspec/tasks.rake
@@ -70,7 +72,7 @@ homepage: https://github.com/willbryant/parallel_rspec
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,9 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: This gem lets you run your RSpec examples in parallel across across your
   CPUs.