multitest 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+tmp

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nick Gauthier
+
+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.rdoc

@@ -0,0 +1,89 @@
+= multitest
+
+== Caveats
+
+Multitest is still very young, it is in active development and is no where near complete or robust.
+
+Multitest currently only works in a rails environment. It's only because I use "constantize".
+
+If you depend on fixture data in your database, you may have data inconsistency errors. I like to use an empty DB and then use factories with transactional tests, and this runs great.
+
+== Installation
+
+  gem install ngauthier-multitest
+
+== Usage
+
+in your Rakefile:
+
+  require 'multitest'
+  require 'multitest/tasks'
+
+on the commandline:
+
+  rake multitest
+  rake multitest:units multitest:functionals multitest:integration
+
+== Configuration
+
+in your Rakefile:
+
+  Multitest.cores = 8
+
+== Benchmarks
+
+This is one of our largest apps.
+
+=== Normal suite
+
+  time rake test
+  259.03user 27.50system 5:14.76elapsed 91%CPU
+
+=== 2 Cores
+
+  time rake multitest
+  213.86user 23.38system 2:41.24elapsed 147%CPU
+
+=== 4 Cores
+
+  time rake multitest
+  223.18user 24.53system 2:08.96elapsed 192%CPU
+
+Note the wall-time differences of 5:14 vs 2:41. 195% speedup on two cores. On 4 cores there is only a speedup of 243%, but that's still quicker. If you send me impressive benchmarks, I'll be happy to put them up here (8 cores anyone?).
+
+== Require Errors
+
+If you get require errors like:
+
+  Running multitest:units
+  rake aborted!
+  no such file to load -- test_helper
+
+Then you may want to use more absolute paths in your tests. For example, if you had:
+
+  # test/unit/my_class.rb
+  require 'test_helper'
+  class MyClass < ActiveSupport::TestCase
+  end
+
+You should change it to:
+
+  # test/unit/my_class.rb
+  require File.join(File.dirname(__FILE__), '..', 'test_helper')
+  class MyClass < ActiveSupport::TestCase
+  end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Nick Gauthier. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "multitest"
+    gem.summary = "Run your tests in parallel"
+    gem.description = "Run your tests across multiple cores automatically."
+    gem.email = "nick@smartlogicsolutions.com"
+    gem.homepage = "http://github.com/ngauthier/multitest"
+    gem.authors = ["Nick Gauthier"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.files.include(['lib/**/*.rb'])
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/multitest_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "multitest #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/multitest.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'multitest', 'multitest.rb')
+#require File.join(File.dirname(__FILE__), 'multitest', 'tasks.rb')

data/lib/multitest/multitest.rb

@@ -0,0 +1,130 @@
+require File.join(File.dirname(__FILE__), 'pipe_dream')
+require File.join(File.dirname(__FILE__), 'safe_fork')
+require 'test/unit/testresult'
+require 'test/unit'
+
+# The ability to test multiple files across multiple cores
+# simultaneously
+class Multitest
+  @@cores = 2
+  def self.cores
+    @@cores
+  end
+  def self.cores=(c)
+    @@cores = c
+  end
+  # Takes an options hash.
+  #   :files => files to test
+  #   :cores => number of cores to use
+  def initialize(files, cores = Multitest.cores)
+    @files = files
+    @cores = cores
+    @children = []
+    @threads = []
+    @pipes = []
+    
+    Test::Unit.run = true
+    @files.each{|f| load f}
+  end
+
+  # Run the tests that have been setup
+  def run
+    return if @files.empty?
+    $stderr.write @files.inspect+"\n"; $stderr.flush
+    @cores.times do |c|
+      @pipes << PipeDream.new
+      @children << SafeFork.fork do
+        Signal.trap("TERM") { exit }
+        Signal.trap("HUP") { exit }
+        pipe = @pipes.last
+        pipe.identify_as_child
+        pipe.write("[Worker #{c}] Booted\n")
+        @result = Test::Unit::TestResult.new
+        @result.add_listener(Test::Unit::TestResult::FAULT) do |value|
+          $stderr.write value
+          $stderr.write "\n\n"
+          $stderr.flush
+        end
+        while !pipe.eof?
+          file = pipe.gets.chomp
+          begin
+            pipe.write "[Worker #{c} Starting: #{file}\n"
+            start = Time.now
+
+            klasses = Multitest.find_classes_in_file(file)
+            klasses.each{|k| k.suite.run(@result){|status, name| ;}}
+            
+            finish = Time.now
+            pipe.write "[Worker #{c}] Completed: #{file} (#{finish-start})\n"
+          rescue => ex
+            pipe.write "[Worker #{c}] Failed: #{file} - #{ex.to_s}\n"
+          end
+        end
+        $stderr.write @result.to_s
+        $stderr.write "\n"
+        $stderr.flush
+        pipe.close
+      end
+    end
+
+    total_files = @files.size
+    @threads = []
+    @pipes.each do |_p|
+      @threads << Thread.new(_p) do |p|
+        Signal.trap("TERM") { exit }
+        p.identify_as_parent
+        # boot message
+        p.gets
+        while !@files.empty? 
+          # puts "#{total_files - @files.size}/#{total_files}"
+          # send a file
+          p.write("#{@files.pop}\n")
+          # print the start message
+          msg = p.gets
+          # $stdout.write msg; $stdout.flush
+          # wait for the complete message
+          msg = p.gets
+          # print complete message
+          if msg =~ /Completed/
+            # $stdout.write msg; $stdout.flush
+          else
+            $stderr.write msg; $stderr.flush
+          end
+        end
+        p.close
+      end
+    end
+
+    Signal.trap("TERM") do
+      puts "Exiting"
+      @children.each{|c| Process.kill("TERM",c)}
+      @threads.each{|t| Thread.kill(t)}
+    end
+
+    @threads.each{|t| t.join}
+    @children.each{|c| Process.wait(c)}
+  end
+
+  def self.find_classes_in_file(f)
+    code = ""
+    File.open(f) {|buffer| code = buffer.read}
+    matches = code.scan(/class\s+([\S]+)/)
+    klasses = matches.collect do |c|
+      begin
+        if c.first.respond_to? :constantize
+          c.first.constantize
+        else
+          eval(c.first)
+        end
+      rescue NameError
+        # $stderr.write "Could not load [#{c.first}] from [#{f}]\n"
+        nil
+      rescue SyntaxError
+        # $stderr.write "Could not load [#{c.first}] from [#{f}]\n"
+        nil
+      end
+    end
+    return klasses.select{|k| k.respond_to? 'suite'}
+  end
+
+end

data/lib/multitest/pipe_dream.rb

@@ -0,0 +1,52 @@
+class PipeDream
+  def initialize
+    @child_read, @parent_write = IO.pipe
+    @parent_read, @child_write = IO.pipe
+  end
+
+  def gets
+    @reader.gets
+  end
+
+  def write(str)
+    @writer.write(str)
+    @writer.flush
+    str
+  end
+
+  def eof?
+    @reader.eof?
+  end
+
+  def identify_as_child
+    @parent_write.close
+    @parent_read.close
+    @reader = @child_read
+    @writer = @child_write
+  end
+
+  def identify_as_parent
+    @child_write.close
+    @child_read.close
+    @reader = @parent_read
+    @writer = @parent_write
+  end
+
+  def close
+    done_reading
+    done_writing
+  end
+
+  def done_writing
+    @writer.close unless @writer.closed?
+  end
+
+  def done_reading
+    @reader.close unless @reader.closed?
+  end
+
+  private
+  def force_identification
+    return "Must identify as child or parent" if @reader.nil? or @writer.nil?
+  end
+end

data/lib/multitest/safe_fork.rb

@@ -0,0 +1,24 @@
+class SafeFork
+  def self.fork
+    begin
+      # remove our connection so it doesn't get cloned
+      ActiveRecord::Base.remove_connection if defined?(ActiveRecord)
+      # fork a process
+      child = Process.fork do
+        begin
+          # create a new connection and perform the action
+          ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+          yield
+        ensure
+          # make sure we remove the connection before we're done
+          ActiveRecord::Base.remove_connection if defined?(ActiveRecord)
+        end      
+      end
+    ensure
+      # make sure we re-establish the connection before returning to the main instance
+      ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+    end
+    return child
+  end
+end
+

data/lib/multitest/tasks.rb

@@ -0,0 +1,31 @@
+module Multitest::Tasks
+  desc "Test all your code in parallel"
+  task :multitest => ['multitest:units', 'multitest:functionals', 'multitest:integration']
+  
+  namespace :multitest do
+    desc "Multi-core test:units"
+    task :units => [:environment] do
+      pattern = 'test/unit/**/*_test.rb'
+      files = Dir.glob(pattern)
+      $stderr.write "Running multitest:units\n"
+      Multitest.new(files).run
+      $stderr.write "Completed multitest:units\n\n"
+    end
+    desc "Multi-core test:functionals"
+    task :functionals => [:environment] do
+      pattern = 'test/functional/**/*_test.rb'
+      files = Dir.glob(pattern)
+      $stderr.write "Running multitest:functionals\n"
+      Multitest.new(files).run
+      $stderr.write "Completed multitest:functionals\n\n"
+    end
+    desc "Multi-core test:integration"
+    task :integration => [:environment] do
+      pattern = 'test/integration/**/*_test.rb'
+      files = Dir.glob(pattern)
+      $stderr.write "Running multitest:integration\n"
+      Multitest.new(files).run
+      $stderr.write "Completed multitest:integration\n\n"
+    end
+  end
+end

data/multitest.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{multitest}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Gauthier"]
+  s.date = %q{2009-09-25}
+  s.description = %q{Run your tests across multiple cores automatically.}
+  s.email = %q{nick@smartlogicsolutions.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/multitest.rb",
+     "lib/multitest.rb",
+     "lib/multitest/multitest.rb",
+     "lib/multitest/multitest.rb",
+     "lib/multitest/pipe_dream.rb",
+     "lib/multitest/pipe_dream.rb",
+     "lib/multitest/safe_fork.rb",
+     "lib/multitest/safe_fork.rb",
+     "lib/multitest/tasks.rb",
+     "lib/multitest/tasks.rb",
+     "multitest.gemspec",
+     "test/multitest_test.rb",
+     "test/test_helper.rb",
+     "test/tests/another_test.rb",
+     "test/tests/sample_test.rb"
+  ]
+  s.homepage = %q{http://github.com/ngauthier/multitest}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Run your tests in parallel}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/multitest_test.rb",
+     "test/tests/another_test.rb",
+     "test/tests/sample_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/multitest_test.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'multitest'
+
+class MultitestTest < Test::Unit::TestCase
+  context "a Multitest" do
+    setup do
+      FileUtils.mkdir_p(File.join(File.dirname(__FILE__), '..', 'tmp'))
+      FileUtils.rm_rf(File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'test.log')))
+      @mt = Multitest.new([
+        File.expand_path(File.join(File.dirname(__FILE__), 'tests', 'sample_test.rb')),
+        File.expand_path(File.join(File.dirname(__FILE__), 'tests', 'another_test.rb'))
+      ])
+    end
+    
+    should "run three instances" do
+      @mt.run
+      assert File.exists?(File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'test.log')))
+      File.open(File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'test.log'))) do |f|
+        assert_equal %w(1 1 3).sort, f.read.split("\n").sort
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+class Test::Unit::TestCase
+end

data/test/tests/another_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class AnotherTest < Test::Unit::TestCase
+  should "output some text to a file" do
+    File.open(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'tmp', 'test.log')), 'a') do |f|
+      f.write "3\n"
+    end
+  end
+end

data/test/tests/sample_test.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class SampleTest < Test::Unit::TestCase
+  should "output some text to a file" do
+    File.open(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'tmp', 'test.log')), 'a') do |f|
+      f.write "1\n"
+    end
+  end
+end
+
+class SampleTestEnhanced < SampleTest
+  # will inherite the test above
+end
+
+class SampleTestHelper
+  def help
+    # do something
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: multitest
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nick Gauthier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Run your tests across multiple cores automatically.
+email: nick@smartlogicsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/multitest.rb
+- lib/multitest/multitest.rb
+- lib/multitest/pipe_dream.rb
+- lib/multitest/safe_fork.rb
+- lib/multitest/tasks.rb
+- multitest.gemspec
+- test/multitest_test.rb
+- test/test_helper.rb
+- test/tests/another_test.rb
+- test/tests/sample_test.rb
+has_rdoc: true
+homepage: http://github.com/ngauthier/multitest
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Run your tests in parallel
+test_files: 
+- test/test_helper.rb
+- test/multitest_test.rb
+- test/tests/another_test.rb
+- test/tests/sample_test.rb