open4 1.0.1 → 1.3.4

data/test/pfork4_test.rb

@@ -0,0 +1,150 @@
+require 'test_case'
+
+module Open4
+
+class PFork4Test < TestCase
+  def test_fun_successful_return
+    fun = lambda { 'lucky me' }
+    cid, _ = pfork4 fun
+    assert_equal 0, wait_status(cid)
+  end
+
+  def test_fun_force_exit
+    exit_code = 43
+    fun = lambda { exit! exit_code }
+    cid, _ = pfork4 fun
+    assert_equal exit_code, wait_status(cid)
+  end
+
+  def test_fun_normal_exit
+    exit_code = 43
+    fun = lambda { exit exit_code }
+    cid, _ = pfork4 fun
+    assert_equal exit_code, wait_status(cid)
+  end
+
+  def test_fun_does_not_propagate_exception_without_block
+    fun = lambda { raise MyError }
+    cid, _ = pfork4 fun
+    refute_equal 0, wait_status(cid)
+  end
+
+  def test_fun_propagate_exception_with_block
+    fun = lambda { raise MyError }
+    assert_raises(MyError) { pfork4(fun) {} }
+  end
+
+  def test_fun_propagate_exception_with_block_avoids_zombie_child_process
+    fun = lambda { raise MyError }
+    assert_raises(MyError) { pfork4(fun) {} }
+    assert_empty Process.waitall
+  end
+
+  def test_call_block_upon_exception
+    fun = lambda { raise MyError }
+    block_called = false
+    assert_raises(MyError) { pfork4(fun) { block_called = true } }
+    assert_equal true, block_called
+  end
+
+  def test_passes_child_pid_to_block
+    fun = lambda { $stdout.write Process.pid }
+    cid_in_block = nil
+    cid_in_fun = nil
+    pfork4(fun) do |cid, _, stdout, _|
+      cid_in_block = cid
+      cid_in_fun = stdout.read.to_i
+    end
+    assert_equal cid_in_fun, cid_in_block
+  end
+
+  def test_io_pipes_without_block
+    via_msg = 'foo'
+    err_msg = 'bar'
+    fun = lambda do
+      $stdout.write $stdin.read
+      $stderr.write err_msg
+    end
+    out_actual, err_actual = nil, nil
+    cid, stdin, stdout, stderr = pfork4 fun
+    stdin.write via_msg
+    stdin.close
+    out_actual = stdout.read
+    err_actual = stderr.read
+    assert_equal via_msg, out_actual
+    assert_equal err_msg, err_actual
+    assert_equal 0, wait_status(cid)
+  end
+
+  def test_io_pipes_with_block
+    via_msg = 'foo'
+    err_msg = 'bar'
+    fun = lambda do
+      $stdout.write $stdin.read
+      $stderr.write err_msg
+    end
+    out_actual, err_actual = nil, nil
+    status = pfork4(fun) do |_, stdin, stdout, stderr|
+      stdin.write via_msg
+      stdin.close
+      out_actual = stdout.read
+      err_actual = stderr.read
+    end
+    assert_equal via_msg, out_actual
+    assert_equal err_msg, err_actual
+    assert_equal 0, status.exitstatus
+  end
+
+  def test_exec_in_fun
+    via_msg = 'foo'
+    fun = lambda { exec %{ruby -e "print '#{via_msg}'"} }
+    out_actual = nil
+    status = pfork4(fun) do |_, stdin, stdout, _|
+      stdin.close
+      out_actual = stdout.read
+    end
+    assert_equal via_msg, out_actual
+    assert_equal 0, status.exitstatus
+  end
+
+  def test_io_pipes_and_then_exception_propagation_with_block
+    via_msg = 'foo'
+    err_msg = 'bar'
+    fun = lambda do
+      $stdout.write $stdin.read
+      $stderr.write err_msg
+      raise MyError
+    end
+    out_actual, err_actual = nil, nil
+    assert_raises(MyError) do
+      pfork4(fun) do |_, stdin, stdout, stderr|
+        stdin.write via_msg
+        stdin.close
+        out_actual = stdout.read
+        err_actual = stderr.read
+      end
+    end
+    assert_equal via_msg, out_actual
+    assert_equal err_msg, err_actual
+  end
+
+  def test_blocked_on_io_read_and_exception_propagation_with_block
+    fun = lambda do
+      $stdin.read
+      raise MyError
+    end
+    out_actual, err_actual = nil, nil
+    assert_raises(MyError) do
+      pfork4(fun) do |_, stdin, stdout, stderr|
+        stdin.write 'foo'
+        stdin.close
+        out_actual = stdout.read
+        err_actual = stderr.read
+      end
+    end
+    assert_equal '', out_actual
+    assert_equal '', err_actual
+  end
+end
+
+end

data/test/popen4_test.rb

@@ -0,0 +1,82 @@
+require 'test_case'
+
+module Open4
+
+class POpen4Test < TestCase
+  UNKNOWN_CMD = 'asdfadsfjlkkk'
+  UNKNOWN_CMD_ERRORS = [Errno::ENOENT, Errno::EINVAL]
+
+  def test_unknown_command_propagates_exception
+    err = assert_raises(*UNKNOWN_CMD_ERRORS) { popen4 UNKNOWN_CMD }
+    assert_match(/#{UNKNOWN_CMD}/, err.to_s) if on_mri?
+  end
+
+  def test_exception_propagation_avoids_zombie_child_process
+    assert_raises(*UNKNOWN_CMD_ERRORS) { popen4 UNKNOWN_CMD }
+    assert_empty Process.waitall
+  end
+
+  def test_exit_failure
+    code = 43
+    cid, _ = popen4 %{ruby -e "exit #{43}"}
+    assert_equal code, wait_status(cid)
+  end
+
+  def test_exit_success
+    cid, _ = popen4 %{ruby -e "exit"}
+    assert_equal 0, wait_status(cid)
+  end
+
+  def test_passes_child_pid_to_block
+    cmd = %{ruby -e "STDOUT.print Process.pid"}
+    cid_in_block = nil
+    cid_in_fun = nil
+    popen4(cmd) do |cid, _, stdout, _|
+      cid_in_block = cid
+      cid_in_fun = stdout.read.to_i
+    end
+    assert_equal cid_in_fun, cid_in_block
+  end
+
+  def test_io_pipes_without_block
+    via_msg = 'foo'
+    err_msg = 'bar'
+    cmd = <<-END
+ruby -e "
+  STDOUT.write STDIN.read
+  STDERR.write '#{err_msg}'
+"
+    END
+    cid, stdin, stdout, stderr = popen4 cmd
+    stdin.write via_msg
+    stdin.close
+    out_actual = stdout.read
+    err_actual = stderr.read
+    assert_equal via_msg, out_actual
+    assert_equal err_msg, err_actual
+    assert_equal 0, wait_status(cid)
+  end
+
+  def test_io_pipes_with_block
+    via_msg = 'foo'
+    err_msg = 'bar'
+    out_actual, err_actual = nil
+    cmd = <<-END
+ruby -e "
+  STDOUT.write STDIN.read
+  STDERR.write '#{err_msg}'
+"
+    END
+    status = popen4(cmd) do |_, stdin, stdout, stderr|
+      stdin.write via_msg
+      stdin.close
+      out_actual = stdout.read
+      err_actual = stderr.read
+    end
+    assert_equal via_msg, out_actual
+    assert_equal err_msg, err_actual
+    assert_equal 0, status.exitstatus
+  end
+end
+
+end

data/test/popen4ext_test.rb

@@ -0,0 +1,89 @@
+require 'test_case'
+require 'socket'
+
+module Open4
+
+class POpen4Test < TestCase
+  UNKNOWN_CMD = 'asdfadsfjlkkk'
+  UNKNOWN_CMD_ERRORS = [Errno::ENOENT, Errno::EINVAL]
+
+  def test_unknown_command_propagates_exception
+    err = assert_raises(*UNKNOWN_CMD_ERRORS) { popen4ext true, UNKNOWN_CMD }
+    assert_match(/#{UNKNOWN_CMD}/, err.to_s) if on_mri?
+  end
+
+  def test_exception_propagation_avoids_zombie_child_process
+    assert_raises(*UNKNOWN_CMD_ERRORS) { popen4ext true, UNKNOWN_CMD }
+    assert_empty Process.waitall
+  end
+
+  def test_exit_failure
+    code = 43
+    cid, _ = popen4ext true, %{ruby -e "exit #{43}"}
+    assert_equal code, wait_status(cid)
+  end
+
+  def test_exit_success
+    cid, _ = popen4ext true, %{ruby -e "exit"}
+    assert_equal 0, wait_status(cid)
+  end
+
+  def test_passes_child_pid_to_block
+    cmd = %{ruby -e "STDOUT.print Process.pid"}
+    cid_in_block = nil
+    cid_in_fun = nil
+    popen4ext(true, cmd) do |cid, _, stdout, _|
+      cid_in_block = cid
+      cid_in_fun = stdout.read.to_i
+    end
+    assert_equal cid_in_fun, cid_in_block
+  end
+
+  def test_io_pipes_without_block
+    via_msg = 'foo'
+    err_msg = 'bar'
+    cmd = <<-END
+ruby -e "
+  STDOUT.write STDIN.read
+  STDERR.write '#{err_msg}'
+"
+    END
+    cid, stdin, stdout, stderr = popen4ext true, cmd
+    stdin.write via_msg
+    stdin.close
+    out_actual = stdout.read
+    err_actual = stderr.read
+    assert_equal via_msg, out_actual
+    assert_equal err_msg, err_actual
+    assert_equal 0, wait_status(cid)
+  end
+
+  def test_io_pipes_with_block
+    via_msg = 'foo'
+    err_msg = 'bar'
+    out_actual, err_actual = nil
+    cmd = <<-END
+ruby -e "
+  STDOUT.write STDIN.read
+  STDERR.write '#{err_msg}'
+"
+    END
+    status = popen4ext(true, cmd) do |_, stdin, stdout, stderr|
+      stdin.write via_msg
+      stdin.close
+      out_actual = stdout.read
+      err_actual = stderr.read
+    end
+    assert_equal via_msg, out_actual
+    assert_equal err_msg, err_actual
+    assert_equal 0, status.exitstatus
+  end
+
+  def test_close_ignores_errors
+    TCPSocket.new('localhost', 59367).close rescue nil
+    cid, _ = popen4ext true, %{ruby -e "exit"}
+    assert_equal 0, wait_status(cid)
+  end
+end
+
+end

metadata

@@ -1,67 +1,64 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: open4
-version: !ruby/object:Gem::Version 
-  version: 1.0.1
+version: !ruby/object:Gem::Version
+  version: 1.3.4
 platform: ruby
-authors: 
+authors:
 - Ara T. Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-10-18 00:00:00 -06:00
-default_executable: 
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies: []
-
-description: manage child processes and their io handles easily
+description: ! 'open child process with handles on pid, stdin, stdout, and stderr:
+  manage child processes and their io handles easily.'
 email: ara.t.howard@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/open4.rb
-- open4.gemspec
-- Rakefile
+files:
+- LICENSE
 - README
 - README.erb
+- lib/open4.rb
+- open4.gemspec
+- rakefile
 - samples/bg.rb
 - samples/block.rb
 - samples/exception.rb
+- samples/jesse-caldwell.rb
+- samples/pfork4.rb
 - samples/simple.rb
 - samples/spawn.rb
 - samples/stdin_timeout.rb
 - samples/timeout.rb
+- test/lib/test_case.rb
+- test/pfork4_test.rb
+- test/popen4_test.rb
+- test/popen4ext_test.rb
 - white_box/leak.rb
-has_rdoc: true
-homepage: http://github.com/ahoward/open4/tree/master
-licenses: []
-
+homepage: https://github.com/ahoward/open4
+licenses:
+- Ruby
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: codeforpeople
-rubygems_version: 1.3.5
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: open4
 test_files: []
-

data/Rakefile

@@ -1,225 +0,0 @@
-
-This.rubyforge_project = 'codeforpeople'
-This.author = "Ara T. Howard"
-This.email = "ara.t.howard@gmail.com"
-This.homepage = "http://github.com/ahoward/#{ This.lib }/tree/master"
-
-
-task :default do
-  puts(Rake::Task.tasks.map{|task| task.name} - ['default'])
-end
-
-
-task :gemspec do
-  ignore_extensions = 'git', 'svn', 'tmp', /sw./, 'bak', 'gem'
-  ignore_directories = 'pkg'
-
-  shiteless = 
-    lambda do |list|
-      list.delete_if do |entry|
-        next unless test(?e, entry)
-        extension = File.basename(entry).split(%r/[.]/).last
-        ignore_extensions.any?{|ext| ext === extension}
-      end
-      list.delete_if do |entry|
-        next unless test(?d, entry)
-        dirname = File.expand_path(entry)
-        ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
-      end
-    end
-
-  lib         = This.lib
-  version     = This.version
-  files       = shiteless[Dir::glob("**/**")]
-  executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
-  has_rdoc    = true #File.exist?('doc')
-  test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
-
-  extensions = This.extensions
-  if extensions.nil?
-    %w( Makefile configure extconf.rb ).each do |ext|
-      extensions << ext if File.exists?(ext)
-    end
-  end
-  extensions = [extensions].flatten.compact
-
-  template = 
-    if test(?e, 'gemspec.erb')
-      Template{ IO.read('gemspec.erb') }
-    else
-      Template {
-        <<-__
-          ## #{ lib }.gemspec
-          #
-
-          Gem::Specification::new do |spec|
-            spec.name = #{ lib.inspect }
-            spec.version = #{ version.inspect }
-            spec.platform = Gem::Platform::RUBY
-            spec.summary = #{ lib.inspect }
-
-            spec.description = "manage child processes and their io handles easily"
-
-            spec.files = #{ files.inspect }
-            spec.executables = #{ executables.inspect }
-            
-            spec.require_path = "lib"
-
-            spec.has_rdoc = #{ has_rdoc.inspect }
-            spec.test_files = #{ test_files.inspect }
-            #spec.add_dependency 'lib', '>= version'
-            #spec.add_dependency 'fattr'
-
-            spec.extensions.push(*#{ extensions.inspect })
-
-            spec.rubyforge_project = #{ This.rubyforge_project.inspect }
-            spec.author = #{ This.author.inspect }
-            spec.email = #{ This.email.inspect }
-            spec.homepage = #{ This.homepage.inspect }
-          end
-        __
-      }
-    end
-
-  open("#{ lib }.gemspec", "w"){|fd| fd.puts template}
-  This.gemspec = "#{ lib }.gemspec"
-end
-
-task :gem => [:clean, :gemspec] do
-  Fu.mkdir_p This.pkgdir
-  before = Dir['*.gem']
-  cmd = "gem build #{ This.gemspec }"
-  `#{ cmd }`
-  after = Dir['*.gem']
-  gem = ((after - before).first || after.first) or abort('no gem!')
-  Fu.mv gem, This.pkgdir
-  This.gem = File.basename(gem)
-end
-
-
-task :readme do
-  samples = ''
-  prompt = '~ > '
-  lib = This.lib
-  version = This.version
-
-  Dir['sample*/*'].sort.each do |sample|
-    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
-
-    cmd = "cat #{ sample }"
-    samples << Util.indent(prompt + cmd, 2) << "\n\n"
-    samples << Util.indent(`#{ cmd }`, 4) << "\n"
-
-    cmd = "ruby #{ sample }"
-    samples << Util.indent(prompt + cmd, 2) << "\n\n"
-
-    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -Ilib #{ sample })'"
-    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
-  end
-
-  template = 
-    if test(?e, 'readme.erb')
-      Template{ IO.read('readme.erb') }
-    else
-      Template {
-        <<-__
-          NAME
-            #{ lib }
-
-          DESCRIPTION
-
-          INSTALL
-            gem install #{ lib }
-
-          SAMPLES
-            #{ samples }
-        __
-      }
-    end
-
-  open("README", "w"){|fd| fd.puts template}
-end
-
-
-task :clean do
-  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
-end
-
-
-task :release => [:clean, :gemspec, :gem] do
-  gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
-  raise "which one? : #{ gems.inspect }" if gems.size > 1
-  raise "no gems?" if gems.size < 1
-  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.pkgdir }/#{ This.gem }"
-  puts cmd
-  system cmd
-end
-
-
-
-
-
-BEGIN {
-  $VERBOSE = nil
-
-  require 'ostruct'
-  require 'erb'
-  require 'fileutils'
-
-  Fu = FileUtils
-
-  This = OpenStruct.new
-
-  This.file = File.expand_path(__FILE__)
-  This.dir = File.dirname(This.file)
-  This.pkgdir = File.join(This.dir, 'pkg')
-
-  lib = ENV['LIB']
-  unless lib
-    lib = File.basename(Dir.pwd)
-  end
-  This.lib = lib
-
-  version = ENV['VERSION']
-  unless version
-    name = lib.capitalize
-    require "./lib/#{ lib }"
-    version = eval(name).send(:version)
-  end
-  This.version = version
-
-  abort('no lib') unless This.lib
-  abort('no version') unless This.version
-
-  module Util
-    def indent(s, n = 2)
-      s = unindent(s)
-      ws = ' ' * n
-      s.gsub(%r/^/, ws)
-    end
-
-    def unindent(s)
-      indent = nil
-      s.each do |line|
-      next if line =~ %r/^\s*$/
-      indent = line[%r/^\s*/] and break
-    end
-    indent ? s.gsub(%r/^#{ indent }/, "") : s
-  end
-    extend self
-  end
-
-  class Template
-    def initialize(&block)
-      @block = block
-      @template = block.call.to_s
-    end
-    def expand(b=nil)
-      ERB.new(Util.unindent(@template)).result(b||@block)
-    end
-    alias_method 'to_s', 'expand'
-  end
-  def Template(*args, &block) Template.new(*args, &block) end
-
-  Dir.chdir(This.dir)
-}