minitest-parallel-db 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af5e71ed5246d3fcbcab66122854e2ded8e86f14
+  data.tar.gz: 267b812995e22c39c77e0a81cb647ab1c329eb0e
+SHA512:
+  metadata.gz: 29b59408553caf12225d3ec6c58b5092d1112a02d113a35ea7853acccb276371636a4ac11bd14ffc7a393d731089f37c3f42091aff84552761b33560a32d0f41
+  data.tar.gz: 61840c54cc06ab3067dbbec7da569b5481d117aa4beb2a92a3c51fc7bd8f87ce8690acbd7e4904582270a8ada6b9cb56f3de0413e9250cc481719771a9a432fb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p353

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+script:
+  - 'ruby spec/active_record/postgres/spec.rb'
+  - 'ruby spec/sequel/postgres/spec.rb'
+before_script:
+  - psql -c 'create database minitest_parallel_db;' -U postgres

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    minitest-parallel-db (0.0.4)
+      minitest (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.4)
+    pg (0.17.0)
+    rake (10.1.0)
+    sequel (3.47.0)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.3)
+  minitest-parallel-db!
+  pg
+  rake
+  sequel

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jared Ning
+
+MIT License
+
+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,91 @@
+# Minitest::Parallel::Db
+
+[![Build Status](https://travis-ci.org/ordinaryzelig/minitest-parallel-db.png?branch=master)](https://travis-ci.org/ordinaryzelig/minitest-parallel-db)
+
+Run Minitest in parallel with a single database.
+
+## Rationale
+
+We should be able to run tests in parallel even if there is a database involved.
+We can leverage database transactions to keep our tests isolated from each other.
+
+There are solutions out there already, but some require creating multiple databases
+or running multiple processes.
+None of that sounds appealing to me.
+
+## The solution
+
+Tests in parallel must be run in isolation.
+If the tests are sharing the same database and table, we have a problem.
+But if we can use a database transaction for each test,
+they will be run in isolation from each other
+(although write locks are still in effect).
+
+## Usage
+
+```ruby
+require 'minitest/parallel/db'
+Minitest::Test.send(:include, Minitest::Parallel::DB::ActiveRecord)
+# Set number of threads you want. Best to match your pool size.
+# Minitest defaults this to 2.
+Minitest::Parallel::Db.concurrency = 10
+
+describe 'your parallel tests' do
+
+  it 'saves a record' do
+    model = Model.create!
+    Model.last.id.must_equal model.id
+  end
+
+  it 'edits a record' do
+    Model.create!
+    Model.last.update_attributes(name: 'changed')
+    Model.last.name.must_equal 'changed'
+  end
+
+end
+```
+
+## Requirements
+
+* Postgres (should work with databases that support transactions, but I haven't tried any)
+* Minitest >= 4.2 (where `parallelize_me!` exists)
+* Supported ORM (ActiveRecord, Sequel)
+* Get rid of DatabaseCleaner if you're using it.
+
+### Minitest versions
+
+At the time this gem was created, Minitest was at v4.7.5.
+Since then, the way to set the number of concurrent tests to be run has changed.
+Please let me know if the version of Minitest you are using doesn't work with this gem so I can try to patch it.
+
+### Rails
+
+If you are using a recent enough version of Rails, you don't need this gem.
+See the Rails section of my [blog post] (http://redningja.com/dev/parallel-tests-with-single-database/) about this.
+
+## Tips
+
+### Use sequences with factories to avoid write blocks on unique fields
+
+If you have a field that is unique (i.e. the database defines it as unique,
+not just unique by a model validation), use sequences in your factories.
+Unique indexes will be enforced by the database (even if the writes are
+in their own transactions), and it will block writes, slowing you down a bit.
+To avoid that, use sequences where you can to easily avoid duplicates.
+
+```
+factory :users do
+  sequence(:username) { |idx| "user #{idx}" }
+end
+```
+
+## Running tests for this gem
+
+The safe way: run each of the scripts listed in `.travis.yml`.
+The quick way: `rake test`.
+
+## Contributing
+
+I have only had the need to implement this with Postgres, ActiveRecord, and Sequel.
+I'm sure there is need for more databases like MySQL, and ORMs like Datamapper.

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  puts '*** You should see groups of tests run very quickly (~1s per group).'
+  puts '*** If you want to be really safe, run each of the suites individually (listed in .travis.yml).'
+  t.pattern = 'spec/**/*spec.rb'
+end
+
+namespace :db do
+
+  task :create do
+    sh 'createdb minitest_parallel_db'
+  end
+
+end

data/lib/minitest/parallel/db.rb

@@ -0,0 +1,44 @@
+require 'minitest'
+require 'minitest/parallel/db/version'
+
+module Minitest
+  module Parallel
+    module Db
+
+      autoload :ActiveRecord, 'minitest/parallel/db/orms/active_record'
+      autoload :Sequel,       'minitest/parallel/db/orms/sequel'
+
+      def self.included(suite)
+        suite.parallelize_me!
+        suite.send :prepend, InstanceMethods
+      end
+
+      class << self
+
+        attr_reader :concurrency
+
+        def concurrency=(num)
+          @concurrency = num
+          if Minitest.const_defined?(:Parallel)
+            Minitest.parallel_executor = Minitest::Parallel::Executor.new(num)
+          else
+            ENV['N'] = num
+          end
+        end
+
+      end
+
+      module InstanceMethods
+
+        def run
+          adapter_run do
+            super
+          end
+          self
+        end
+
+      end
+
+    end
+  end
+end

data/lib/minitest/parallel/db/orms/active_record.rb

@@ -0,0 +1,32 @@
+require 'pg'
+
+module Minitest
+  module Parallel::Db
+    module ActiveRecord
+
+      def self.included(suite)
+        suite.send(:include, Parallel::Db)
+        suite.send(:include, TestInstanceMethods)
+      end
+
+      def adapter_run
+        model.transaction do
+          yield
+          raise ::ActiveRecord::Rollback
+        end
+        model.connection.close
+      end
+
+      module TestInstanceMethods
+
+        # If you want to be specific with a certain model,
+        # define your own `model` method (or `let` statement).
+        def model
+          ::ActiveRecord::Base
+        end
+
+      end
+
+    end
+  end
+end

data/lib/minitest/parallel/db/orms/sequel.rb

@@ -0,0 +1,19 @@
+require 'pg'
+
+module Minitest
+  module Parallel::Db
+    module Sequel
+
+      def self.included(suite)
+        suite.send(:include, Parallel::Db)
+      end
+
+      def adapter_run
+        DB.transaction(rollback: :always) do
+          yield
+        end
+      end
+
+    end
+  end
+end

data/lib/minitest/parallel/db/version.rb

@@ -0,0 +1,7 @@
+module Minitest
+  module Parallel
+    module Db
+      VERSION = '0.0.4'
+    end
+  end
+end

data/minitest-parallel-db.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/parallel/db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-parallel-db"
+  spec.version       = Minitest::Parallel::Db::VERSION
+  spec.authors       = ["Jared Ning"]
+  spec.email         = ["jared@redningja.com"]
+  spec.description   = %q{Run tests in parallel with a single database}
+  spec.summary       = %q{Run tests in parallel with a single database}
+  spec.homepage      = "https://github.com/ordinaryzelig/minitest-parallel-db"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'minitest', '>= 4.2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "sequel"
+  spec.add_development_dependency "activerecord"
+end

data/spec/active_record/postgres/setup.rb

@@ -0,0 +1,39 @@
+require_relative '../../helper'
+
+require 'active_record'
+
+# Model
+class PostgresActiveRecordModel < ActiveRecord::Base
+  validates :name, uniqueness: true
+end
+PARM = PostgresActiveRecordModel
+
+db_config = DB_CONFIG[:postgres].merge(
+  adapter: 'postgresql',
+)
+
+# Create database.
+begin
+  ActiveRecord::Base.establish_connection(db_config)
+  ActiveRecord::Base.connection
+rescue
+  ActiveRecord::Base.establish_connection(
+    adapter:             db_config[:adapter],
+    database:            'postgres',
+    schema_search_path:  'public',
+  )
+  ActiveRecord::Base.connection.create_database(db_config[:database])
+end
+
+ActiveRecord::Base.establish_connection(db_config)
+
+# Migration
+ActiveRecord::Base.connection.tap do |conn|
+  conn.drop_table PARM.table_name if PARM.table_exists?
+  conn.create_table PARM.table_name do |t|
+    t.string :name, null: false
+  end
+end
+
+Minitest::Parallel::Db.concurrency = ActiveRecord::Base.connection_config[:pool]
+ActiveRecord::Base.connection.close

data/spec/active_record/postgres/spec.rb

@@ -0,0 +1,20 @@
+require_relative 'setup'
+
+describe 'ActiveRecord + Postgres' do
+
+  include Minitest::Parallel::Db::ActiveRecord
+
+  ActiveRecord::Base.connection_config[:pool].times do |idx|
+    it "tests in parallel (#{idx + 1})" do
+      PARM.create! name: "name #{idx}"
+
+      # Give time for other parallel tests to catch up.
+      sleep 1
+
+      # If this is run in transaction,
+      # we should only see the model we just created.
+      PARM.count.must_equal 1
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.require
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'minitest/parallel/db'
+
+require_relative 'support/db_config'
+require_relative 'support/timer_plugin'

data/spec/sequel/postgres/setup.rb

@@ -0,0 +1,31 @@
+require_relative '../../helper'
+
+require 'sequel'
+
+db_config = {
+  adapter:          'postgres',
+  host:             'localhost',
+  database:         DB_CONFIG[:postgres][:database],
+  max_connections:  DB_CONFIG[:postgres][:pool],
+}
+
+DB = Sequel.postgres(db_config)
+
+# Migration
+DB.create_table! :postgres_sequel_models do
+  primary_key :id
+  String :name, null: false
+end
+
+# Model
+Sequel::Model.plugin :validation_helpers
+class PostgresSequelModel < Sequel::Model
+  def validate
+    super
+    validates_presence [:name]
+    validates_unique :name
+  end
+end
+PSM = PostgresSequelModel
+
+Minitest::Parallel::Db.concurrency = DB.pool.max_size

data/spec/sequel/postgres/spec.rb

@@ -0,0 +1,20 @@
+require_relative 'setup'
+
+describe 'Sequel + Postgres' do
+
+  include Minitest::Parallel::Db::Sequel
+
+  DB.pool.max_size.times do |idx|
+    it "tests in parallel (#{idx + 1})" do
+      PSM.new(name: 'name').save
+
+      # Give time for other parallel tests to catch up.
+      sleep 1
+
+      # If this is run in transaction,
+      # we should only see the model we just created.
+      PSM.count.must_equal 1
+    end
+  end
+
+end

data/spec/support/db_config.rb

@@ -0,0 +1,7 @@
+DB_CONFIG = {
+  postgres: {
+    database: 'minitest_parallel_db',
+    pool:     10,
+    host:     'localhost',
+  },
+}

data/spec/support/timer_plugin.rb

@@ -0,0 +1,39 @@
+module Minitest
+
+  def self.plugin_timer_init(options)
+    self.reporter << TimerReporter.new(options)
+  end
+
+  class TimerReporter < AbstractReporter
+
+    # Only top-level describes
+    def self.top_level_test_suites
+      @top_level_test_suites ||=
+        Minitest::Runnable.runnables.select do |runnable|
+          [Minitest::Spec, Minitest::Unit::TestCase].include? runnable.superclass
+        end
+    end
+
+    def initialize(options)
+      options.fetch(:io).puts "Num test suites to time at 2s each: #{self.class.top_level_test_suites.size}."
+      @max_time_allowed = 2 * self.class.top_level_test_suites.size
+    end
+
+    def start
+      @start_time = Time.now
+    end
+
+    def report
+      @total_time = Time.now - @start_time
+      raise "Tests took too long (#{@total_time}s)" unless passed?
+    end
+
+    def passed?
+      @total_time <= @max_time_allowed
+    end
+
+  end
+
+end
+
+Minitest.extensions << :timer

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: minitest-parallel-db
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Jared Ning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run tests in parallel with a single database
+email:
+- jared@redningja.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest/parallel/db.rb
+- lib/minitest/parallel/db/orms/active_record.rb
+- lib/minitest/parallel/db/orms/sequel.rb
+- lib/minitest/parallel/db/version.rb
+- minitest-parallel-db.gemspec
+- spec/active_record/postgres/setup.rb
+- spec/active_record/postgres/spec.rb
+- spec/helper.rb
+- spec/sequel/postgres/setup.rb
+- spec/sequel/postgres/spec.rb
+- spec/support/db_config.rb
+- spec/support/timer_plugin.rb
+homepage: https://github.com/ordinaryzelig/minitest-parallel-db
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Run tests in parallel with a single database
+test_files:
+- spec/active_record/postgres/setup.rb
+- spec/active_record/postgres/spec.rb
+- spec/helper.rb
+- spec/sequel/postgres/setup.rb
+- spec/sequel/postgres/spec.rb
+- spec/support/db_config.rb
+- spec/support/timer_plugin.rb