command_runner_ng 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ec595e87ef6bc2b18247db034e7f6c16833c7ea
-  data.tar.gz: f35ed38a143ae56e0964d5fb146f47f43217f4ae
+  metadata.gz: 3421bf48db312e8cd8cec1544e7c2ca673be5179
+  data.tar.gz: 67fcb9afc773b88e9b7c4ec283b4553863dc3966
 SHA512:
-  metadata.gz: 2a5e1afcb667b1d18cecbeb7f5bc998df37a881b6ca3b33b986480faab4264af3189df20c12f2ae82ece3d67e251295d466f0be2ce22f3c06a184e2db039bdcd
-  data.tar.gz: 0c9b71180c50ba117e0c75975e226886608b8eb4f4e9b7ed17d419eba7c70e4bae6148e9d0e2d9601dd993cf6b99469db935cb6f1dc822845f700648fbd51cfd
+  metadata.gz: 979bfd1c39af20bf5dc04e86ed14f80125229ec037d6f47b943bb5733219e25226a46b28afde0acf6689e1a130c0cffb7f911e9d0c488b9b89b4a546d7a362e2
+  data.tar.gz: 3931eb2093d52b9ffdf551cc6b01f8a574534e596acea48fb47f8a2520f70979a510b8921bb9fcd0bd730a14d3b6aa3562cba9ca2ff7e9a577cddbdc1abad24e

data/lib/command_runner.rb

@@ -2,6 +2,8 @@ module CommandRunner
 
   MAX_TIME = Time.new(2**63 - 1)
 
+  DEFAULT_OPTIONS = {:err=>[:child, :out]}
+
   # Like IO.popen(), but block until the child completes.
   #
   # For convenience allows you to pass > 1 string args without a boxing array,
@@ -28,8 +30,9 @@ module CommandRunner
   # Takes an optional environment parameter (a Hash). The environment is
   # populated with the keys/values of this parameter.
   #
-  # Returns a Hash with :out and :status. :out is a string with stdout
-  # and stderr merged, and :status is a Process::Status.
+  # Returns a Hash with :out, :pid,  and :status. :out is a string with stdout
+  # and stderr merged, and :status is a Process::Status. The :pid field is the
+  # the PID the child process had when it ran.
   #
   # As a special case - if an action Proc raises an exception, the child
   # will be killed with SIGKILL, cleaned up, and the exception rethrown
@@ -44,7 +47,16 @@ module CommandRunner
   #
   # All Kernel.spawn features, like setting umasks, process group, and are supported through the options hash.
   #
-  def self.run(*args, timeout: nil, environment: {}, options: {:err=>[:child, :out]})
+  # Debugging: To help debugging your app you can set the debug_log parameter. It can be any old object responding
+  # to :puts. Fx. $stderr, $stdout, or the write end of an IO.pipe. CommandRunnerNG will put some info about
+  # 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)
+    if debug_log.nil?
+      debug_log = @@global_debug_log
+    end
+
     # If args is an array of strings, allow that as a shorthand for [arg1, arg2, arg3]
     if args.length > 1 && args.all? {|arg| arg.is_a? String}
       args = [args]
@@ -78,6 +90,7 @@ module CommandRunner
 
     # 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 = ""
 
     # Run through all deadlines until command completes.
@@ -88,7 +101,8 @@ module CommandRunner
       while Time.now < point[:deadline]
         if Process.wait(io.pid, Process::WNOHANG)
           read_nonblock_safe!(io, data, tick)
-          result = {:out => data, :status => $?}
+          result = {:out => data, :status => $?, pid: io.pid}
+          debug_log.puts("CommandRunnerNG exit: PID: #{io.pid}, code: #{result[:status].exitstatus}") if debug_log.respond_to?(:puts)
           io.close
           return result
         elsif !eof
@@ -98,6 +112,7 @@ module CommandRunner
 
       # Deadline for this point reached. Fire the action.
       action = point[:action]
+      debug_log.puts("CommandRunnerNG timeout: PID: #{io.pid}, action: #{action}") if debug_log.respond_to?(:puts)
       if action.is_a? String or action.is_a? Integer
         Process.kill(action, io.pid)
       elsif action.is_a? Proc
@@ -123,7 +138,9 @@ module CommandRunner
     # Either we didn't have a deadline, or none of the deadlines killed off the child.
     Process.wait(io.pid)
     read_nonblock_safe!(io, data, tick)
-    result = {:out => data, :status => $?}
+    result = {:out => data, :status => $?, pid: io.pid}
+    debug_log.puts("CommandRunnerNG exit: PID: #{io.pid}, code: #{result[:status].exitstatus}") if debug_log.respond_to?(:puts)
+
     io.close
 
     result
@@ -140,15 +157,28 @@ 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: [])
-    CommandInstance.new(args, timeout, environment, allowed_sub_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)
+  end
+
+  # Log all command line invocations to a logger object responding to :puts. Set to nil to disable.
+  # Setting the :debug_log keyword argument on individual invocations of CommandRunner.run() overrides this value.
+  def self.set_debug_log!(logger)
+    if logger.respond_to?(:puts) || logger.nil?
+      @@global_debug_log = logger
+    else
+      raise ArgumentError.new("Logger '#{logger}' not responding to :puts")
+    end
   end
 
   private
 
+  # Set to an object that respond to :puts to enable global debug logging for all
+  @@global_debug_log = nil
+
   class CommandInstance
 
-    def initialize(default_args, default_timeout, default_environment, allowed_sub_commands)
+    def initialize(default_args, default_timeout, default_environment, allowed_sub_commands, debug_log, options)
       unless default_args.first.is_a? Array
         raise "First argument must be an array of command line args. Found #{default_args}"
       end
@@ -157,6 +187,8 @@ module CommandRunner
       @default_timeout = default_timeout
       @default_environment = default_environment
       @allowed_sub_commands = allowed_sub_commands
+      @debug_log = debug_log
+      @options = options
     end
 
     def run(*args, timeout: nil, environment: {})
@@ -178,7 +210,11 @@ module CommandRunner
 
       full_args = @default_args.dup
       full_args[0] += args_list.map {|arg| arg.to_s }
-      CommandRunner.run(*full_args, timeout: (timeout || @default_timeout), environment: @default_environment.merge(environment))
+      CommandRunner.run(*full_args,
+                        timeout: (timeout || @default_timeout),
+                        environment: @default_environment.merge(environment),
+                        debug_log: @debug_log,
+                        options: @options)
     end
 
   end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: command_runner_ng
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mikkel Kamstrup Erlandsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies: []
 description: Helper APIs for advanced interactions with subprocesses and shell commands
-email: mikkel.kamstrup@xamarin.com
+email: kamikkel@microsoft.com
 executables: []
 extensions: []
 extra_rdoc_files: []