parallel_rspec 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1df19064c0de30bc25fe56463553c51354d38319
+  data.tar.gz: 41552dac37c0fff6e8f04612493d4593ea68aa25
+SHA512:
+  metadata.gz: 7458d557acec03dfce6c25e3908d363b30c69d3bb896c1fd633471c25ce32f862d8b3b23ab4419247cd9730def619578fee671a1fa797881fc72372dacdd39d1
+  data.tar.gz: b7d6e86fe55ddc5e926c5452243e9e035c0dc6024f8570d6d4bb306b32a1dbf42cc0dd19fad10ac25ec47133dbe3c7dd7c96f6afff8a4e8e7008ebc672633cf5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parallel_rspec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Will Bryant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# ParallelRSpec
+
+This gem lets you run your RSpec examples in parallel across across your CPUs.  Each worker gets its own database to avoid conflicts.
+
+## Installation
+
+Add this to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'parallel_rspec'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parallel_rspec
+
+This version of ParallelRSpec has been tested with RSpec 3.3.
+
+## Usage
+
+By default, ParallelRSpec will use two workers.  If you would like to use more, set an environment variable:
+
+    $ export WORKERS=2
+
+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
+
+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`.
+
+You're then ready to run specs in parallel:
+
+    $ bundle exec prspec spec/my_spec.rb spec/another_spec.rb
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/willbryant/parallel_rspec.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright (c) Powershop New Zealand Ltd, 2015.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exe/prspec

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'parallel_rspec'
+ParallelRSpec::Runner.invoke

data/lib/parallel_rspec.rb

@@ -0,0 +1,4 @@
+require "parallel_rspec/version"
+require "parallel_rspec/workers"
+require "parallel_rspec/runner"
+require "parallel_rspec/railtie"

data/lib/parallel_rspec/railtie.rb

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

data/lib/parallel_rspec/runner.rb

@@ -0,0 +1,80 @@
+require 'rspec/core'
+
+module RSpec
+  module Core
+    class ExampleGroup
+      def self.any_context_hooks?
+        # unfortunately the public HookCollection API doesn't make this information available, so we have to grab it from internals
+        descendants.any? do |group| # despite the name, descendents includes self
+          group.hooks.send(:matching_hooks_for, :before, :context, group).present? ||
+            group.hooks.send(:matching_hooks_for, :after, :context, group).present?
+        end
+      end
+    end
+  end
+end
+
+module ParallelRSpec
+  class Runner < RSpec::Core::Runner
+    # Runs the suite of specs and exits the process with an appropriate exit
+    # code.
+    def self.invoke
+      status = run(ARGV, $stderr, $stdout).to_i
+      exit(status) if status != 0
+    end
+
+    # Run a suite of RSpec examples. Does not exit.
+    #
+    # This is used internally by RSpec to run a suite, but is available
+    # for use by any other automation tool.
+    #
+    # If you want to run this multiple times in the same process, and you
+    # want files like `spec_helper.rb` to be reloaded, be sure to load `load`
+    # instead of `require`.
+    #
+    # @param args [Array] command-line-supported arguments
+    # @param err [IO] error stream
+    # @param out [IO] output stream
+    # @return [Fixnum] exit status code. 0 if all specs passed,
+    #   or the configured failure exit code (1 by default) if specs
+    #   failed.
+    def self.run(args, err=$stderr, out=$stdout)
+      RSpec::Core::Runner.trap_interrupt
+      options = RSpec::Core::ConfigurationOptions.new(args)
+      new(options).run(err, out)
+    end
+
+    # Runs the provided example groups.
+    #
+    # @param example_groups [Array<RSpec::Core::ExampleGroup>] groups to run
+    # @return [Fixnum] exit status code. 0 if all specs passed,
+    #   or the configured failure exit code (1 by default) if specs
+    #   failed.
+    def run_specs(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?)
+          success = run_in_parallel(without_context_hooks, reporter)
+          success &&= with_context_hooks.map { |g| g.run(reporter) }.all?
+          success ? 0 : @configuration.failure_exit_code
+        end
+      end
+    end
+
+    def run_in_parallel(example_groups, reporter)
+      workers = Workers.new
+      workers.run_test_workers do |worker|
+        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
+        end
+        success = example_groups.map { |g| g.run(reporter) }.all?
+        reporter.finish
+        success
+      end
+    end
+  end
+end

data/lib/parallel_rspec/tasks.rake

@@ -0,0 +1,59 @@
+require 'lib/parallel_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|
+        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|
+        ActiveRecord::Tasks::DatabaseTasks.purge ActiveRecord::Base.configurations['test']
+      end
+    end
+
+    # desc "Recreate the test database from an existent schema.rb file"
+    task :load_schema => %w(db:parallel:purge) do
+      should_reconnect = ActiveRecord::Base.connection_pool.active_connection?
+      begin
+        ParallelWorkers.new.run_test_workers do |worker|
+          ActiveRecord::Schema.verbose = false
+          ActiveRecord::Tasks::DatabaseTasks.load_schema_for ActiveRecord::Base.configurations['test'], :ruby, ENV['SCHEMA']
+        end
+      ensure
+        if should_reconnect
+          ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+        end
+      end
+    end
+
+    # 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|
+        ActiveRecord::Tasks::DatabaseTasks.load_schema_for ActiveRecord::Base.configurations['test'], :sql, ENV['SCHEMA']
+      end
+    end
+
+    # desc "Recreate the test database from the current schema"
+    task :load do
+      db_namespace["db:parallel:purge"].invoke
+      case ActiveRecord::Base.schema_format
+        when :ruby
+          db_namespace["parallel:load_schema"].invoke
+        when :sql
+          db_namespace["parallel:load_structure"].invoke
+      end
+    end
+
+    # desc "Check for pending migrations and load the test schema"
+    task :prepare => %w(environment load_config) do
+      unless ActiveRecord::Base.configurations.blank?
+        db_namespace['parallel:load'].invoke
+      end
+    end
+  end
+end

data/lib/parallel_rspec/version.rb

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

data/lib/parallel_rspec/workers.rb

@@ -0,0 +1,41 @@
+module ParallelRSpec
+  class Workers
+    def self.number_of_workers
+      workers = ENV['WORKERS'].to_i
+      workers = 4 if workers.zero?
+      workers
+    end
+
+    attr_reader :number_of_workers
+
+    def initialize(number_of_workers = Workers.number_of_workers)
+      @number_of_workers = number_of_workers
+    end
+
+    def run_test_workers
+      children = (1..number_of_workers).collect do |worker|
+        fork do
+          establish_test_database_connection(worker)
+          yield worker
+        end
+      end
+
+      verify_children(children)
+    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.establish_connection(ActiveRecord::Base.configurations['test'])
+    end
+
+    def verify_children(children)
+      results = children.collect { |pid| Process.wait2(pid).last }.reject(&:success?)
+
+      unless results.empty?
+        STDERR.puts "\n#{results.size} worker#{'s' unless results.size == 1} failed"
+        exit 1
+      end
+    end
+  end
+end

data/parallel_rspec.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parallel_rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "parallel_rspec"
+  spec.version       = ParallelRSpec::VERSION
+  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.homepage      = "https://github.com/willbryant/parallel_rspec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: parallel_rspec
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Will Bryant, Powershop New Zealand Ltd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !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
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- will.bryant@gmail.com
+executables:
+- prspec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/prspec
+- lib/parallel_rspec.rb
+- lib/parallel_rspec/railtie.rb
+- lib/parallel_rspec/runner.rb
+- lib/parallel_rspec/tasks.rake
+- lib/parallel_rspec/version.rb
+- lib/parallel_rspec/workers.rb
+- parallel_rspec.gemspec
+homepage: https://github.com/willbryant/parallel_rspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+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..
+test_files: []