parallel_rspec 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1df19064c0de30bc25fe56463553c51354d38319
-  data.tar.gz: 41552dac37c0fff6e8f04612493d4593ea68aa25
+  metadata.gz: cd859eb40b317c48862eb67b4f24f3fa50e4bea8
+  data.tar.gz: 6c04d37e7c0828a2b3bfa7112e9819a28b814c91
 SHA512:
-  metadata.gz: 7458d557acec03dfce6c25e3908d363b30c69d3bb896c1fd633471c25ce32f862d8b3b23ab4419247cd9730def619578fee671a1fa797881fc72372dacdd39d1
-  data.tar.gz: b7d6e86fe55ddc5e926c5452243e9e035c0dc6024f8570d6d4bb306b32a1dbf42cc0dd19fad10ac25ec47133dbe3c7dd7c96f6afff8a4e8e7008ebc672633cf5
+  metadata.gz: 10d65506bd40f980d529362af9b5e95e3da72d0be1eda7bdb86ec52f16ac903b38fb9a717c2ca63da7c2533e639b7a1368aa067a7623287af42337a4aa7ca076
+  data.tar.gz: ef27474707581225d8514111a55c8859459979932730dade8872f62a70781dd4318ae51db90c33405aaac2674ffb067ef9fc71b39376030084824fd4dd514414

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Will Bryant
+Copyright (c) 2015 Powershop New Zealand Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -12,13 +12,17 @@ group :development, :test do
 end
 ```
 
-And then execute:
+Or if you use Spring:
 
-    $ bundle
+```ruby
+group :development, :test do
+  gem 'spring-prspec'
+end
+```
 
-Or install it yourself as:
+And then execute:
 
-    $ gem install parallel_rspec
+    $ bundle
 
 This version of ParallelRSpec has been tested with RSpec 3.3.
 
@@ -38,6 +42,17 @@ You're then ready to run specs in parallel:
 
     $ bundle exec prspec spec/my_spec.rb spec/another_spec.rb
 
+Or if you use Spring:
+
+    $ bundle exec spring prspec spec/my_spec.rb spec/another_spec.rb
+
+You may like to make an alias:
+
+    $ alias prspec='bundle exec spring prspec'
+    $ prspec spec/my_spec.rb spec/another_spec.rb
+
+When you change WORKERS, don't forget to restart Spring and re-run the create and populate steps above if necessary.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/willbryant/parallel_rspec.

data/lib/parallel_rspec.rb

@@ -1,4 +1,8 @@
 require "parallel_rspec/version"
+require "parallel_rspec/channel"
 require "parallel_rspec/workers"
+require "parallel_rspec/example"
+require "parallel_rspec/server"
+require "parallel_rspec/client"
 require "parallel_rspec/runner"
 require "parallel_rspec/railtie"

data/lib/parallel_rspec/channel.rb

@@ -0,0 +1,54 @@
+module ParallelRSpec
+  # Adapted from nitra.
+  # Copyright 2012-2013 Roger Nesbitt, Powershop Limited, YouDo Limited.  MIT licence.
+  class Channel
+    ProtocolInvalidError = Class.new(StandardError)
+
+    attr_reader :rd, :wr
+    attr_accessor :raise_epipe_on_write_error
+
+    def initialize(rd, wr)
+      @rd = rd
+      @wr = wr
+      @rd.binmode
+      @wr.binmode
+    end
+
+    def self.pipe
+      c_rd, s_wr = IO.pipe("ASCII-8BIT", "ASCII-8BIT")
+      s_rd, c_wr = IO.pipe("ASCII-8BIT", "ASCII-8BIT")
+      [new(c_rd, c_wr), new(s_rd, s_wr)]
+    end
+
+    def self.read_select(channels)
+      fds = IO.select(channels.collect(&:rd))
+      fds.first.collect do |fd|
+        channels.detect {|c| c.rd == fd}
+      end
+    end
+
+    def close
+      rd.close
+      wr.close
+    end
+
+    def read
+      return unless line = rd.gets
+      if result = line.strip.match(/\ACOMMAND,(\d+)\z/)
+        data = rd.read(result[1].to_i)
+        Marshal.load(data)
+      else
+        raise ProtocolInvalidError, "Expected command length line, got #{line.inspect}"
+      end
+    end
+
+    def write(data)
+      encoded = Marshal.dump(data)
+      wr.write("COMMAND,#{encoded.bytesize}\n")
+      wr.write(encoded)
+      wr.flush
+    rescue Errno::EPIPE
+      raise if raise_epipe_on_write_error
+    end
+  end
+end

data/lib/parallel_rspec/client.rb

@@ -0,0 +1,61 @@
+module ParallelRSpec
+  class Client
+    attr_reader :channel_to_server
+
+    def initialize(channel_to_server)
+      @channel_to_server = channel_to_server
+    end
+
+    def example_group_started(group)
+      # not implemented yet - would need the same extraction/simplification for serialization as Example below
+    end
+
+    def example_group_finished(group)
+      # ditto
+    end
+
+    def example_started(example)
+      channel_to_server.write([:example_started, serialize_example(example)])
+    end
+
+    def example_passed(example)
+      channel_to_server.write([:example_passed, serialize_example(example)])
+    end
+
+    def example_failed(example)
+      channel_to_server.write([:example_failed, serialize_example(example)])
+    end
+
+    def example_pending(example)
+      channel_to_server.write([:example_pending, serialize_example(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,
+        example.metadata.slice(
+          :absolute_file_path,
+          :described_class,
+          :description,
+          :description_args,
+          :execution_result,
+          :full_description,
+          :file_path,
+          :last_run_status,
+          :line_number,
+          :location,
+          :pending,
+          :rerun_file_path,
+          :scoped_id,
+          :shared_group_inclusion_backtrace,
+          :type))
+    end
+  end
+end

data/lib/parallel_rspec/example.rb

@@ -0,0 +1,16 @@
+module ParallelRSpec
+  # 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
+    def self.delegate_to_metadata(key)
+      define_method(key) { metadata[key] }
+    end
+
+    delegate_to_metadata :execution_result
+    delegate_to_metadata :file_path
+    delegate_to_metadata :full_description
+    delegate_to_metadata :location
+    delegate_to_metadata :pending
+    delegate_to_metadata :skip
+  end
+end

data/lib/parallel_rspec/runner.rb

@@ -62,8 +62,10 @@ module ParallelRSpec
     end
 
     def run_in_parallel(example_groups, reporter)
+      server = Server.new(reporter)
       workers = Workers.new
-      workers.run_test_workers do |worker|
+      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|
@@ -71,10 +73,10 @@ module ParallelRSpec
             (index % workers.number_of_workers) != (worker % workers.number_of_workers)
           end
         end
-        success = example_groups.map { |g| g.run(reporter) }.all?
-        reporter.finish
-        success
+        success = example_groups.map { |g| g.run(client) }.all?
+        channel_to_server.write([:result, success])
       end
+      server.success?
     end
   end
 end

data/lib/parallel_rspec/server.rb

@@ -0,0 +1,38 @@
+module ParallelRSpec
+  class Server
+    attr_reader :reporter
+
+    def initialize(reporter)
+      @reporter = reporter
+      @success = true
+    end
+
+    def example_started(example)
+      reporter.example_started(example)
+    end
+
+    def example_passed(example)
+      reporter.example_passed(example)
+    end
+
+    def example_failed(example)
+      reporter.example_failed(example)
+    end
+
+    def example_pending(example)
+      reporter.example_pending(example)
+    end
+
+    def deprecation(hash)
+      reporter.deprecation(hash)
+    end
+
+    def result(result)
+      @success &&= result
+    end
+
+    def success?
+      @success
+    end
+  end
+end

data/lib/parallel_rspec/tasks.rake

@@ -1,17 +1,17 @@
-require 'lib/parallel_workers.rb'
+require 'parallel_rspec/workers.rb'
 
 db_namespace = namespace :db do
   namespace :parallel do
     # desc "Creates the test database"
     task :create => [:load_config] do
-      ParallelWorkers.new.run_test_workers do |worker|
+      ParallelRSpec::Workers.new.run_test_workers do |worker|
         ActiveRecord::Tasks::DatabaseTasks.create ActiveRecord::Base.configurations['test']
       end
     end
 
     # desc "Empty the test database"
     task :purge => %w(environment load_config) do
-      ParallelWorkers.new.run_test_workers do |worker|
+      ParallelRSpec::Workers.new.run_test_workers do |worker|
         ActiveRecord::Tasks::DatabaseTasks.purge ActiveRecord::Base.configurations['test']
       end
     end
@@ -20,7 +20,7 @@ db_namespace = namespace :db do
     task :load_schema => %w(db:parallel:purge) do
       should_reconnect = ActiveRecord::Base.connection_pool.active_connection?
       begin
-        ParallelWorkers.new.run_test_workers do |worker|
+        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']
         end
@@ -33,7 +33,7 @@ db_namespace = namespace :db do
 
     # desc "Recreate the test database from an existent structure.sql file"
     task :load_structure => %w(db:parallel:purge) do
-      ParallelWorkers.new.run_test_workers do |worker|
+      ParallelRSpec::Workers.new.run_test_workers do |worker|
         ActiveRecord::Tasks::DatabaseTasks.load_schema_for ActiveRecord::Base.configurations['test'], :sql, ENV['SCHEMA']
       end
     end

data/lib/parallel_rspec/version.rb

@@ -1,3 +1,3 @@
 module ParallelRSpec
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/parallel_rspec/workers.rb

@@ -13,24 +13,55 @@ module ParallelRSpec
     end
 
     def run_test_workers
-      children = (1..number_of_workers).collect do |worker|
+      child_pids = (1..number_of_workers).collect do |worker|
         fork do
           establish_test_database_connection(worker)
           yield worker
         end
       end
 
-      verify_children(children)
+      verify_children(child_pids)
+    end
+
+    def run_test_workers_with_server(server)
+      child_pids, channels = (1..number_of_workers).collect do |worker|
+        channel_to_client, channel_to_server = ParallelRSpec::Channel.pipe
+
+        pid = fork do
+          channel_to_client.close
+          establish_test_database_connection(worker)
+          yield worker, channel_to_server
+        end
+
+        channel_to_server.close
+        [pid, channel_to_client]
+      end.transpose
+
+      invoke_server_for_channels(server, channels)
+
+      verify_children(child_pids)
+    end
+
+    def invoke_server_for_channels(server, channels)
+      while !channels.empty?
+        Channel.read_select(channels).each do |channel|
+          if command = channel.read
+            server.send(*command)
+          else
+            channels.delete(channel)
+          end
+        end
+      end
     end
 
     def establish_test_database_connection(worker)
       ENV['TEST_ENV_NUMBER'] = worker.to_s
-      ActiveRecord::Base.configurations['test']['database'] << worker.to_s unless worker.zero?
+      ActiveRecord::Base.configurations['test']['database'] << worker.to_s unless worker == 1
       ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
     end
 
-    def verify_children(children)
-      results = children.collect { |pid| Process.wait2(pid).last }.reject(&:success?)
+    def verify_children(child_pids)
+      results = child_pids.collect { |pid| Process.wait2(pid).last }.reject(&:success?)
 
       unless results.empty?
         STDERR.puts "\n#{results.size} worker#{'s' unless results.size == 1} failed"

data/parallel_rspec.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Will Bryant, Powershop New Zealand Ltd"]
   spec.email         = ["will.bryant@gmail.com"]
 
-  spec.summary       = %q{This gem lets you run your RSpec examples in parallel across across your CPUs..}
-  spec.description   = %q{This gem lets you run your RSpec examples in parallel across across your CPUs.  Each worker automatically gets its own database to avoid conflicts.}
+  spec.summary       = %q{This gem lets you run your RSpec examples in parallel across across your CPUs.}
+  spec.description   = %q{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.}
   spec.homepage      = "https://github.com/willbryant/parallel_rspec"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parallel_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Will Bryant, Powershop New Zealand Ltd
@@ -39,7 +39,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.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.
+  CPUs.  Each worker automatically gets its own database to avoid conflicts.  The
+  optional spring-prspec gem adds support for running under Spring.
 email:
 - will.bryant@gmail.com
 executables:
@@ -55,8 +56,12 @@ files:
 - Rakefile
 - exe/prspec
 - lib/parallel_rspec.rb
+- lib/parallel_rspec/channel.rb
+- lib/parallel_rspec/client.rb
+- lib/parallel_rspec/example.rb
 - lib/parallel_rspec/railtie.rb
 - lib/parallel_rspec/runner.rb
+- lib/parallel_rspec/server.rb
 - lib/parallel_rspec/tasks.rake
 - lib/parallel_rspec/version.rb
 - lib/parallel_rspec/workers.rb
@@ -85,5 +90,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This gem lets you run your RSpec examples in parallel across across your
-  CPUs..
+  CPUs.
 test_files: []