posix-spawn 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88d9e42c2e091d60ef6bfaa4bee93671bfa7cdf1
-  data.tar.gz: 0c34d4025ca8b876345fea00bb45a152b6909c10
+  metadata.gz: f593fc74a9f8637ea2c1dbfa897a805d6f87c0fe
+  data.tar.gz: 89a1a14ec837e06d68e85af34e56e956a976df30
 SHA512:
-  metadata.gz: 6204dd64bc24a24a7ac155f8f7a0f018860b850b94efc68a68aa6b286a0de3a179deccb6f96ae7b1410045dface4de63aca14d235b1322bfac61399d825b65ff
-  data.tar.gz: 988a0574b69a3accddfbb739c89b3da9949146cf7f316f41e2dc364c4ef5bb3cf7ae69858fe9c0318336e946cfc929a1c77178287e742db5a820044f4d680eee
+  metadata.gz: 33b05adfe9baf71faabd10e25e434c03e6aac674b4d9d05a6b79e1f8972a34aeacba3bb7b40598355fc9aa4c455049eeb0b3f6c00f7790d906f1ef01bb1799fe
+  data.tar.gz: 75ab91856b7ee41fad74bf2be66096d2667f8fbe888d5c7d67ab364c5033438ceb8e1f1a6b0e9f99cd120da4b65ca9486f2177b1bf4aa51ad7463229102e6dc1

data/Rakefile

@@ -14,7 +14,13 @@ end
 # Ruby Extension
 # ==========================================================
 
-require 'rake/extensiontask'
+begin
+  require 'rake/extensiontask'
+rescue LoadError => boom
+  warn "ERROR: The rake-compiler gem dependency is missing."
+  warn "Please run `bundle install' and try again."
+  raise
+end
 Rake::ExtensionTask.new('posix_spawn_ext', GEMSPEC) do |ext|
   ext.ext_dir = 'ext'
 end

data/lib/posix/spawn/child.rb

@@ -77,6 +77,9 @@ module POSIX
       #   :max     => total    Maximum number of bytes of output to allow the
       #                        process to generate before aborting with a
       #                        MaximumOutputExceeded exception.
+      #   :pgroup_kill => bool Boolean specifying whether to kill the process
+      #                        group (true) or individual process (false, default).
+      #                        Setting this option true implies :pgroup => true.
       #
       # Returns a new Child instance whose underlying process has already
       # executed to completion. The out, err, and status attributes are
@@ -87,6 +90,10 @@ module POSIX
         @input = @options.delete(:input)
         @timeout = @options.delete(:timeout)
         @max = @options.delete(:max)
+        if @options.delete(:pgroup_kill)
+          @pgroup_kill = true
+          @options[:pgroup] = true
+        end
         @options.delete(:chdir) if @options[:chdir].nil?
         exec! if !@options.delete(:noexec)
       end
@@ -128,6 +135,11 @@ module POSIX
       # Total command execution time (wall-clock time)
       attr_reader :runtime
 
+      # The pid of the spawned child process. This is unlikely to be a valid
+      # current pid since Child#exec! doesn't return until the process finishes
+      # and is reaped.
+      attr_reader :pid
+
       # Determine if the process did exit with a zero exit status.
       def success?
         @status && @status.success?
@@ -139,6 +151,7 @@ module POSIX
       def exec!
         # spawn the process and hook up the pipes
         pid, stdin, stdout, stderr = popen4(@env, *(@argv + [@options]))
+        @pid = pid
 
         # async read from all streams into buffers
         read_and_write(@input, stdin, stdout, stderr, @timeout, @max)
@@ -148,8 +161,12 @@ module POSIX
       rescue Object => boom
         [stdin, stdout, stderr].each { |fd| fd.close rescue nil }
         if @status.nil?
-          ::Process.kill('TERM', pid) rescue nil
-          @status = waitpid(pid)      rescue nil
+          if !@pgroup_kill
+            ::Process.kill('TERM', pid) rescue nil
+          else
+            ::Process.kill('-TERM', pid) rescue nil
+          end
+          @status = waitpid(pid) rescue nil
         end
         raise
       ensure

data/lib/posix/spawn/version.rb

@@ -1,5 +1,5 @@
 module POSIX
   module Spawn
-    VERSION = '0.3.10'
+    VERSION = '0.3.11'
   end
 end

data/test/test_child.rb

@@ -1,10 +1,42 @@
 # coding: UTF-8
-
 require 'test_helper'
 
 class ChildTest < Minitest::Test
   include POSIX::Spawn
 
+  # Become a new process group.
+  def setup
+    Process.setpgrp
+  end
+
+  # Kill any orphaned processes in our process group before continuing but
+  # ignore the TERM signal we receive.
+  def teardown
+    trap("TERM") { trap("TERM", "DEFAULT") }
+    begin
+      Process.kill("-TERM", Process.pid)
+      Process.wait
+    rescue Errno::ECHILD
+    end
+  end
+
+  # verify the process is no longer running and has been reaped.
+  def assert_process_reaped(pid)
+    Process.kill(0, pid)
+    assert false, "Process #{pid} still running"
+  rescue Errno::ESRCH
+  end
+
+  # verifies that all processes in the given process group are no longer running
+  # and have been reaped. The current ruby test process is excluded.
+  # XXX It's weird to use the SUT here but the :pgroup option is useful. Could
+  # be a IO.popen under Ruby >= 1.9 since it also supports :pgroup.
+  def assert_process_group_reaped(pgid)
+    command = "ps axo pgid,pid,args | grep '^#{pgid} ' | grep -v '^#{pgid} #$$'"
+    procs = POSIX::Spawn::Child.new(command, :pgroup => true).out
+    assert procs.empty?, "Processes in group #{pgid} still running:\n#{procs}"
+  end
+
   def test_sanity
     assert_same POSIX::Spawn::Child, Child
   end
@@ -56,21 +88,45 @@ class ChildTest < Minitest::Test
   end
 
   def test_max
-    assert_raises MaximumOutputExceeded do
-      Child.new('yes', :max => 100_000)
-    end
+    child = Child.build('yes', :max => 100_000)
+    assert_raises(MaximumOutputExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped Process.pid
+  end
+
+  def test_max_pgroup_kill
+    child = Child.build('yes', :max => 100_000, :pgroup_kill => true)
+    assert_raises(MaximumOutputExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped child.pid
   end
 
   def test_max_with_child_hierarchy
-    assert_raises MaximumOutputExceeded do
-      Child.new('/bin/sh', '-c', 'yes', :max => 100_000)
-    end
+    child = Child.build('/bin/sh', '-c', 'true && yes', :max => 100_000)
+    assert_raises(MaximumOutputExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped Process.pid
+  end
+
+  def test_max_with_child_hierarchy_pgroup_kill
+    child = Child.build('/bin/sh', '-c', 'true && yes', :max => 100_000, :pgroup_kill => true)
+    assert_raises(MaximumOutputExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped child.pid
   end
 
   def test_max_with_stubborn_child
-    assert_raises MaximumOutputExceeded do
-      Child.new("trap '' TERM; yes", :max => 100_000)
-    end
+    child = Child.build("trap '' TERM; yes", :max => 100_000)
+    assert_raises(MaximumOutputExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped Process.pid
+  end
+
+  def test_max_with_stubborn_child_pgroup_kill
+    child = Child.build("trap '' TERM; yes", :max => 100_000, :pgroup_kill => true)
+    assert_raises(MaximumOutputExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped child.pid
   end
 
   def test_max_with_partial_output
@@ -80,6 +136,8 @@ class ChildTest < Minitest::Test
       p.exec!
     end
     assert_output_exceeds_repeated_string("y\n", 100_000, p.out)
+    assert_process_reaped p.pid
+    assert_process_group_reaped Process.pid
   end
 
   def test_max_with_partial_output_long_lines
@@ -88,28 +146,47 @@ class ChildTest < Minitest::Test
       p.exec!
     end
     assert_output_exceeds_repeated_string("nice to meet you\n", 10_000, p.out)
+    assert_process_reaped p.pid
+    assert_process_group_reaped Process.pid
   end
 
   def test_timeout
     start = Time.now
-    assert_raises TimeoutExceeded do
-      Child.new('sleep', '1', :timeout => 0.05)
-    end
+    child = Child.build('sleep', '1', :timeout => 0.05)
+    assert_raises(TimeoutExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped Process.pid
+    assert (Time.now-start) <= 0.2
+  end
+
+  def test_timeout_pgroup_kill
+    start = Time.now
+    child = Child.build('sleep', '1', :timeout => 0.05, :pgroup_kill => true)
+    assert_raises(TimeoutExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped child.pid
     assert (Time.now-start) <= 0.2
   end
 
   def test_timeout_with_child_hierarchy
-    assert_raises TimeoutExceeded do
-      Child.new('/bin/sh', '-c', 'sleep 1', :timeout => 0.05)
-    end
+    child = Child.build('/bin/sh', '-c', 'true && sleep 1', :timeout => 0.05)
+    assert_raises(TimeoutExceeded) { child.exec! }
+    assert_process_reaped child.pid
+  end
+
+  def test_timeout_with_child_hierarchy_pgroup_kill
+    child = Child.build('/bin/sh', '-c', 'true && sleep 1', :timeout => 0.05, :pgroup_kill => true)
+    assert_raises(TimeoutExceeded) { child.exec! }
+    assert_process_reaped child.pid
+    assert_process_group_reaped child.pid
   end
 
   def test_timeout_with_partial_output
     start = Time.now
-    p = Child.build('echo Hello; sleep 1', :timeout => 0.05)
-    assert_raises TimeoutExceeded do
-      p.exec!
-    end
+    p = Child.build('echo Hello; sleep 1', :timeout => 0.05, :pgroup_kill => true)
+    assert_raises(TimeoutExceeded) { p.exec! }
+    assert_process_reaped p.pid
+    assert_process_group_reaped Process.pid
     assert (Time.now-start) <= 0.2
     assert_equal "Hello\n", p.out
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posix-spawn
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler