posix-spawn 0.3.10 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 88d9e42c2e091d60ef6bfaa4bee93671bfa7cdf1
-  data.tar.gz: 0c34d4025ca8b876345fea00bb45a152b6909c10
+SHA256:
+  metadata.gz: e80888255d57122ba2ad477c456582e0ebfdd05a61b175c60577ee8b38e579ad
+  data.tar.gz: 12d37e71310f0127b75b0f31da196c9c7554cac29a31d63754583f7737132190
 SHA512:
-  metadata.gz: 6204dd64bc24a24a7ac155f8f7a0f018860b850b94efc68a68aa6b286a0de3a179deccb6f96ae7b1410045dface4de63aca14d235b1322bfac61399d825b65ff
-  data.tar.gz: 988a0574b69a3accddfbb739c89b3da9949146cf7f316f41e2dc364c4ef5bb3cf7ae69858fe9c0318336e946cfc929a1c77178287e742db5a820044f4d680eee
+  metadata.gz: 3371e197b9b63ec2dce0b64d070bce8628ccb63112bcd14e8f7426891d1acf4d4ce4bc9558f44a832eaabd194b4b11a7feb2f12db2dd1d6db60968b8b9bc1a2a
+  data.tar.gz: 4d63126f9866a66ac6cc50d811be076939e1048f490aa40c55db1931398e016d225c3ae3da939a93646be551e6b207066f1dd4d2a1ee4f7dfe859a4404325242

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.2
+  - 2.4
+  - 2.6
+  - ruby-head

data/COPYING

@@ -20,9 +20,3 @@ 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.
-
-A small portion of the environ dup'ing code in ext/posix-spawn.c
-was taken from glibc <http://www.gnu.org/s/libc/> and is maybe
-Copyright (c) 2011 by The Free Software Foundation or maybe
-by others mentioned in the glibc LICENSES file. glibc is
-distributed under the terms of the LGPL license.

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/ext/posix-spawn.c

@@ -45,7 +45,7 @@ static VALUE rb_mPOSIXSpawn;
  *       an actual fd number:
  *         - The symbols :in, :out, or :err for fds 0, 1, or 2.
  *         - An IO object. (IO#fileno is returned)
- *         - A Fixnum.
+ *         - An Integer.
  *
  * Returns the fd number >= 0 if one could be established, or -1 if the object
  * does not map to an fd.
@@ -56,7 +56,11 @@ posixspawn_obj_to_fd(VALUE obj)
 	int fd = -1;
 	switch (TYPE(obj)) {
 		case T_FIXNUM:
-			/* Fixnum fd number */
+		case T_BIGNUM:
+			/* Integer fd number
+			 * rb_fix2int takes care of raising if the provided object is a
+			 * Bignum and is out of range of an int
+			 */
 			fd = FIX2INT(obj);
 			break;
 
@@ -94,7 +98,7 @@ posixspawn_obj_to_fd(VALUE obj)
 /*
  * Hash iterator that sets up the posix_spawn_file_actions_t with addclose
  * operations. Only hash pairs whose value is :close are processed. Keys may
- * be the :in, :out, :err, an IO object, or a Fixnum fd number.
+ * be the :in, :out, :err, an IO object, or an Integer fd number.
  *
  * Returns ST_DELETE when an addclose operation was added; ST_CONTINUE when
  * no operation was performed.
@@ -269,27 +273,27 @@ each_env_check_i(VALUE key, VALUE val, VALUE arg)
 static int
 each_env_i(VALUE key, VALUE val, VALUE arg)
 {
-	char *name = StringValuePtr(key);
-	size_t len = strlen(name);
+	const char *name = StringValuePtr(key);
+	const size_t name_len = strlen(name);
 
-	/*
-	 * Delete any existing values for this variable before inserting the new value.
-	 * This implementation was copied from glibc's unsetenv().
-	 */
-	char **ep = (char **)arg;
-	while (*ep != NULL)
-		if (!strncmp (*ep, name, len) && (*ep)[len] == '=')
-		{
-			/* Found it.  Remove this pointer by moving later ones back.  */
-			char **dp = ep;
-
-			do
-				dp[0] = dp[1];
-			while (*dp++);
-			/* Continue the loop in case NAME appears again.  */
+	char **envp = (char **)arg;
+	size_t i, j;
+
+	for (i = 0; envp[i];) {
+		const char *ev = envp[i];
+
+		if (strlen(ev) > name_len && !memcmp(ev, name, name_len) && ev[name_len] == '=') {
+			/* This operates on a duplicated environment -- release the
+			 * existing entry memory before shifting the subsequent entry
+			 * pointers down. */
+			free(envp[i]);
+
+			for (j = i; envp[j]; ++j)
+				envp[j] = envp[j + 1];
+			continue;
 		}
-		else
-			++ep;
+		i++;
+	}
 
 	/*
 	 * Insert the new value if we have one. We can assume there is space
@@ -301,15 +305,15 @@ each_env_i(VALUE key, VALUE val, VALUE arg)
 		char *cval = StringValuePtr(val);
 
 		size_t cval_len = strlen(cval);
-		size_t ep_len = len + 1 + cval_len + 1; /* +2 for null terminator and '=' separator */
+		size_t ep_len = name_len + 1 + cval_len + 1; /* +2 for null terminator and '=' separator */
 
 		/* find the last entry */
 		while (*ep != NULL) ++ep;
 		*ep = malloc(ep_len);
 
-		strncpy(*ep, name, len);
-		(*ep)[len] = '=';
-		strncpy(*ep + len + 1, cval, cval_len);
+		strncpy(*ep, name, name_len);
+		(*ep)[name_len] = '=';
+		strncpy(*ep + name_len + 1, cval, cval_len);
 		(*ep)[ep_len-1] = 0;
 	}
 
@@ -373,6 +377,7 @@ rb_posixspawn_pspawn(VALUE self, VALUE env, VALUE argv, VALUE options)
 
 		if (RHASH_SIZE(env) > 0) {
 			int size = 0;
+			char **new_env;
 
 			char **curr = environ;
 			if (curr) {
@@ -387,7 +392,7 @@ rb_posixspawn_pspawn(VALUE self, VALUE env, VALUE argv, VALUE options)
 				size = 0;
 			}
 
-			char **new_env = calloc(size+RHASH_SIZE(env)+1, sizeof(char*));
+			new_env = calloc(size+RHASH_SIZE(env)+1, sizeof(char*));
 			for (i = 0; i < size; i++) {
 				new_env[i] = strdup(environ[i]);
 			}

data/lib/posix/spawn.rb

@@ -85,7 +85,7 @@ module POSIX
   #
   #     spawn(command, :chdir => "/var/tmp")
   #
-  # The :in, :out, :err, a Fixnum, an IO object or an Array option specify
+  # The :in, :out, :err, an Integer, an IO object or an Array option specify
   # fd redirection. For example, stderr can be merged into stdout as follows:
   #
   #     spawn(command, :err => :out)
@@ -460,11 +460,11 @@ module POSIX
 
     # Determine whether object is fd-like.
     #
-    # Returns true if object is an instance of IO, Fixnum >= 0, or one of the
+    # Returns true if object is an instance of IO, Integer >= 0, or one of the
     # the symbolic names :in, :out, or :err.
     def fd?(object)
       case object
-      when Fixnum
+      when Integer
         object >= 0
       when :in, :out, :err, STDIN, STDOUT, STDERR, $stdin, $stdout, $stderr, IO
         true
@@ -486,7 +486,7 @@ module POSIX
         STDOUT
       when :err, 2
         STDERR
-      when Fixnum
+      when Integer
         object >= 0 ? IO.for_fd(object) : nil
       when IO
         object
@@ -529,7 +529,7 @@ module POSIX
     #
     # Returns a [[cmdname, argv0], argv1, ...] array.
     def adjust_process_spawn_argv(args)
-      if args.size == 1 && args[0] =~ /[ |>]/
+      if args.size == 1 && args[0].is_a?(String) && args[0] =~ /[ |>]/
         # single string with these characters means run it through the shell
         command_and_args = system_command_prefixes + [args[0]]
         [*command_and_args]

data/lib/posix/spawn/child.rb

@@ -1,5 +1,3 @@
-require 'posix/spawn'
-
 module POSIX
   module Spawn
     # POSIX::Spawn::Child includes logic for executing child processes and
@@ -77,6 +75,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 +88,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 +133,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,17 +149,22 @@ 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)
 
         # grab exit status
         @status = waitpid(pid)
-      rescue Object => boom
+      rescue Object
         [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
@@ -180,7 +195,6 @@ module POSIX
       def read_and_write(input, stdin, stdout, stderr, timeout=nil, max=nil)
         max = nil if max && max <= 0
         @out, @err = '', ''
-        offset = 0
 
         # force all string and IO encodings to BINARY under 1.9 for now
         if @out.respond_to?(:force_encoding) and stdin.respond_to?(:set_encoding)

data/lib/posix/spawn/version.rb

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

data/posix-spawn.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
 
   s.authors = ['Ryan Tomayko', 'Aman Gupta']
   s.email = ['r@tomayko.com', 'aman@tmm1.net']
-  s.licenses = ['MIT', 'LGPL']
+  s.licenses = ['MIT']
 
   s.add_development_dependency 'rake-compiler', '0.7.6'
   s.add_development_dependency 'minitest', '>= 4'

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

data/test/test_spawn.rb

@@ -322,7 +322,7 @@ module SpawnImplementationTests
       end
     end
 
-    assert_match /oops/, exception.message
+    assert_match(/oops/, exception.message)
   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.15
 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: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -52,6 +52,7 @@ extra_rdoc_files:
 - HACKING
 files:
 - ".gitignore"
+- ".travis.yml"
 - COPYING
 - Gemfile
 - HACKING
@@ -75,7 +76,6 @@ files:
 homepage: https://github.com/rtomayko/posix-spawn
 licenses:
 - MIT
-- LGPL
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -92,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: posix_spawnp(2) for ruby