minitest-parallel_fork 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e48c02a4df6b51494a491f98a873028c7c394a58f3507a5818f7697af70208
-  data.tar.gz: ac75886465a2883f7631f38663ff9c20923492cdc03b58d80a3694dbc6b91430
+  metadata.gz: 9c152ef9216b8cbc9700f7f7e0281847695b325e660b51268b0d148a44e5aba2
+  data.tar.gz: 9d0739abeb8ccfaeb0ed023cb75b4fe30bb3f6e509af6d952204042229356649
 SHA512:
-  metadata.gz: ecb985d07f4b65d0496a4b33b01215e8863882a3a1e6131178285a573305c3a0aab70de56c4759f7b02d491d827f336644fdeb443c4bcdedebb4447187b827be
-  data.tar.gz: ea0eb216c1b9ed8c2edb1ba21b6d8db81a54b307ae5a3a63db99b0fca0e1fb1e8c3ad46d6adb2ae2bb1c6a92de092c20a9045bdf5a4c477bfb52996a4f7e6ae8
+  metadata.gz: e075bac95ab8dd13987e59533ace22ff48d878db63399659764f7af6c553cf835282b39044b50592ec776ab5ebc2d1af095bc9d8df955c0b230cce3cfe58a2e3
+  data.tar.gz: 57448ca69342f474102377fb287c67d298db98147bef22450d721cdae0acc4e9f65aad7d3e3937fc834118fd10e6200ced55d04609bc7ac43527dc1d6b63f5c7

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 1.2.0 (2021-08-16)
+
+* Work correctly with Minitest 5.14+ (jeremyevans)
+
+* Add on_parallel_fork_marshal_failure hook for handling marshal failures (child process exiting) (jeremyevans)
+
 === 1.1.2 (2018-07-05)
 
 * Handle raised exceptions containing unmarshallable data (jeremyevans)

data/README.rdoc

@@ -59,6 +59,15 @@ disconnected, and after forking, the database name is changed in each child to r
 a child-specific database, so that the child processes do not share a database and are
 thus independent.
 
+There is also a hook for debugging.  +on_parallel_fork_marshal_failure+ is called if
+there is an error unmarshalling data sent from the child process to the parent process.
+This can happen if one of the child processes exits unexpected during the test, before
+it reports results.
+
+  Minitest.on_parallel_fork_marshal_failure do
+    # Gather relevant logs for more debugging
+  end
+
 == ActiveRecord
 
 To use this with Rails/ActiveRecord, you probably want to use hooks similar to:

data/lib/minitest/parallel_fork.rb

@@ -6,11 +6,19 @@ module Minitest
   def self.before_parallel_fork(&block)
     @before_parallel_fork = block
   end
+  @before_parallel_fork = nil
 
   # Set the after_parallel_fork block to the given block
   def self.after_parallel_fork(i=nil, &block)
     @after_parallel_fork = block
   end
+  @after_parallel_fork = nil
+
+  # Set the on_parallel_fork_marshal_failure block to the given block
+  def self.on_parallel_fork_marshal_failure(&block)
+    @on_parallel_fork_marshal_failure = block
+  end
+  @on_parallel_fork_marshal_failure = nil
 
   module Unparallelize
     define_method(:run_one_method, &Minitest::Test.method(:run_one_method))
@@ -28,7 +36,7 @@ module Minitest
 
     n = (ENV['NCPU'] || 4).to_i
     reads = []
-    if defined?(@before_parallel_fork)
+    if @before_parallel_fork
       @before_parallel_fork.call
     end
     n.times do |i|
@@ -36,7 +44,7 @@ module Minitest
       reads << read
       fork do
         read.close
-        if defined?(@after_parallel_fork)
+        if @after_parallel_fork
           @after_parallel_fork.call(i)
         end
 
@@ -60,12 +68,17 @@ module Minitest
         data[-1].each do |result|
           result.failures.each do |failure|
             if failure.is_a?(Minitest::UnexpectedError)
-              e = failure.exception
+              e = failure.respond_to?(:error) ? failure.error : failure.exception
               begin
                 Marshal.dump(e)
               rescue TypeError
-                failure.exception = RuntimeError.new("Wrapped undumpable exception for: #{e.class}: #{e.message}")
-                failure.exception.set_backtrace(e.backtrace)
+                e2 = RuntimeError.new("Wrapped undumpable exception for: #{e.class}: #{e.message}")
+                e2.set_backtrace(e.backtrace)
+                if failure.respond_to?(:error=)
+                  failure.error = e2
+                else
+                  failure.exception = e2
+                end
               end
             end
           end
@@ -78,7 +91,14 @@ module Minitest
     end
 
     reads.map{|read| Thread.new(read, &:read)}.map(&:value).each do |data|
-      count, assertions, results = Marshal.load(data)
+      begin
+        count, assertions, results = Marshal.load(data)
+      rescue ArgumentError
+        if @on_parallel_fork_marshal_failure
+          @on_parallel_fork_marshal_failure.call
+        end
+        raise
+      end
       stat_reporter.count += count
       stat_reporter.assertions += assertions
       stat_reporter.results.concat(results)

data/spec/minitest_parallel_fork_example.rb

@@ -1,5 +1,5 @@
 gem 'minitest'
-require 'minitest/autorun'
+require 'minitest/global_expectations/autorun'
 require 'minitest/parallel_fork'
 
 a = nil
@@ -12,6 +12,12 @@ Minitest.after_parallel_fork do |i|
   print ":child#{i}#{a}"
 end
 
+if ENV['MPF_TEST_CHILD_FAILURE']
+  Minitest.on_parallel_fork_marshal_failure do |i|
+    print ":child-failure#{i}#{a}"
+  end
+end
+
 class MyExceptionClass < StandardError
   attr_reader :something
 end
@@ -27,7 +33,8 @@ end
     end
 
     it "should work" do
-      sleep(1).must_equal 1
+      sleep(1)
+      1.must_equal 1
     end
 
     it "should fail" do
@@ -35,6 +42,7 @@ end
     end
 
     it "should raise" do
+      exit(1) if ENV['MPF_TEST_CHILD_FAILURE']
       raise
     end
 

data/spec/minitest_parallel_fork_spec.rb

@@ -1,6 +1,6 @@
 ENV['MT_NO_PLUGINS'] = '1'
 gem 'minitest'
-require 'minitest/autorun'
+require 'minitest/global_expectations/autorun'
 
 describe 'minitest/parallel_fork' do
   [[nil, ''],
@@ -24,4 +24,17 @@ describe 'minitest/parallel_fork' do
       end
     end
   end
+
+  it "should call on_parallel_fork_marshal_failure on failure" do
+    t = Time.now
+    ENV['NCPU'] = '4'
+    ENV['MPF_TEST_CHILD_FAILURE'] = '1'
+    output = `#{ENV['RUBY']} -I lib spec/minitest_parallel_fork_example.rb 2>&1`
+    ENV.delete('MPF_TEST_CHILD_FAILURE')
+
+    time = (Time.now - t)
+    time.must_be :<, 4
+    output.must_match /:child-failurea/
+    output.must_match /marshal data too short/
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-parallel_fork
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.11.0
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  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: |
   minitest-parallel_fork adds fork-based parallelization to Minitest.  Each test/spec
   suite is run in one of the forks, allowing this to work correctly when using
@@ -72,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Fork-based parallelization for minitest