pork 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3309a4342d94a048959287afbbc330bfbcffdd6
-  data.tar.gz: 90549fc74cc0d7ed04c47d09b7c011001acc5b01
+  metadata.gz: 3ba32fd4203213a40ab4cc87ef23db9d05e7baa0
+  data.tar.gz: 6079324cc97d94683eda43e837cadabd2141ab40
 SHA512:
-  metadata.gz: 7c2c045065fec739b79b34e07f47eb0826123226d08e5b7b5845f9a490be0dfdeaa450468a0c268ed6bce38353e288d30993efcfba58f94b13a98d4d338e325d
-  data.tar.gz: 5c9d5b7aaa8125292a92183cf524d44dc6328f3f44c23f9991273163fdf178fadf62a626d213c587f0bb30b38977814fa9beb711f83d88f62247e98353b863dc
+  metadata.gz: a4cc31b8cfd35a2ed5f66d1f4fa64680a8b32836c605857aa68831300e39b10058494db1c7a0a769e9a293a95c6bc8755282deb09996679325b31dd080753cb7
+  data.tar.gz: 9fe4c8dd306bd73715253f464de164f748e5a2c1596faea8762dd6598c592e0c40d95335de6fe698431688d67487e23e2e5213473dce3501ea964586a45e6282

data/CHANGES.md

@@ -1,5 +1,27 @@
 # CHANGES
 
+## Pork 1.1.0 -- 2015-01-28
+
+### Bugs fixed
+
+* Now we can interrupt the tests and still see current report.
+* Use `exit!` in `at_exit` to avoid issues.
+* Fixed the description order for nested test cases.
+
+### Incompatible changes
+
+* Pork::Parallel.parallel API slightly changed.
+* Pork::Isolate.isolate API slightly changed.
+* Pork::Isolate.all_tests format changed.
+* Mutant::Integration::Pork could be broken now... but it never really works.
+
+### Enhancement
+
+* Accept `ENV['PORK_MODE']` for `Pork.execute_mode`
+* Accept `ENV['PORK_SEED']` for setting up srand.
+* Accept `ENV['PORK_TEST']` for running a particular test case.
+* For failure tests, it would now print the replicating command.
+
 ## Pork 1.0.4 -- 2014-12-29
 
 * Make backtrace easier to read by using `.` and `~`.

data/README.md

@@ -796,6 +796,20 @@ Pass the symbol to it to use the mode:
 Pork.execute_mode :shuffle
 ```
 
+On the other hand, you could also set `ENV['PORK_MODE']` for picking an
+execution mode. This would be convenient if you just want to switch to a
+particular mode temporary via command line. For example:
+
+``` shell
+env PORK_MODE=shuffle rake test
+```
+
+Or:
+
+``` shell
+env PORK_MODE=shuffle ruby -Ilib test/test_pork.rb
+```
+
 ### Pork.inspect_failure_mode
 
 By default, `Pork.inspect_failure_mode` is set to `:auto`, which would
@@ -856,7 +870,7 @@ Then it would always use the mode we specified.
 
 Apache License 2.0
 
-Copyright (c) 2014, Lin Jen-Shin (godfat)
+Copyright (c) 2014-2015, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/pork.rb

@@ -17,14 +17,57 @@ module Pork
     @execute = execute || @execute ||= :execute
   end
 
+  def self.stat
+    @stat ||= Pork::Stat.new
+  end
+
+  def self.seed
+    @seed ||= if Random.const_defined?(:DEFAULT)
+                Random::DEFAULT.seed
+              else
+                Thread.current.randomizer.seed # Rubinius (rbx)
+              end
+  end
+
+  def self.trap sig='SIGINT'
+    Signal.trap(sig) do
+      stat.report
+      puts "\nterminated by signal SIGINT"
+      exit! 255
+    end
+  end
+
+  def self.run
+    if ENV['PORK_TEST']
+      require 'pork/isolate'
+      if paths = Executor.all_tests[ENV['PORK_TEST']]
+        case execute_mode
+        when :execute
+          paths.each{ |p| Executor.isolate(p, stat) }
+        else
+          @stat = Executor.public_send(execute_mode, stat, paths)
+        end
+      else
+        puts "Cannot find test: #{ENV['PORK_TEST']}"
+        exit! 254
+      end
+    else
+      @stat = Executor.public_send(execute_mode, stat)
+    end
+  end
+
   def self.autorun auto=true
     @auto = auto
     @autorun ||= at_exit do
       next unless @auto
+      Random.srand(ENV['PORK_SEED'].to_i) if ENV['PORK_SEED']
+      execute_mode(ENV['PORK_MODE'])      if ENV['PORK_MODE']
       require "pork/mode/#{execute_mode}" unless execute_mode == :execute
-      stat = Executor.public_send(execute_mode)
+      seed
+      trap
+      run
       stat.report
-      exit stat.failures.size + stat.errors.size + ($! && 1).to_i
+      exit! stat.failures.size + stat.errors.size + ($! && 1).to_i
     end
   end
 end

data/lib/pork/imp.rb

@@ -30,7 +30,7 @@ module Pork
 
     def execute stat=Stat.new
       if block_given?
-        yield(stat)
+        yield(stat) # XXX: see Isolate#isolate
       else
         execute_with_parent(stat)
       end
@@ -97,7 +97,7 @@ module Pork
     end
 
     def description_for name=''
-      "#{@desc}#{@super_executor && @super_executor.description_for}#{name}"
+      "#{@super_executor && @super_executor.description_for}#{@desc}#{name}"
     end
   end
 end

data/lib/pork/isolate.rb

@@ -5,33 +5,36 @@ require 'pork/executor'
 module Pork
   module Isolate
     def all_tests
-      @all_tests ||= Hash[build_all_tests]
+      @all_tests ||= build_all_tests
     end
 
-    def isolate name, stat=Stat.new
+    def isolate path, stat=Stat.new
+      # XXX: 91152211182a086de20e3e84c96b6befca655975
+      #      Executor.execute is a no-op when Should is not loaded,
+      #      but if it's loaded, it's essential to call Should#execute to
+      #      setup the stat in thread group. Try to come up a better way!
       execute(stat) do |s|
-        execute_with_isolation(all_tests[name], s)
+        execute_with_isolation(path, s)
       end
     end
 
     protected
-    def build_all_tests paths=[]
-      @tests.flat_map.with_index do |(type, arg, _), index|
-        current = paths + [index]
+    def build_all_tests result={}, path=[]
+      @tests.each_with_index.inject(result) do |r, ((type, arg, _), index)|
+        current = path + [index]
         case type
         when :describe
-          arg.build_all_tests(current)
+          arg.build_all_tests(r, current)
         when :would
-          [["#{desc.chomp(': ')} #{arg} ##{current}", current]]
-        else
-          []
+          (r[description_for("would #{arg}")] ||= []) << current
         end
+        r
       end
     end
 
-    def execute_with_isolation paths, stat, super_env=nil
+    def execute_with_isolation path, stat, super_env=nil
       env = Env.new(super_env)
-      idx = paths.first
+      idx = path.first
 
       @tests.first(idx).each do |(type, arg, _)|
         case type
@@ -42,11 +45,11 @@ module Pork
         end
       end
 
-      if paths.size == 1
+      if path.size == 1
         _, desc, test = @tests[idx]
         run(desc, test, stat, env)
       else
-        @tests[idx][1].execute_with_isolation(paths.drop(1), stat, env)
+        @tests[idx][1].execute_with_isolation(path.drop(1), stat, env)
       end
     end
   end

data/lib/pork/mode/parallel.rb

@@ -4,11 +4,15 @@ require 'pork/isolate'
 
 module Pork
   module Parallel
-    def parallel cores=8, stat=Stat.new
-      all_tests.keys.shuffle.each_slice(cores).map do |names|
+    def cores
+      8
+    end
+
+    def parallel stat=Stat.new, paths=all_tests.values.flatten(1)
+      paths.shuffle.each_slice(cores).map do |paths_slice|
         Thread.new do
           s = Stat.new
-          names.each{ |n| isolate(n, s) }
+          paths_slice.each{ |p| isolate(p, s) }
           s
         end
       end.map(&:value).inject(stat, &:merge)

data/lib/pork/mode/shuffle.rb

@@ -4,9 +4,9 @@ require 'pork/isolate'
 
 module Pork
   module Shuffle
-    def shuffle stat=Stat.new
-      all_tests.keys.shuffle.each do |name|
-        isolate(name, stat)
+    def shuffle stat=Stat.new, paths=all_tests.values.flatten(1)
+      paths.shuffle.each do |p|
+        isolate(p, stat)
       end
       stat
     end

data/lib/pork/stat.rb

@@ -18,7 +18,7 @@ module Pork
     def report
       io.puts
       io.puts (failures + errors).map{ |(e, m)|
-        "\n#{m}\n#{e.class}: #{e.message}\n  #{backtrace(e)}"
+        "\n#{m}\n#{e.class}: #{e.message}\n  #{backtrace(e)}\n#{command(m)}"
       }
       io.printf("\nFinished in %f seconds.\n", Time.now - start)
       io.printf("%d tests, %d assertions, %d failures, %d errors, %d skips\n",
@@ -49,5 +49,26 @@ module Pork
     def strip_cwd backtrace
       backtrace.map{ |path| path.sub(Dir.pwd, '.') }
     end
+
+    def command name
+      "You can replicate this test with the following command:\n  " \
+      "#{env(name)} #{Gem.ruby} -S #{$0} #{ARGV.join(' ')}"
+    end
+
+    def env name
+      "env #{pork(name)} #{pork_mode} #{pork_seed}"
+    end
+
+    def pork name
+      "PORK_TEST='#{name.gsub("'", "\\\\'")}'"
+    end
+
+    def pork_mode
+      "PORK_MODE=#{Pork.execute_mode}"
+    end
+
+    def pork_seed
+      "PORK_SEED=#{Pork.seed}"
+    end
   end
 end

data/lib/pork/test.rb

@@ -4,9 +4,9 @@ require 'muack'
 
 copy do
   before do
-    Muack::API.stub(Pork::Executor.all_tests).keys.peek_return do |names|
-      names.reject do |n|
-        n =~ /^Pork::(Isolate|Shuffle|Parallel) /
+    Muack::API.stub(Pork::Executor).all_tests.peek_return do |tests|
+      tests.reject do |name, _|
+        name =~ /^Pork::(Isolate|Shuffle|Parallel): /
       end
     end
   end

data/lib/pork/version.rb

@@ -1,4 +1,4 @@
 
 module Pork
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

data/pork.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: pork 1.0.4 ruby lib
+# stub: pork 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pork"
-  s.version = "1.0.4"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-12-29"
+  s.date = "2015-01-28"
   s.description = "Pork -- Simple and clean and modular testing library.\n\nInspired by [Bacon][].\n\n[Bacon]: https://github.com/chneukirchen/bacon"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [

data/test/test_isolate.rb

@@ -4,10 +4,12 @@ require 'pork/isolate'
 
 describe Pork::Isolate do
   would '#isolate' do
-    Pork::Executor.all_tests.each_key do |name|
-      next ok if name.start_with?('Pork::Isolate #isolate #')
-      stat = Pork::Executor.isolate(name, pork_stat)
-      expect(stat.passed?, stat.inspect).eq true
+    Pork::Executor.all_tests.each do |name, paths|
+      next ok if name.start_with?('Pork::Isolate: would #isolate')
+      paths.each do |p|
+        stat = Pork::Executor.isolate(p, pork_stat)
+        expect(stat.passed?, stat.inspect).eq true
+      end
     end
   end
 end

data/test/test_parallel.rb

@@ -6,7 +6,7 @@ describe Pork::Parallel do
   paste
 
   would '#parallel' do
-    stat = Pork::Executor.parallel(8, pork_stat)
+    stat = Pork::Executor.parallel(pork_stat)
     expect(stat.passed?, stat.inspect).eq true
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pork
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: muack