right_popen 1.0.11-x86-mswin32-60 → 1.0.17-x86-mswin32-60

data/Rakefile

@@ -1,14 +1,37 @@
 require 'rubygems'
+require 'bundler'
 require 'fileutils'
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
 require 'rbconfig'
 
+def list_spec_files
+  list = Dir['spec/**/*_spec.rb']
+  list.delete_if { |path| path.include?('/linux/') } if RUBY_PLATFORM =~ /mswin/
+  list
+end
+
 include Config
 
+Bundler::GemHelper.install_tasks
+
+# == Gem == #
+
+gemtask = Rake::GemPackageTask.new(Gem::Specification.load("right_popen.gemspec")) do |package|
+  package.package_dir = ENV['PACKAGE_DIR'] || 'pkg'
+  package.need_zip = true
+  package.need_tar = true
+end
+
+directory gemtask.package_dir
+
+CLEAN.include(gemtask.package_dir)
+
 desc "Clean any build files for right_popen"
-task :clean do
+task :win_clean do
   if RUBY_PLATFORM =~ /mswin/
     if File.exists?('ext/Makefile')
       Dir.chdir('ext') do
@@ -18,6 +41,7 @@ task :clean do
     rm 'lib/win32/right_popen.so' if File.file?('lib/win32/right_popen.so')
   end
 end
+task :clean => :win_clean
 
 desc "Build right_popen (but don't install it)"
 task :build => [:clean] do
@@ -33,14 +57,25 @@ end
 
 desc "Build a binary gem"
 task :gem => [:build] do
-   Dir["*.gem"].each { |gem| rm gem }
-   ruby 'right_popen.gemspec'
+  if RUBY_PLATFORM =~ /mswin/
+    # the built .so file must appear under 'lib/win32' for the windows gem and
+    # the base gem task doesn't appear to handle this. this may be an issue with
+    # calculating the file list in the gemspec before the .so has actually been
+    # created. workaround is to invoke the gem build gemspec command line after
+    # the build step produces the .so file.
+    sh 'gem build right_popen.gemspec'
+    FileUtils::rm_rf('pkg')
+    FileUtils::mkdir_p('pkg')
+    Dir.glob('*.gem').each { |gem_path| FileUtils::mv(gem_path, File.join('pkg', File.basename((gem_path)))) }
+  end
 end
 
 desc 'Install the right_popen library as a gem'
 task :install_gem => [:gem] do
-   file = Dir["*.gem"].first
-   sh "gem install #{file}"
+  Dir.chdir(File.dirname(__FILE__)) do
+     file = Dir["pkg/*.gem"].first
+     sh "gem install #{file}"
+  end
 end
 
 desc 'Uninstalls and reinstalls the right_popen library as a gem'
@@ -49,7 +84,44 @@ task :reinstall_gem do
    sh "rake install_gem"
 end
 
-desc 'Runs all spec tests'
-task :spec do
-  sh "spec spec/*_spec.rb"
+# == Unit Tests == #
+
+task :specs => :spec
+
+desc "Run unit tests"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = list_spec_files
+end
+
+desc "Run unit tests with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = list_spec_files
+  t.rcov = true
+end
+
+desc "Print Specdoc for unit tests"
+Spec::Rake::SpecTask.new(:doc) do |t|
+   t.spec_opts = ["--format", "specdoc", "--dry-run"]
+   t.spec_files = list_spec_files
+end
+
+# == Documentation == #
+
+desc "Generate API documentation to doc/rdocs/index.html"
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = 'doc/rdocs'
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include 'README.rdoc', "lib/**/*.rb"
+
+  rd.options << '--inline-source'
+  rd.options << '--line-numbers'
+  rd.options << '--all'
+  rd.options << '--fileboxes'
+  rd.options << '--diagram'
+end
+
+# == Emacs integration == #
+desc "Rebuild TAGS file"
+task :tags do
+  sh "rtags -R lib spec"
 end

data/ext/win32/right_popen.c

@@ -1457,7 +1457,8 @@ static VALUE right_popen_get_process_environment(VALUE vSelf)
 //  'RightPopen' module entry point
 void Init_right_popen()
 {
-    VALUE vModule = rb_define_module("RightPopen");
+    VALUE vCompanyModule = rb_define_module("RightScale");
+    VALUE vModule = rb_define_module_under(vCompanyModule, "RightPopen");
 
     rb_define_module_function(vModule, "popen4", (VALUE(*)(ANYARGS))right_popen_popen4, -1);
     rb_define_module_function(vModule, "async_read", (VALUE(*)(ANYARGS))right_popen_async_read, 1);

data/lib/right_popen/version.rb

@@ -0,0 +1,28 @@
+#--  -*- mode: ruby; encoding: utf-8 -*-
+# Copyright: Copyright (c) 2011 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 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.
+#++
+
+module RightScale
+  module RightPopen
+    VERSION = "1.0.17"
+  end
+end

data/lib/{win32 → right_popen/win32}/right_popen.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009 RightScale Inc
+# Copyright (c) 2009-2011 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -25,10 +25,13 @@ require 'rubygems'
 require 'eventmachine'
 require 'win32/process'
 
-require File.join(File.dirname(__FILE__), 'right_popen.so')  # win32 native code
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'win32', 'right_popen.so'))  # win32 native code
 
 module RightScale
 
+  # ensure uniqueness of handler to avoid confusion.
+  raise "#{StdInHandler.name} is already defined" if defined?(StdInHandler)
+
   # Eventmachine callback handler for stdin stream
   module StdInHandler
 
@@ -54,6 +57,9 @@ module RightScale
 
   end
 
+  # ensure uniqueness of handler to avoid confusion.
+  raise "#{StdOutHandler.name} is already defined" if defined?(StdOutHandler)
+
   # Provides an eventmachine callback handler for the stdout stream.
   module StdOutHandler
 
@@ -150,6 +156,9 @@ module RightScale
     end
   end
 
+  # ensure uniqueness of handler to avoid confusion.
+  raise "#{StdErrHandler.name} is already defined" if defined?(StdErrHandler)
+
   # Provides an eventmachine callback handler for the stderr stream.
   module StdErrHandler
 
@@ -197,7 +206,7 @@ module RightScale
   # and asynchronous I/O in the native Windows implementation.
   #
   # See RightScale.popen3
-  def self.popen3_imp(options)
+  def self.popen3_imp(options, &block)
     raise "EventMachine reactor must be started" unless EM.reactor_running?
 
     # merge command string
@@ -244,6 +253,7 @@ module RightScale
     # for waiting for the process to terminate or closing streams as the
     # watched eventables will handle this automagically. notification will be
     # sent to the exit_handler on process termination.
+    true
   end
 
   protected
@@ -309,8 +319,11 @@ module RightScale
       # machine from registry supercedes process.
       merge_environment2(machine_environment_hash, result_environment_hash)
 
-      # user environment from registry supercedes machine and process.
-      merge_environment2(current_user_environment_hash, result_environment_hash)
+      # user environment from registry supercedes machine and process. the
+      # system account's (default user profile) registry values are not
+      # appropriate for merging, so skip it when we know we are the system.
+      current_user_name = (`whoami`.chomp rescue '')
+      merge_environment2(current_user_environment_hash, result_environment_hash) unless current_user_name == 'nt authority\system'
 
       # caller's environment supercedes all.
       merge_environment2(environment_hash, result_environment_hash)

data/lib/right_popen.rb

@@ -26,9 +26,9 @@
 # It relies on EventMachine for most of its internal mechanisms.
 
 if RUBY_PLATFORM =~ /mswin/
-  require File.expand_path(File.join(File.dirname(__FILE__), 'win32', 'right_popen'))
+  require File.expand_path(File.join(File.dirname(__FILE__), 'right_popen', 'win32', 'right_popen'))
 else
-  require File.expand_path(File.join(File.dirname(__FILE__), 'linux', 'right_popen'))
+  require File.expand_path(File.join(File.dirname(__FILE__), 'right_popen', 'linux', 'right_popen'))
 end
 
 module RightScale
@@ -55,13 +55,12 @@ module RightScale
   # options[:exit_handler](String):: Exit handler method name, optional
   #
   # === Returns
-  # true:: Always returns true
+  # true:: always true
   def self.popen3(options)
     raise "EventMachine reactor must be started" unless EM.reactor_running?
     raise "Missing command" unless options[:command]
     raise "Missing target" unless options[:target] || !options[:stdout_handler] && !options[:stderr_handler] && !options[:exit_handler] && !options[:pid_handler]
-    RightScale.popen3_imp(options)
-    true
+    return RightScale.popen3_imp(options)
   end
 
 end

data/right_popen.gemspec

@@ -1,16 +1,15 @@
-require 'rubygems'
-
-def is_windows?
-  return RUBY_PLATFORM =~ /mswin/
-end
+$:.push File.expand_path("../lib", __FILE__)
+require "right_popen/version"
 
 spec = Gem::Specification.new do |spec|
+  is_windows = RUBY_PLATFORM =~ /mswin/
+
   spec.name      = 'right_popen'
-  spec.version   = '1.0.11'
+  spec.version   = RightScale::RightPopen::VERSION
   spec.authors   = ['Scott Messier', 'Raphael Simon', 'Graham Hughes']
   spec.email     = 'scott@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_popen'
-  if is_windows?
+  if is_windows
     spec.platform = 'x86-mswin32-60'
   else
     spec.platform  = Gem::Platform::RUBY
@@ -29,7 +28,7 @@ of its internal mechanisms. The Linux implementation is valid for any Linux
 platform but there is also a native implementation for Windows platforms.
 EOF
 
-  if is_windows?
+  if is_windows
     extension_dir = "ext,"
   else
     extension_dir = ""
@@ -40,7 +39,7 @@ EOF
     item.include?("Makefile") || item.include?(".obj") || item.include?(".pdb") || item.include?(".def") || item.include?(".exp") || item.include?(".lib")
   end
   candidates = candidates.delete_if do |item|
-    if is_windows?
+    if is_windows
       item.include?("/linux/")
     else
       item.include?("/win32/")
@@ -48,14 +47,12 @@ EOF
   end
   spec.files = candidates.sort!
 
-  # Current implementation supports >= 0.12.10
-  spec.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
-  if is_windows?
+  # Current implementation supports >= 0.12.11
+  spec.add_runtime_dependency(%q<eventmachine>, [">= 0.12.11"])
+  if is_windows
     spec.add_runtime_dependency(%q<win32-process>, [">= 0.6.1"])
   end
-end
-
-if $PROGRAM_NAME == __FILE__
-   Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.0
-   Gem::Builder.new(spec).build
+  spec.add_development_dependency('rspec', "~> 1.3")
+  spec.add_development_dependency('rake', "~> 0.8.7")
+  spec.add_development_dependency('flexmock')
 end

data/spec/background.rb

@@ -0,0 +1,28 @@
+#--  -*- mode: ruby; encoding: utf-8 -*-
+# Copyright: Copyright (c) 2011 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 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.
+#++
+
+fork {
+  sleep 30
+  puts "Done!"
+}
+exit 0

data/spec/right_popen_spec.rb

@@ -1,298 +1,230 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'runner'))
 
-describe 'RightScale::popen3' do
-
-  module RightPopenSpec
-    class Runner
-      class RunnerStatus
-        def initialize(command, block)
-          @output_text = ""
-          @error_text  = ""
-          @status      = nil
-          @did_timeout = false
-          @callback    = block
-          @pid         = nil
-          EM.next_tick do
-            @timeout = EM::Timer.new(2) do
-              puts "\n** Failed to run #{command.inspect}: Timeout"
-              @did_timeout = true
-              @callback.call(self)
-            end
-          end
-        end
-
-        attr_accessor :output_text, :error_text, :status, :did_timeout, :pid
+module RightScale
+  describe 'popen3' do
+    def is_windows?
+      return !!(RUBY_PLATFORM =~ /mswin/)
+    end
 
-        def on_read_stdout(data)
-          @output_text << data
-        end
+    it 'should redirect output' do
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_output.rb'))}\" \"#{STANDARD_MESSAGE}\" \"#{ERROR_MESSAGE}\""
+      runner = Runner.new
+      status = runner.run_right_popen(command)
+      status.status.exitstatus.should == 0
+      status.output_text.should == STANDARD_MESSAGE + "\n"
+      status.error_text.should == ERROR_MESSAGE + "\n"
+      status.pid.should > 0
+    end
 
-        def on_read_stderr(data)
-          @error_text << data
-        end
+    it 'should return the right status' do
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_status.rb'))}\" #{EXIT_STATUS}"
+      runner = Runner.new
+      status = runner.run_right_popen(command)
+      status.status.exitstatus.should == EXIT_STATUS
+      status.output_text.should == ''
+      status.error_text.should == ''
+      status.pid.should > 0
+    end
 
-        def on_pid(pid)
-          raise "PID already set!" unless @pid.nil?
-          @pid = pid
+    it 'should correctly handle many small processes' do
+      pending 'Set environment variable TEST_STRESS to enable' unless ENV['TEST_STRESS']
+      TO_RUN = 100
+      command = is_windows? ? "cmd.exe /c exit 0" : "exit 0"
+      runner = Runner.new
+      @completed = 0
+      @started = 0
+      run_cmd = Proc.new do
+        runner.do_right_popen(command) do |status|
+          @completed += 1
+          status.status.exitstatus.should == 0
+          status.output_text.should == ''
+          status.error_text.should == ''
+          status.pid.should > 0
         end
-
-        def on_exit(status)
-          @timeout.cancel if @timeout
-          @status = status
-          @callback.call(self)
+        @started += 1
+        if @started < TO_RUN
+          EM.next_tick { run_cmd.call }
         end
       end
+      EM.run do
+        EM.next_tick { run_cmd.call }
 
-      def initialize
-        @count          = 0
-        @done           = false
-        @last_exception = nil
-        @last_iteration = 0
-      end
-
-      def do_right_popen(command, env=nil, input=nil, &callback)
-        status = RunnerStatus.new(command, callback)
-        RightScale.popen3(:command        => command,
-                          :input          => input,
-                          :target         => status,
-                          :environment    => env,
-                          :stdout_handler => :on_read_stdout,
-                          :stderr_handler => :on_read_stderr,
-                          :pid_handler    => :on_pid,
-                          :exit_handler   => :on_exit)
-        status
-      end
-
-      def run_right_popen(command, env=nil, input=nil, count=1)
-        begin
-          @iterations = 0
-          EM.run do
-            EM.next_tick do
-              do_right_popen(command, env, input) do |status|
-                maybe_continue(status)
-              end
-            end
+        EM::PeriodicTimer.new(1) do
+          if @completed >= TO_RUN
+            EM.stop
           end
-          @status
-        rescue Exception => e
-          puts "\n** Failed: #{e.message} FROM\n#{e.backtrace.join("\n")}"
-          raise e
-        end
-      end
-
-      def maybe_continue(status)
-        @iterations += 1
-        if @iterations < @count
-          do_right_popen(command, env, input) {|status| maybe_continue(status)}
-        else
-          @status = status
-          EM.stop
         end
       end
     end
-  end
 
-  def is_windows?
-    return !!(RUBY_PLATFORM =~ /mswin/)
-  end
-
-  it 'should redirect output' do
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_output.rb'))}\" \"#{STANDARD_MESSAGE}\" \"#{ERROR_MESSAGE}\""
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command)
-    status.status.exitstatus.should == 0
-    status.output_text.should == STANDARD_MESSAGE + "\n"
-    status.error_text.should == ERROR_MESSAGE + "\n"
-    status.pid.should > 0
-  end
-
-  it 'should return the right status' do
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_status.rb'))}\" #{EXIT_STATUS}"
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command)
-    status.status.exitstatus.should == EXIT_STATUS
-    status.output_text.should == ''
-    status.error_text.should == ''
-    status.pid.should > 0
-  end
-
-  it 'should correctly handle many small processes' do
-    pending 'Set environment variable TEST_STRESS to enable' unless ENV['TEST_STRESS']
-    TO_RUN = 100
-    command = is_windows? ? "cmd.exe /c exit 0" : "exit 0"
-    runner = RightPopenSpec::Runner.new
-    @completed = 0
-    @started = 0
-    run_cmd = Proc.new do
-      runner.do_right_popen(command) do |status|
-        @completed += 1
-        status.status.exitstatus.should == 0
-        status.output_text.should == ''
-        status.error_text.should == ''
-        status.pid.should > 0
-      end
-      @started += 1
-      if @started < TO_RUN
-        EM.next_tick { run_cmd.call }
-      end
-    end
-    EM.run do
-      EM.next_tick { run_cmd.call }
+    it 'should preserve the integrity of stdout when stderr is unavailable' do
+      count = LARGE_OUTPUT_COUNTER
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_stdout_only.rb'))}\" #{count}"
+      runner = Runner.new
+      status = runner.run_right_popen(command)
+      status.status.exitstatus.should == 0
 
-      EM::PeriodicTimer.new(1) do
-        if @completed >= TO_RUN
-          EM.stop
-        end
+      results = ''
+      count.times do |i|
+        results << "stdout #{i}\n"
       end
+      status.output_text.should == results
+      status.error_text.should == ''
+      status.pid.should > 0
     end
-  end
-
-  it 'should preserve the integrity of stdout when stderr is unavailable' do
-    count = LARGE_OUTPUT_COUNTER
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_stdout_only.rb'))}\" #{count}"
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command)
-    status.status.exitstatus.should == 0
-
-    results = ''
-    count.times do |i|
-      results << "stdout #{i}\n"
-    end
-    status.output_text.should == results
-    status.error_text.should == ''
-    status.pid.should > 0
-  end
 
-  it 'should preserve the integrity of stderr when stdout is unavailable' do
-    count = LARGE_OUTPUT_COUNTER
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_stderr_only.rb'))}\" #{count}"
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command)
-    status.status.exitstatus.should == 0
+    it 'should preserve the integrity of stderr when stdout is unavailable' do
+      count = LARGE_OUTPUT_COUNTER
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_stderr_only.rb'))}\" #{count}"
+      runner = Runner.new
+      status = runner.run_right_popen(command)
+      status.status.exitstatus.should == 0
 
-    results = ''
-    count.times do |i|
-      results << "stderr #{i}\n"
+      results = ''
+      count.times do |i|
+        results << "stderr #{i}\n"
+      end
+      status.error_text.should == results
+      status.output_text.should == ''
+      status.pid.should > 0
     end
-    status.error_text.should == results
-    status.output_text.should == ''
-    status.pid.should > 0
-  end
 
-  it 'should preserve the integrity of stdout and stderr despite interleaving' do
-    count = LARGE_OUTPUT_COUNTER
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_mixed_output.rb'))}\" #{count}"
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command)
-    status.status.exitstatus.should == 99
+    it 'should preserve the integrity of stdout and stderr despite interleaving' do
+      count = LARGE_OUTPUT_COUNTER
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_mixed_output.rb'))}\" #{count}"
+      runner = Runner.new
+      status = runner.run_right_popen(command)
+      status.status.exitstatus.should == 99
 
-    results = ''
-    count.times do |i|
-      results << "stdout #{i}\n"
-    end
-    status.output_text.should == results
+      results = ''
+      count.times do |i|
+        results << "stdout #{i}\n"
+      end
+      status.output_text.should == results
 
-    results = ''
-    count.times do |i|
-      (results << "stderr #{i}\n") if 0 == i % 10
+      results = ''
+      count.times do |i|
+        (results << "stderr #{i}\n") if 0 == i % 10
+      end
+      status.error_text.should == results
+      status.pid.should > 0
     end
-    status.error_text.should == results
-    status.pid.should > 0
-  end
 
-  it 'should setup environment variables' do
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'print_env.rb'))}\""
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command)
-    status.status.exitstatus.should == 0
-    status.output_text.should_not include('_test_')
-    status = runner.run_right_popen(command, :__test__ => '42')
-    status.status.exitstatus.should == 0
-    status.output_text.should match(/^__test__=42$/)
-    status.pid.should > 0
-  end
-
-  it 'should restore environment variables' do
-    begin
-      ENV['__test__'] = '41'
-      old_envs = {}
-      ENV.each { |k, v| old_envs[k] = v }
+    it 'should setup environment variables' do
       command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'print_env.rb'))}\""
-      runner = RightPopenSpec::Runner.new
+      runner = Runner.new
+      status = runner.run_right_popen(command)
+      status.status.exitstatus.should == 0
+      status.output_text.should_not include('_test_')
       status = runner.run_right_popen(command, :__test__ => '42')
       status.status.exitstatus.should == 0
       status.output_text.should match(/^__test__=42$/)
-      ENV.each { |k, v| old_envs[k].should == v }
-      old_envs.each { |k, v| ENV[k].should == v }
       status.pid.should > 0
-    ensure
-      ENV.delete('__test__')
     end
-  end
 
-  if is_windows?
-    # FIX: this behavior is currently specific to Windows but should probably be
-    # implemented for Linux.
-    it 'should merge the PATH variable instead of overriding it' do
-      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'print_env.rb'))}\""
-      runner = RightPopenSpec::Runner.new
-      status = runner.run_right_popen(command, 'PATH' => "c:/bogus\\bin")
-      status.status.exitstatus.should == 0
-      status.output_text.should include('PATH=c:\\bogus\\bin;')
-      status.pid.should > 0
+    it 'should restore environment variables' do
+      begin
+        ENV['__test__'] = '41'
+        old_envs = {}
+        ENV.each { |k, v| old_envs[k] = v }
+        command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'print_env.rb'))}\""
+        runner = Runner.new
+        status = runner.run_right_popen(command, :__test__ => '42')
+        status.status.exitstatus.should == 0
+        status.output_text.should match(/^__test__=42$/)
+        ENV.each { |k, v| old_envs[k].should == v }
+        old_envs.each { |k, v| ENV[k].should == v }
+        status.pid.should > 0
+      ensure
+        ENV.delete('__test__')
+      end
+    end
+
+    if is_windows?
+      # FIX: this behavior is currently specific to Windows but should probably be
+      # implemented for Linux.
+      it 'should merge the PATH variable instead of overriding it' do
+        command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'print_env.rb'))}\""
+        runner = Runner.new
+        status = runner.run_right_popen(command, 'PATH' => "c:/bogus\\bin")
+        status.status.exitstatus.should == 0
+        status.output_text.should include('c:\\bogus\\bin;')
+        status.pid.should > 0
+      end
+    else
+      it 'should allow running bash command lines starting with a built-in command' do
+        command = "for i in 1 2 3 4 5; do echo $i;done"
+        runner = Runner.new
+        status = runner.run_right_popen(command)
+        status.status.exitstatus.should == 0
+        status.output_text.should == "1\n2\n3\n4\n5\n"
+        status.pid.should > 0
+      end
+
+      it 'should support running background processes' do
+        command = "(sleep 20)&"
+        now = Time.now
+        runner = Runner.new
+        status = runner.run_right_popen(command)
+        finished = Time.now
+        (finished - now).should < 20
+        status.did_timeout.should be_false
+        status.status.exitstatus.should == 0
+        status.output_text.should == ""
+        status.pid.should > 0
+      end
     end
-  else
-    it 'should allow running bash command lines starting with a built-in command' do
-      command = "for i in 1 2 3 4 5; do echo $i;done"
-      runner = RightPopenSpec::Runner.new
+
+    it 'should support raw command arguments' do
+      command = is_windows? ? ["cmd.exe", "/c", "echo", "*"] : ["echo", "*"]
+      runner = Runner.new
       status = runner.run_right_popen(command)
       status.status.exitstatus.should == 0
-      status.output_text.should == "1\n2\n3\n4\n5\n"
+      status.output_text.should == "*\n"
       status.pid.should > 0
     end
 
-    it 'should support running background processes' do
-      command = "(sleep 20)&"
-      now = Time.now
-      runner = RightPopenSpec::Runner.new
-      status = runner.run_right_popen(command)
-      finished = Time.now
-      (finished - now).should < 20
-      status.did_timeout.should be_false
+    it 'should run repeatedly without leaking resources' do
+      pending 'Set environment variable TEST_LEAK to enable' unless ENV['TEST_LEAK']
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_output.rb'))}\" \"#{STANDARD_MESSAGE}\" \"#{ERROR_MESSAGE}\""
+      runner = Runner.new
+      status = runner.run_right_popen(command, nil, nil, REPEAT_TEST_COUNTER)
       status.status.exitstatus.should == 0
-      status.output_text.should == ""
+      status.output_text.should == STANDARD_MESSAGE + "\n"
+      status.error_text.should == ERROR_MESSAGE + "\n"
       status.pid.should > 0
     end
-  end
 
-  it 'should support raw command arguments' do
-    command = is_windows? ? ["cmd.exe", "/c", "echo", "*"] : ["echo", "*"]
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command)
-    status.status.exitstatus.should == 0
-    status.output_text.should == "*\n"
-    status.pid.should > 0
-  end
+    it 'should pass input to child process' do
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'increment.rb'))}\""
+      runner = Runner.new
+      status = runner.run_right_popen(command, nil, "42\n")
+      status.status.exitstatus.should == 0
+      status.output_text.should == "43\n"
+      status.error_text.should be_empty
+      status.pid.should > 0
+    end
 
-  it 'should run repeatedly without leaking resources' do
-    pending 'Set environment variable TEST_LEAK to enable' unless ENV['TEST_LEAK']
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_output.rb'))}\" \"#{STANDARD_MESSAGE}\" \"#{ERROR_MESSAGE}\""
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command, nil, nil, REPEAT_TEST_COUNTER)
-    status.status.exitstatus.should == 0
-    status.output_text.should == STANDARD_MESSAGE + "\n"
-    status.error_text.should == ERROR_MESSAGE + "\n"
-    status.pid.should > 0
-  end
+    it 'should handle child processes that close stdout but keep running' do
+	  pending 'not implemented for windows' if is_windows?
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'stdout.rb'))}\""
+      runner = Runner.new
+      status = runner.run_right_popen(command, nil, nil)
+      status.did_timeout.should be_true
+      status.output_text.should be_empty
+      status.error_text.should == "Closing stdout\n"
+    end
 
-  it 'should pass input to child process' do
-    command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'increment.rb'))}\""
-    runner = RightPopenSpec::Runner.new
-    status = runner.run_right_popen(command, nil, "42\n")
-    status.status.exitstatus.should == 0
-    status.output_text.should == "43\n"
-    status.error_text.should be_empty
-    status.pid.should > 0
+    it 'should handle child processes that spawn long running background processes' do
+	  pending 'not implemented for windows' if is_windows?
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'background.rb'))}\""
+      runner = Runner.new
+      status = runner.run_right_popen(command, nil, nil)
+      status.status.exitstatus.should == 0
+      status.did_timeout.should be_false
+      status.output_text.should be_empty
+      status.error_text.should be_empty
+    end
   end
-
 end

data/spec/runner.rb

@@ -0,0 +1,112 @@
+#--  -*- mode: ruby; encoding: utf-8 -*-
+# Copyright: Copyright (c) 2011 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 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.
+#++
+
+module RightScale
+  class Runner
+    class RunnerStatus
+      def initialize(command, block)
+        @output_text = ""
+        @error_text  = ""
+        @status      = nil
+        @did_timeout = false
+        @callback    = block
+        @pid         = nil
+        EM.next_tick do
+          @timeout = EM::Timer.new(2) do
+            puts "\n** Failed to run #{command.inspect}: Timeout"
+            @did_timeout = true
+            @callback.call(self)
+          end
+        end
+      end
+
+      attr_accessor :output_text, :error_text, :status, :did_timeout, :pid
+
+      def on_read_stdout(data)
+        @output_text << data
+      end
+
+      def on_read_stderr(data)
+        @error_text << data
+      end
+
+      def on_pid(pid)
+        raise "PID already set!" unless @pid.nil?
+        @pid = pid
+      end
+
+      def on_exit(status)
+        @timeout.cancel if @timeout
+        @status = status
+        @callback.call(self)
+      end
+    end
+
+    def initialize
+      @count          = 0
+      @done           = false
+      @last_exception = nil
+      @last_iteration = 0
+    end
+
+    def do_right_popen(command, env=nil, input=nil, &callback)
+      status = RunnerStatus.new(command, callback)
+      RightScale.popen3(:command        => command,
+                      :input          => input,
+                      :target         => status,
+                      :environment    => env,
+                      :stdout_handler => :on_read_stdout,
+                      :stderr_handler => :on_read_stderr,
+                      :pid_handler    => :on_pid,
+                      :exit_handler   => :on_exit)
+      status
+    end
+
+    def run_right_popen(command, env=nil, input=nil, count=1)
+      begin
+        @iterations = 0
+        EM.run do
+          EM.next_tick do
+            do_right_popen(command, env, input) do |status|
+              maybe_continue(status)
+            end
+          end
+        end
+        @status
+      rescue Exception => e
+        puts "\n** Failed: #{e.message} FROM\n#{e.backtrace.join("\n")}"
+        raise e
+      end
+    end
+
+    def maybe_continue(status)
+      @iterations += 1
+      if @iterations < @count
+        do_right_popen(command, env, input) {|status| maybe_continue(status)}
+      else
+        @status = status
+        EM.stop
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rubygems'
+require 'bundler/setup'
 require 'spec'
 require 'eventmachine'
+require 'flexmock'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'right_popen')
 
 RUBY_CMD         = 'ruby'
@@ -18,3 +20,7 @@ REPEAT_TEST_COUNTER = 256
 def is_windows?
   return RUBY_PLATFORM =~ /mswin/
 end
+
+Spec::Runner.configure do |config|
+  config.mock_with :flexmock
+end

data/spec/stdout.rb

@@ -0,0 +1,28 @@
+#--  -*- mode: ruby; encoding: utf-8 -*-
+# Copyright: Copyright (c) 2011 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 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.
+#++
+
+$stderr.puts "Closing stdout"
+STDOUT.close
+sleep 3
+$stderr.puts "Exiting"
+exit 0

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_popen
 version: !ruby/object:Gem::Version 
-  version: 1.0.11
+  hash: 53
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 17
+  version: 1.0.17
 platform: x86-mswin32-60
 authors: 
 - Scott Messier
@@ -11,29 +17,86 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-08 00:00:00 -07:00
+date: 2011-09-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.12.10
-    version: 
+        hash: 57
+        segments: 
+        - 0
+        - 12
+        - 11
+        version: 0.12.11
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: win32-process
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
         version: 0.6.1
-    version: 
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: |
   RightPopen allows running external processes aynchronously while still
   capturing their standard and error outputs. It relies on EventMachine for most
@@ -55,9 +118,11 @@ files:
 - ext/win32/right_popen.c
 - ext/win32/right_popen.h
 - lib/right_popen.rb
-- lib/win32/right_popen.rb
+- lib/right_popen/version.rb
+- lib/right_popen/win32/right_popen.rb
 - lib/win32/right_popen.so
 - right_popen.gemspec
+- spec/background.rb
 - spec/increment.rb
 - spec/print_env.rb
 - spec/produce_mixed_output.rb
@@ -66,7 +131,9 @@ files:
 - spec/produce_stderr_only.rb
 - spec/produce_stdout_only.rb
 - spec/right_popen_spec.rb
+- spec/runner.rb
 - spec/spec_helper.rb
+- spec/stdout.rb
 has_rdoc: true
 homepage: https://github.com/rightscale/right_popen
 licenses: []
@@ -80,21 +147,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 59
+      segments: 
+      - 1
+      - 8
+      - 6
       version: 1.8.6
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: right_popen
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Provides a platform-independent popen implementation