parallel_tests 0.4.20 → 0.4.21

data/Readme.md

@@ -1,4 +1,4 @@
-Speedup Test::Unit + RSpec + Cucumber by running parallel on multiple CPUs(or cores).
+Speedup Test::Unit + RSpec + Cucumber by running parallel on multiple CPUs (or cores).
 
 Setup for Rails
 ===============
@@ -59,6 +59,7 @@ OR as plugin
     ...
 
 Test just a subfolder (e.g. use one integration server per subfolder)
+
     rake parallel:test[models]
     rake parallel:test[something/else]
 
@@ -76,10 +77,14 @@ Example output
 
     Took 29.925333 seconds
 
-Even process runtimes (for specs only)
+Spec Loggers
+===================
+
+Even process runtimes
 -----------------
 
-Log test runtime to give each process the same test runtime.<br/>
+Log test runtime to give each process the same test runtime.
+
 Add to your `spec/parallel_spec.opts` (or `spec/spec.opts`) :
 
     RSpec 1.x:
@@ -90,6 +95,36 @@ Add to your `spec/parallel_spec.opts` (or `spec/spec.opts`) :
       --format progress
       --format ParallelSpecs::SpecRuntimeLogger --out tmp/parallel_profile.log
 
+SpecSummaryLogger
+--------------------
+
+This logger stops the different processes overwriting each other's output.
+
+Add the following to your `spec/parallel_spec.opts` (or `spec/spec.opts`) :
+
+    RSpec 1.x:
+      --format progress
+      --format ParallelSpecs::SpecSummaryLogger:tmp/spec_summary.log
+    RSpec >= 2.2:
+      --format progress
+      --format ParallelSpecs::SpecSummaryLogger --out tmp/spec_summary.log
+
+SpecFailuresLogger
+-----------------------
+
+This logger produces command lines for running any failing examples.
+
+E.g.
+
+    spec /path/to/my_spec.rb -e "should do something"
+
+Add the following to your `spec/parallel_spec.opts` (or `spec/spec.opts`) :
+
+    RSpec 1.x:
+      --format ParallelSpecs::SpecFailuresLogger:tmp/failing_specs.log
+    RSpec >= 2.2:
+      --format ParallelSpecs::SpecFailuresLogger --out tmp/failing_specs.log
+
 Setup for non-rails
 ===================
     sudo gem install parallel_tests
@@ -98,9 +133,11 @@ Setup for non-rails
     # [Optional] use ENV['TEST_ENV_NUMBER'] inside your tests to select separate db/memcache/etc.
 
 [optional] Only run selected files & folders:
+
     parallel_test test/bar test/baz/xxx_text.rb
 
 Options are:
+
     -n [PROCESSES]                   How many processes to use, default: available CPUs
     -p, --path [PATH]                run tests inside this path only
         --no-sort                    do not sort files before running them
@@ -114,6 +151,7 @@ Options are:
     -h, --help                       Show this.
 
 You can run any kind of code with -e / --execute
+
     parallel_test -n 5 -e 'ruby -e "puts %[hello from process #{ENV[:TEST_ENV_NUMBER.to_s].inspect}]"'
     hello from process "2"
     hello from process ""
@@ -169,6 +207,7 @@ inspired by [pivotal labs](http://pivotallabs.com/users/miked/blog/articles/849-
  - [Levent Ali](http://purebreeze.com/)
  - [Michael Kintzer](https://github.com/rockrep)
  - [nathansobo](https://github.com/nathansobo)
+ - [Joe Yates](http://titusd.co.uk)
 
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>

data/VERSION

@@ -1 +1 @@
-0.4.20
+0.4.21

data/lib/parallel_specs/spec_failures_logger.rb

@@ -0,0 +1,25 @@
+require 'parallel_specs'
+require File.join(File.dirname(__FILE__), 'spec_logger_base')
+
+class ParallelSpecs::SpecFailuresLogger < ParallelSpecs::SpecLoggerBase
+  def initialize(options, output=nil)
+    super
+    @failed_examples = []
+  end
+
+  def example_failed(example, count, failure)
+    @failed_examples << example
+  end
+
+  def dump_failure(*args)
+    lock_output do
+      @failed_examples.each.with_index do | example, i |
+        spec_file = example.location.scan(/^[^:]+/)[0]
+        spec_file.gsub!(%r(^.*?/spec/), './spec/')
+        @output.puts "#{ParallelSpecs.executable} #{spec_file} -e \"#{example.description}\""
+      end
+    end
+    @output.flush
+  end
+
+end

data/lib/parallel_specs/spec_logger_base.rb

@@ -0,0 +1,72 @@
+require 'parallel_specs'
+
+begin
+  require 'rspec/core/formatters/progress_formatter'
+  base = RSpec::Core::Formatters::ProgressFormatter
+rescue LoadError
+  require 'spec/runner/formatter/progress_bar_formatter'
+  base = Spec::Runner::Formatter::BaseTextFormatter
+end
+ParallelSpecs::SpecLoggerBaseBase = base
+
+class ParallelSpecs::SpecLoggerBase < ParallelSpecs::SpecLoggerBaseBase
+  def initialize(options, output=nil)
+    output ||= options # rspec 2 has output as first argument
+
+    if String === output
+      FileUtils.mkdir_p(File.dirname(output))
+      File.open(output, 'w'){} # overwrite previous results
+      @output = File.open(output, 'a')
+    elsif File === output
+      output.close # close file opened with 'w'
+      @output = File.open(output.path, 'a')
+    else
+      @output = output
+    end
+
+    @failed_examples = [] # only needed for rspec 2
+  end
+
+  def example_started(*args)
+  end
+
+  def example_passed(example)
+  end
+
+  def example_pending(*args)
+  end
+
+  def example_failed(*args)
+  end
+
+  def start_dump(*args)
+  end
+
+  def dump_summary(*args)
+  end
+
+  def dump_pending(*args)
+  end
+
+  def dump_failure(*args)
+  end
+
+  #stolen from Rspec
+  def close
+    @output.close  if (IO === @output) & (@output != $stdout)
+  end
+
+  # do not let multiple processes get in each others way
+  def lock_output
+    if File === @output
+      begin
+        @output.flock File::LOCK_EX
+        yield
+      ensure
+        @output.flock File::LOCK_UN
+      end
+    else
+      yield
+    end
+  end
+end

data/lib/parallel_specs/spec_runtime_logger.rb

@@ -1,31 +1,10 @@
 require 'parallel_specs'
+require File.join(File.dirname(__FILE__), 'spec_logger_base')
 
-begin
-  require 'rspec/core/formatters/progress_formatter'
-  base = RSpec::Core::Formatters::ProgressFormatter
-rescue LoadError
-  require 'spec/runner/formatter/progress_bar_formatter'
-  base = Spec::Runner::Formatter::BaseTextFormatter
-end
-ParallelSpecs::SpecRuntimeLoggerBase = base
-
-class ParallelSpecs::SpecRuntimeLogger < ParallelSpecs::SpecRuntimeLoggerBase
+class ParallelSpecs::SpecRuntimeLogger < ParallelSpecs::SpecLoggerBase
   def initialize(options, output=nil)
-    output ||= options # rspec 2 has output as first argument
-
-    if String === output
-      FileUtils.mkdir_p(File.dirname(output))
-      File.open(output, 'w'){} # overwrite previous results
-      @output = File.open(output, 'a')
-    elsif File === output
-      output.close # close file opened with 'w'
-      @output = File.open(output.path, 'a')
-    else
-      @output = output
-    end
-
+    super
     @example_times = Hash.new(0)
-    @failed_examples = [] # only needed for rspec 2
   end
 
   def example_started(*args)
@@ -46,39 +25,4 @@ class ParallelSpecs::SpecRuntimeLogger < ParallelSpecs::SpecRuntimeLoggerBase
     @output.flush
   end
 
-  # stubs so that rspec doe not crash
-
-  def example_pending(*args)
-  end
-
-  def example_failed(*args)
-  end
-
-  def dump_summary(*args)
-  end
-
-  def dump_pending(*args)
-  end
-
-  def dump_failure(*args)
-  end
-
-  #stolen from Rspec
-  def close
-    @output.close  if (IO === @output) & (@output != $stdout)
-  end
-
-  # do not let multiple processes get in each others way
-  def lock_output
-    if File === @output
-      begin
-        @output.flock File::LOCK_EX
-        yield
-      ensure
-        @output.flock File::LOCK_UN
-      end
-    else
-      yield
-    end
-  end
 end

data/lib/parallel_specs/spec_summary_logger.rb

@@ -0,0 +1,47 @@
+require 'parallel_specs'
+require File.join(File.dirname(__FILE__), 'spec_logger_base')
+
+class ParallelSpecs::SpecSummaryLogger < ParallelSpecs::SpecLoggerBase
+  def initialize(options, output=nil)
+    super
+    @passed_examples = []
+    @pending_examples = []
+    @failed_examples = []
+  end
+
+  def example_passed(example)
+    @passed_examples << example
+  end
+
+  def example_pending(*args)
+    @pending_examples << args
+  end
+
+  def example_failed(example, count, failure)
+    @failed_examples << failure
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    lock_output do
+      @output.puts "#{ @passed_examples.size } examples passed"
+    end
+    @output.flush
+  end
+
+  def dump_failure(*args)
+    lock_output do
+      @output.puts "#{ @failed_examples.size } examples failed:"
+      @failed_examples.each.with_index do | failure, i |
+        @output.puts "#{ i + 1 })"
+        @output.puts failure.header
+        @output.puts failure.exception.to_s
+        failure.exception.backtrace.each do | caller |
+          @output.puts caller
+        end
+        @output.puts ''
+      end
+    end
+    @output.flush
+  end
+
+end

data/parallel_tests.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{parallel_tests}
-  s.version = "0.4.20"
+  s.version = "0.4.21"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2011-06-04}
+  s.date = %q{2011-06-12}
   s.email = %q{grosser.michael@gmail.com}
   s.executables = ["parallel_cucumber", "parallel_spec", "parallel_test"]
   s.files = [
@@ -25,7 +25,10 @@ Gem::Specification.new do |s|
      "lib/parallel_cucumber.rb",
      "lib/parallel_cucumber/runtime_logger.rb",
      "lib/parallel_specs.rb",
+     "lib/parallel_specs/spec_failures_logger.rb",
+     "lib/parallel_specs/spec_logger_base.rb",
      "lib/parallel_specs/spec_runtime_logger.rb",
+     "lib/parallel_specs/spec_summary_logger.rb",
      "lib/parallel_tests.rb",
      "lib/parallel_tests/grouper.rb",
      "lib/parallel_tests/railtie.rb",

data/spec/parallel_specs_spec.rb

@@ -1,4 +1,7 @@
 require 'spec/spec_helper'
+require 'parallel_specs/spec_runtime_logger'
+require 'parallel_specs/spec_summary_logger'
+require 'parallel_specs/spec_failures_logger'
 
 describe ParallelSpecs do
   test_tests_in_groups(ParallelSpecs, 'spec', '_spec.rb')
@@ -160,4 +163,103 @@ EOF
       ParallelSpecs.find_results(output).should == ['0 examples, 0 failures, 0 pending','1 examples, 1 failures, 1 pending']
     end
   end
+
+  context "logging" do
+
+    OutputLogger = Struct.new(:output) do
+      attr_reader :flock, :flush
+      def puts(s)
+        self.output << s
+      end
+    end
+
+    before :each do
+      @output     = OutputLogger.new([])
+      @example1   = mock( 'example', :location => '/my/spec/path/to/example:123', :description => 'should do stuff' )
+      @example2   = mock( 'example', :location => '/my/spec/path/to/example2:456', :description => 'should do other stuff' )
+      @exception1 = mock( :to_s => 'exception', :backtrace => [ '/path/to/error/line:33' ] )
+      @failure1   = mock( 'example', :location => '/path/to/example:123', :header => 'header', :exception => @exception1 )
+    end
+
+    describe ParallelSpecs::SpecRuntimeLogger do
+      before :each do
+        ENV['TEST_ENV_NUMBER'] = '1'
+        @logger                = ParallelSpecs::SpecRuntimeLogger.new( @output )
+      end
+
+      it "collects runtime information" do
+        @logger.example_started
+        @logger.example_passed( @example1 )
+
+        @logger.start_dump
+
+        @output.output.size.should == 1
+        @output.output[0].size.should == 1
+        @output.output[0][0].should =~ %r(/path/to/example:([\d\.e\-]+))
+      end
+    end
+
+    describe ParallelSpecs::SpecSummaryLogger do
+      before :each do
+        @logger = ParallelSpecs::SpecSummaryLogger.new( @output )
+      end
+
+      it "should print a summary of failing examples" do
+        @logger.example_failed( nil, nil, @failure1 )
+
+        @logger.dump_failure
+
+        @output.output.should == ["1 examples failed:", "1)", "header", "exception", "/path/to/error/line:33", ""]
+      end
+    end
+
+    describe ParallelSpecs::SpecFailuresLogger do
+      before :each do
+        @logger = ParallelSpecs::SpecFailuresLogger.new( @output )
+      end
+
+      it "should produce a list of command lines for failing examples" do
+        @logger.example_failed( @example1, nil, nil )
+        @logger.example_failed( @example2, nil, nil )
+
+        @logger.dump_failure
+
+        @output.output.size.should == 2
+        @output.output[0].should =~ /r?spec .*? -e "should do stuff"/
+        @output.output[1].should =~ /r?spec .*? -e "should do other stuff"/
+      end
+
+      it "should invoke spec for rspec 1" do
+        ParallelSpecs.stub!(:bundler_enabled?).and_return true
+        ParallelSpecs.stub!(:run).with("bundle show rspec").and_return "/foo/bar/rspec-1.0.2"
+        @logger.example_failed( @example1, nil, nil )
+
+        @logger.dump_failure
+
+        @output.output[0].should =~ /^bundle exec spec/
+      end
+
+      it "should invoke rspec for rspec 2" do
+        ParallelSpecs.stub!(:bundler_enabled?).and_return true
+        ParallelSpecs.stub!(:run).with("bundle show rspec").and_return "/foo/bar/rspec-2.0.2"
+        @logger.example_failed( @example1, nil, nil )
+
+        @logger.dump_failure
+
+        @output.output[0].should =~ /^bundle exec rspec/
+      end
+
+      it "should return relative paths" do
+        @logger.example_failed( @example1, nil, nil )
+        @logger.example_failed( @example2, nil, nil )
+
+        @logger.dump_failure
+
+        @output.output[0].should =~ %r(\./spec/path/to/example)
+        @output.output[1].should =~ %r(\./spec/path/to/example2)
+      end
+
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -54,10 +54,14 @@ def test_tests_in_groups(klass, folder, suffix)
       end
 
       @log = klass.runtime_log
-      `mkdir #{File.dirname(@log)}`
+      `mkdir -p #{File.dirname(@log)}`
       `rm -f #{@log}`
     end
 
+    after :all do
+      `rm -f #{klass.runtime_log}`
+    end
+
     it "groups when given an array of files" do
       list_of_files = Dir["#{test_root}/**/*#{suffix}"]
       found = klass.tests_with_runtime(list_of_files)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: parallel_tests
 version: !ruby/object:Gem::Version 
-  hash: 39
+  hash: 37
   prerelease: 
   segments: 
   - 0
   - 4
-  - 20
-  version: 0.4.20
+  - 21
+  version: 0.4.21
 platform: ruby
 authors: 
 - Michael Grosser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-04 00:00:00 +02:00
+date: 2011-06-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,10 @@ files:
 - lib/parallel_cucumber.rb
 - lib/parallel_cucumber/runtime_logger.rb
 - lib/parallel_specs.rb
+- lib/parallel_specs/spec_failures_logger.rb
+- lib/parallel_specs/spec_logger_base.rb
 - lib/parallel_specs/spec_runtime_logger.rb
+- lib/parallel_specs/spec_summary_logger.rb
 - lib/parallel_tests.rb
 - lib/parallel_tests/grouper.rb
 - lib/parallel_tests/railtie.rb