right_popen 1.0.4 → 1.0.5

data/lib/linux/right_popen.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Copyright (c) 2009 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
@@ -19,7 +19,7 @@
 # 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.
-#
+#++
 
 # RightScale.popen3 allows running external processes aynchronously
 # while still capturing their standard and error outputs.
@@ -99,33 +99,35 @@ module RightScale
   # Forks process to run given command asynchronously, hooking all three
   # standard streams of the child process.
   #
-  # Streams the command's stdout and stderr to the given handlers. Time-
-  # ordering of bytes sent to stdout and stderr is not preserved.
-  #
-  # Calls given exit handler upon command process termination, passing in the
-  # resulting Process::Status.
-  #
-  # All handlers must be methods exposed by the given target.
-  #
-  # === Parameters
-  # cmd(String):: command to execute, including any arguments.
-  # target(Object):: object defining handler methods to be called.
-  # stdout_handler(String):: token for stdout handler method name.
-  # stderr_handler(String):: token for stderr handler method name.
-  # exit_handler(String):: token for exit handler method name.
-  #
-  # === Returns
-  # true:: Always returns true
-  def self.popen3(cmd, target, stdout_handler = nil, stderr_handler = nil, exit_handler = nil)
-    raise "EventMachine reactor must be started" unless EM.reactor_running?
+  # See RightScale.popen3
+  def self.popen3_imp(options)
+    cmd = options[:command].dup
     GC.start # To garbage collect open file descriptors from passed executions
     EM.next_tick do
       saved_stderr = $stderr.dup
       r, w = Socket::pair(Socket::AF_LOCAL, Socket::SOCK_STREAM, 0)#IO::pipe
 
       $stderr.reopen w
-      c = EM.attach(r, StdErrHandler, target, stderr_handler, r) if stderr_handler
-      EM.popen(cmd, StdOutHandler, target, stdout_handler, exit_handler, c, r, w)
+      c = EM.attach(r, StdErrHandler, options[:target], options[:stderr_handler], r) if options[:stderr_handler]
+
+      # Setup environment for child process
+      envs = {}
+      options[:environment].each { |k, v| envs[k.to_s] = v } if options[:environment]
+      unless envs.empty?
+        old_envs = {}
+        ENV.each { |k, v| old_envs[k] = v if envs.include?(k) }
+        envs.each { |k, v| ENV[k] = v }
+      end
+
+      # Launch child process
+      EM.popen(cmd, StdOutHandler, options[:target], options[:stdout_handler], options[:exit_handler], c, r, w)
+
+      # Restore environment variables
+      unless envs.empty?
+        envs.each { |k, _| ENV[k] = nil }
+        old_envs.each { |k, v| ENV[k] = v }
+      end
+
       # Do not close 'w', strange things happen otherwise
       # (command protocol socket gets closed during decommission) 
       $stderr.reopen saved_stderr

data/lib/right_popen.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Copyright (c) 2009 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
@@ -19,7 +19,7 @@
 # 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.
-#
+#++
 
 # RightScale.popen3 allows running external processes aynchronously
 # while still capturing their standard and error outputs.
@@ -30,3 +30,36 @@ if RUBY_PLATFORM =~ /mswin/
 else
   require File.expand_path(File.join(File.dirname(__FILE__), 'linux', 'right_popen'))
 end
+
+module RightScale
+
+  # Spawn process to run given command asynchronously, hooking all three
+  # standard streams of the child process.
+  #
+  # Streams the command's stdout and stderr to the given handlers. Time-
+  # ordering of bytes sent to stdout and stderr is not preserved.
+  #
+  # Calls given exit handler upon command process termination, passing in the
+  # resulting Process::Status.
+  #
+  # All handlers must be methods exposed by the given target.
+  #
+  # === Parameters
+  # options[:command](String):: Command to execute, including any arguments
+  # options[:environment](Hash):: Hash of environment variables values keyed by name
+  # options[:target](Object):: object defining handler methods to be called, optional (no handlers can be defined if not specified)
+  # options[:stdout_handler](String):: Stdout handler method name, optional
+  # options[:stderr_handler](String):: Stderr handler method name, optional
+  # options[:exit_handler](String):: Exit handler method name, optional
+  #
+  # === Returns
+  # true:: Always returns 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]
+    RightScale.popen3_imp(options)
+    true
+  end
+
+end

data/right_popen.gemspec

@@ -4,7 +4,7 @@ spec = Gem::Specification.new do |spec|
   is_windows = RUBY_PLATFORM =~ /mswin/
 
   spec.name      = 'right_popen'
-  spec.version   = '1.0.4'
+  spec.version   = '1.0.5'
   spec.authors   = ['Scott Messier', 'Raphael Simon']
   spec.email     = 'scott@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_popen'

data/spec/print_env.rb

@@ -0,0 +1 @@
+ENV.each { |k, v| $stdout.puts "#{k}=#{v}\n" }

data/spec/right_popen_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
-require 'right_popen'
 
 RUBY_CMD         = 'ruby'
 STANDARD_MESSAGE = 'Standard message'
@@ -29,18 +28,23 @@ describe 'RightScale::popen3' do
 
       attr_reader :output_text, :error_text, :status
 
-      def do_right_popen(command)
+      def do_right_popen(command, env=nil)
         @output_text = ''
         @error_text  = ''
         @status      = nil
-        RightScale.popen3(command, self, :on_read_stdout, :on_read_stderr, :on_exit)
+        RightScale.popen3(:command        => command, 
+                          :target         => self, 
+                          :environment    => env,
+                          :stdout_handler => :on_read_stdout, 
+                          :stderr_handler => :on_read_stderr, 
+                          :exit_handler   => :on_exit)
       end
 
-      def run_right_popen(command, count = 1)
+      def run_right_popen(command, env=nil, count = 1)
         puts "#{count}>" if count > 1
         last_iteration = 0
         EM.next_tick do
-          do_right_popen(command)
+          do_right_popen(command, env)
         end
         EM.run do
           timer = EM::PeriodicTimer.new(0.05) do
@@ -54,7 +58,7 @@ describe 'RightScale::popen3' do
                       print '+'
                       STDOUT.flush
                     end
-                    do_right_popen(command)
+                    do_right_popen(command, env)
                   end
                 else
                   puts "<" if count > 1
@@ -162,11 +166,35 @@ describe 'RightScale::popen3' do
     end
     runner.error_text.should == results
   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
+    runner.run_right_popen(command)
+    runner.status.exitstatus.should == 0
+    runner.output_text.should_not include('_test_')
+    runner.run_right_popen(command, :__test__ => '42')
+    runner.status.exitstatus.should == 0
+    runner.output_text.should match(/^__test__=42$/)
+  end
+
+  it 'should restore environment variables' do
+    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 = RightPopenSpec::Runner.new
+    runner.run_right_popen(command, :__test__ => '42')
+    runner.status.exitstatus.should == 0
+    runner.output_text.should match(/^__test__=42$/)
+    ENV.each { |k, v| old_envs[k].should == v }
+    old_envs.each { |k, v| ENV[k].should == v }
+  end
 
   it 'should run repeatedly without leaking resources' do
     command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_output.rb'))}\" \"#{STANDARD_MESSAGE}\" \"#{ERROR_MESSAGE}\""
     runner = RightPopenSpec::Runner.new
-    runner.run_right_popen(command, REPEAT_TEST_COUNTER)
+    runner.run_right_popen(command, nil, REPEAT_TEST_COUNTER)
     runner.status.exitstatus.should == 0
     runner.output_text.should == STANDARD_MESSAGE + "\n"
     runner.error_text.should == ERROR_MESSAGE + "\n"

data/spec/spec_helper.rb

@@ -1,2 +1,4 @@
 require 'rubygems'
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'spec'
+require 'eventmachine'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'right_popen')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: right_popen
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Scott Messier
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -08:00
+date: 2010-02-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - lib/linux/right_popen.rb
 - lib/right_popen.rb
 - right_popen.gemspec
+- spec/print_env.rb
 - spec/produce_mixed_output.rb
 - spec/produce_output.rb
 - spec/produce_status.rb