command_runner_ng 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3421bf48db312e8cd8cec1544e7c2ca673be5179
-  data.tar.gz: 67fcb9afc773b88e9b7c4ec283b4553863dc3966
+  metadata.gz: a81766b72e2152688fa7ec9329557394dbecb320
+  data.tar.gz: 4443fc0fa5f5b0c3524607505283f8c20e4bc4d3
 SHA512:
-  metadata.gz: 979bfd1c39af20bf5dc04e86ed14f80125229ec037d6f47b943bb5733219e25226a46b28afde0acf6689e1a130c0cffb7f911e9d0c488b9b89b4a546d7a362e2
-  data.tar.gz: 3931eb2093d52b9ffdf551cc6b01f8a574534e596acea48fb47f8a2520f70979a510b8921bb9fcd0bd730a14d3b6aa3562cba9ca2ff7e9a577cddbdc1abad24e
+  metadata.gz: 3e479989e2f54239a84f27561e8c754838b0924a323ebdc1341fc5cc539a468b05e69af1940164370a6ddca0060bcc820ad46c7fb57b04d995b392bb0f749e1d
+  data.tar.gz: 9bffe871f6c0155167ee0f97410345b59d92e10f0acff36f88bef8808f18917a167e628d4826e43ca5ce6fd32f215b2dbba9c27d3c1cf6e32a4d80c349e83f21

data/lib/command_runner.rb

@@ -45,6 +45,9 @@ module CommandRunner
   # Fx. redirecting stderr to /dev/null would look like:
   #    run('ls', 'nosuchfile', options: {:err => "/dev/null"})
   #
+  # For simple case of splitting stderr into a buffer separate from stdout you can pass
+  # the argument split_stderr: true. This will make an :err entry available in the result.
+  #
   # All Kernel.spawn features, like setting umasks, process group, and are supported through the options hash.
   #
   # Debugging: To help debugging your app you can set the debug_log parameter. It can be any old object responding
@@ -52,7 +55,7 @@ module CommandRunner
   # all process start, stop, and timeouts here. To enable debug logging for all commands call
   # CommandRunner.set_debug_log!($stderr) (or with some other object responding to :puts).
   #
-  def self.run(*args, timeout: nil, environment: {}, debug_log: nil, options: DEFAULT_OPTIONS)
+  def self.run(*args, timeout: nil, environment: {}, debug_log: nil, split_stderr: false, options: DEFAULT_OPTIONS)
     if debug_log.nil?
       debug_log = @@global_debug_log
     end
@@ -88,11 +91,19 @@ module CommandRunner
       deadline_sequence = [{:deadline => MAX_TIME, :action => 0}]
     end
 
+    if split_stderr
+      err_r, err_w = IO.pipe
+      errbuf = ""
+      options = options.merge({:err => err_w})
+    end
+
     # Spawn child, merging stderr into stdout
     io = IO.popen(environment, *args, options)
     debug_log.puts("CommandRunnerNG spawn: args=#{args}, timeout=#{timeout}, options: #{options}, PID: #{io.pid}") if debug_log.respond_to?(:puts)
     data = ""
 
+    err_w.close if split_stderr
+
     # Run through all deadlines until command completes.
     # We could merge this block into the selecting block above,
     # but splitting like this saves us a Process.wait syscall per iteration.
@@ -101,12 +112,18 @@ module CommandRunner
       while Time.now < point[:deadline]
         if Process.wait(io.pid, Process::WNOHANG)
           read_nonblock_safe!(io, data, tick)
+          read_nonblock_safe!(err_r, errbuf, 0) if split_stderr
           result = {:out => data, :status => $?, pid: io.pid}
+          if split_stderr
+            result[:err] = errbuf
+            err_r.close
+          end
           debug_log.puts("CommandRunnerNG exit: PID: #{io.pid}, code: #{result[:status].exitstatus}") if debug_log.respond_to?(:puts)
           io.close
           return result
         elsif !eof
           eof = read_nonblock_safe!(io, data, tick)
+          read_nonblock_safe!(err_r, errbuf, 0) if split_stderr
         end
       end
 
@@ -136,9 +153,19 @@ module CommandRunner
     end
 
     # Either we didn't have a deadline, or none of the deadlines killed off the child.
+    loop do
+      dead = read_nonblock_safe!(io, data, tick)
+      read_nonblock_safe!(err_r, errbuf, 0) if split_stderr
+      break if dead
+    end
     Process.wait(io.pid)
-    read_nonblock_safe!(io, data, tick)
+
     result = {:out => data, :status => $?, pid: io.pid}
+    if split_stderr
+      result[:err] = errbuf
+      err_r.close
+    end
+
     debug_log.puts("CommandRunnerNG exit: PID: #{io.pid}, code: #{result[:status].exitstatus}") if debug_log.respond_to?(:puts)
 
     io.close
@@ -157,8 +184,8 @@ module CommandRunner
   # git.run(:pull, 'origin', 'master')
   # git.run(:pull, 'origin', 'master', timeout: 2) # override default timeout of 10
   # git.run(:status) # will raise an error because :status is not in list of allowed commands
-  def self.create(*args, timeout: nil, environment: {}, allowed_sub_commands: [], debug_log: nil, options: DEFAULT_OPTIONS)
-    CommandInstance.new(args, timeout, environment, allowed_sub_commands, debug_log, options)
+  def self.create(*args, timeout: nil, environment: {}, allowed_sub_commands: [], debug_log: nil, split_stderr: false, options: DEFAULT_OPTIONS)
+    CommandInstance.new(args, timeout, environment, allowed_sub_commands, debug_log, split_stderr, options)
   end
 
   # Log all command line invocations to a logger object responding to :puts. Set to nil to disable.
@@ -178,7 +205,7 @@ module CommandRunner
 
   class CommandInstance
 
-    def initialize(default_args, default_timeout, default_environment, allowed_sub_commands, debug_log, options)
+    def initialize(default_args, default_timeout, default_environment, allowed_sub_commands, debug_log, split_stderr, options)
       unless default_args.first.is_a? Array
         raise "First argument must be an array of command line args. Found #{default_args}"
       end
@@ -188,6 +215,7 @@ module CommandRunner
       @default_environment = default_environment
       @allowed_sub_commands = allowed_sub_commands
       @debug_log = debug_log
+      @split_stderr = split_stderr
       @options = options
     end
 
@@ -214,6 +242,7 @@ module CommandRunner
                         timeout: (timeout || @default_timeout),
                         environment: @default_environment.merge(environment),
                         debug_log: @debug_log,
+                        split_stderr: @split_stderr,
                         options: @options)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_runner_ng
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mikkel Kamstrup Erlandsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies: []
 description: Helper APIs for advanced interactions with subprocesses and shell commands
 email: kamikkel@microsoft.com
@@ -37,7 +37,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Command Runner NG