command_runner_ng 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 341dc1d0132412d53c1e5d258d7a6a03e96e3a4e
-  data.tar.gz: 94ac85a463daa4020bf069c47adba3a99fe4aebb
+  metadata.gz: e6de27ba13c1082bff813ee1eb2aec4c84dfe69f
+  data.tar.gz: 48227b83ec2908c902859d7468f10cf55bbd6975
 SHA512:
-  metadata.gz: 175e6af549e49bf1269032c11f0881ca5b89f79706ba706f082cba51af96b1a1ef13bf04d5d7955d64c3057af39096c94be946350934c25b10e71cfc6b741aac
-  data.tar.gz: 5308811978a0c87a00e2aef3766b95fb733da28bcf32f58f327e65f1a58f5633f9b7143eddf4f5a1e9f3fc591bdcfb78a6286026a5e40b50123a9a01e20a42f9
+  metadata.gz: b90ebd4992561b21a8b83c1de423254f8d114a97e79723d2b37f9a631380e9809689995d3c0b1a9a4ea98b745a870d37018429ec9be273fb764cecee78c0d9ce
+  data.tar.gz: d0e854031e48f9fa0f06c7f220ecadc9bd31ae98bbd041d346b3346ff3774c7f6b6a0badffb3505d4c816ccc3f06c5f06ba62ddcd3ed886a038fe14b67accfcd

data/lib/command_runner.rb

@@ -3,22 +3,31 @@ module CommandRunner
   MAX_TIME = Time.new(2**63 -1)
 
   # Like IO.popen(), but block until the child completes.
+  #
+  # For convenience allows you to pass > 1 string args without a boxing array,
+  # to execute a command with arguments without a subshell. See examples below.
+  #
   # Takes an optional timeout parameter. If timeout is a
   # number the child will be killed after that many seconds
   # if it haven't completed. Alternatively it can be a Hash
   # of timeouts to actions. Each action can be a string or integer
   # specifying the signal to send, or a Proc to execute. The Proc
   # will be called with the child PID as argument.
+  #
   # These examples are equivalent:
   #   run('sleep 10', timeout: 5) # With a subshell
+  #   run('sleep', '10', timeout: 5) # Without subshell. Convenience API to avoid array boxing as below
   #   run(['sleep', '10'], timeout: 5) # No subshell in this one and the rest
   #   run(['sleep', '10'], timeout: {5 => 'KILL'})
   #   run(['sleep', '10'], timeout: {5 => Proc.new { |pid| Process.kill('KILL', pid)}})
   #   run(['sleep', '10'], timeout: {
   #             5 => 'KILL',
-  #             2 => Proc.new {|pid| puts "PID #{pid} getting SIGKILL in 3s"}
+  #             2 => Proc.new {|pid| puts "PID #{pid} geting SIGKILL in 3s"}
   #   })
   #
+  # 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.
   #
@@ -26,7 +35,12 @@ module CommandRunner
   # will be killed with SIGKILL, cleaned up, and the exception rethrown
   # to the caller of run.
   #
-  def self.run(*args, timeout: nil)
+  def self.run(*args, timeout: nil, environment: {})
+    # 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]
+    end
+
     # This could be tweakable through vararg opts
     tick = 0.1
 
@@ -35,7 +49,7 @@ module CommandRunner
     # Build deadline_sequence. A list of deadlines and corresponding actions to take
     if timeout
       if timeout.is_a? Numeric
-        deadline_sequence = [{deadline: now + timeout, action: 'KILL'}]
+        deadline_sequence = [{:deadline => now + timeout, :action => 'KILL'}]
       elsif timeout.is_a? Hash
         deadline_sequence = timeout.collect do |t, action|
           unless action.is_a? Integer or action.is_a? String or action.is_a? Proc
@@ -44,17 +58,17 @@ module CommandRunner
           unless t.is_a? Numeric
             raise "Unsupported timeout value '#{t}'. Must be a Numeric"
           end
-          {deadline: now + t, action: action}
+          {:deadline => now + t, :action => action}
         end.sort! { |a, b| a[:deadline] <=> b[:deadline]}
       else
         raise "Unsupported type for timeout paramter: #{timeout.class}"
       end
     else
-      deadline_sequence = [{deadline: MAX_TIME, action: 0}]
+      deadline_sequence = [{:deadline => MAX_TIME, :action => 0}]
     end
 
     # Spawn child, merging stderr into stdout
-    io = IO.popen(*args, :err=>[:child, :out])
+    io = IO.popen(environment, *args, {:err=>[:child, :out]})
     data = ""
 
     # Run through all deadlines until command completes.
@@ -65,7 +79,7 @@ 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 => $?}
           io.close
           return result
         elsif !eof
@@ -100,14 +114,66 @@ 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 => $?}
     io.close
 
     result
   end
 
+  # Create a helper instance to launch a command with a given configuration.
+  # Invoke the command with the run() method. The configuration given to create()
+  # can be overriden on each invocation of run().
+  #
+  # The run() method of the helper instance must be invoked with a
+  #
+  # Examples:
+  # git = CommandRunner.create(['sudo', 'git'], timeout: 10, allowed_sub_commands: [:commit, :pull, :push])
+  # 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)
+  end
+
   private
 
+  class CommandInstance
+
+    def initialize(default_args, default_timeout, default_environment, allowed_sub_commands)
+      unless default_args.first.is_a? Array
+        raise "First argument must be an array of command line args. Found #{default_args}"
+      end
+
+      @default_args = default_args
+      @default_timeout = default_timeout
+      @default_environment = default_environment
+      @allowed_sub_commands = allowed_sub_commands
+    end
+
+    def run(*args, timeout: nil, environment: {})
+      args_list = *args
+
+      if !args_list.nil? && !args_list.empty? && args_list.first.is_a?(Array)
+        if args_list.length > 1
+          raise "Unsupported args list length: #{args_list.length}"
+        else
+          args_list = args_list.first
+        end
+      end
+
+      # Check sub command if needed
+      if !args_list.nil? && !args_list.empty? &&
+          !@allowed_sub_commands.empty? && !@allowed_sub_commands.include?(args_list.first)
+        raise "Illegal sub command '#{args_list.first}'. Expected #{allowed_sub_commands} (#{allowed_sub_commands.include?(args_list.first)})"
+      end
+
+      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))
+    end
+
+  end
+
   # Read data async, appending to data_out,
   # returning true on EOF, false otherwise
   def self.read_nonblock_safe!(io, data_out, tick)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_runner_ng
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Mikkel Kamstrup Erlandsen
@@ -29,7 +29,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='