shexecutor 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7bd1eafe5b0bcf3c40dfb7abcb428642fd8f56a
-  data.tar.gz: 5b24e222f42885b8e4e3e4f231d44eb623f60f09
+  metadata.gz: c90615e32be8148e01050f014d0bf7e107b403ad
+  data.tar.gz: 55607d1521893564995bea9da74153b084bd92ec
 SHA512:
-  metadata.gz: 562083bd0cd5db122e2332955518bb19cc403940bb98fdadc8edcaacc26724269dec003a28bfdcbff5107f1d0376357fd4e5e038ff1d806582091531253f111f
-  data.tar.gz: c46cd8e3d5f8835bf70bce083a02c692b75f35e87b818725e2dfee1e50104f0b66a48f7c99fdabb675f4dc54b7b43139abe55907f9293b108372b88f1dc61db2
+  metadata.gz: 54788b1980134c365b3b4c8cfb20c0d73ad74b3283e398f86e2b24662c57fcc382978dec80dfe10f463cf730ab7bab1244475dd1a32c609988a70ed888204b9d
+  data.tar.gz: becd1258cd4c5c1a526f180a419503430d5549c4064df9078300ba102d4100fb9229df812b6ca5b79787ec4d94894d00eea7ff993ed7bbd6073de8474f991af9

data/README.md

@@ -20,6 +20,31 @@ For a full description of status, please see Process::Status
 
 This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
 
+## Initialization options:
+
+Required / optional:
+
+```
+  {
+    :application_path                     # Path of the command to run
+    :params                               # Parameters to pass the command
+  }
+```
+
+```
+  @@default_options = {
+    :timeout => -1,                     # Seconds after which to raise Timeout::Error if not completed
+    :protect_against_injection => true, # look for spaces in and tainted application path
+    :stdout_path => nil,                # file to append stdout to
+    :stderr_path => nil,                # file to append stderr to
+    :append_stdout_path => true,        # if true, will append, otherwise will overwrite
+    :append_stderr_path => true,        # if true, will append, otherwise will overwrite
+    :replace => false,                  # replace the running process with the command
+    :wait_for_completion => false,      # block until the command completes
+    :timeout_sig_kill_retry => 500      # if timeout occurs, send TERM, and send signal 9 if still present after X ms
+  }
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/shexecutor/version.rb

@@ -1,3 +1,3 @@
 module SHExecutor
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/shexecutor.rb

@@ -3,14 +3,15 @@ require 'open3'
 
 module SHExecutor
   @@default_options = {
-    :timeout => -1,
-    :protect_against_injection => true,
-    :stdout_path => nil,
-    :stderr_path => nil,
-    :append_stdout_path => true,
-    :append_stderr_path => true,
-    :replace => false,
-    :wait_for_completion => false
+    :timeout => -1,                     # Seconds after which to raise Timeout::Error if not completed
+    :protect_against_injection => true, # look for spaces in and tainted application path
+    :stdout_path => nil,                # file to append stdout to
+    :stderr_path => nil,                # file to append stderr to
+    :append_stdout_path => true,        # if true, will append, otherwise will overwrite
+    :append_stderr_path => true,        # if true, will append, otherwise will overwrite
+    :replace => false,                  # replace the running process with the command
+    :wait_for_completion => false,      # block until the command completes
+    :timeout_sig_kill_retry => 500      # if timeout occurs, send TERM, and send signal 9 if still present after X ms
   }
 
   def self.default_options
@@ -127,9 +128,9 @@ module SHExecutor
     def run_process(application_path, options = "")
       data_out = StringIO.new
       data_err = StringIO.new
-      t0 = nil
+      @t0 = nil
       Open3::popen3(application_path, options) do |stdin, stdout, stderr, thr|
-        t0 = thr
+        @t0 = thr
         # read srderr and stdout into buffers to prevent blocking
         t1 = Thread.new do
           IO.copy_stream(stdout, data_out)
@@ -151,7 +152,7 @@ module SHExecutor
         t1.join if not should_timeout?
         t2.join if not should_timeout?
       end
-      return data_out, data_err, t0
+      return data_out, data_err, @t0
     end
 
     def block_process
@@ -170,17 +171,35 @@ module SHExecutor
         @result.join
         @result.value
       rescue Timeout::Error => ex
+        kill_process(@t0.pid)
         raise ex
       end
     end
 
+    def process?(pid)
+      begin
+        Process.getpgid(pid)
+        true
+      rescue Errno::ESRCH
+        false
+      end
+    end
+
+    def kill_process(pid)
+      return if pid.nil?
+      Process.kill("TERM", pid)
+      count = 0
+      while (count < (@options[:timeout_sig_kill_retry]/100) and process?(pid)) do
+        sleep 0.1
+      end
+      Process.kill(9, pid) if process?(pid)
+    end
+
     def fork_process
       validate
       @stdin_stream, @stdout_stream, @stderr_stream, @result = Open3::popen3(@options[:application_path], *@options[:params]) 
     end
 
-    private
-
     def should_timeout?
       @options[:timeout] > 0
     end

data/spec/executor_spec.rb

@@ -27,7 +27,8 @@ describe 'Executor' do
         :append_stdout_path => false,
         :append_stderr_path => false,
         :replace => false,
-        :wait_for_completion => true
+        :wait_for_completion => true,
+        :timeout_sig_kill_retry => 500
       }
       @iut = SHExecutor::Executor.new(iut_options)
       expect(@iut.options).to eq(iut_options)
@@ -207,7 +208,7 @@ describe 'Executor' do
   end
 
   context 'when asked to execute and block' do
-    it 'should raise a TimeoutException if a timeout is specified and the process does not exit before' do
+    it 'should raise a Timeout::Error if a timeout is specified and the process does not exit before' do
       test_command = "/bin/sleep"
       test_params = ["5"]
       iut = SHExecutor::Executor.new({:timeout => 1, :wait_for_completion => true, :application_path => test_command, :params => test_params})
@@ -219,6 +220,16 @@ describe 'Executor' do
       expect(after - before).to be < 2.1
     end
 
+    it 'should kill the subprocess when a TimeoutError is raised' do
+      test_command = "/bin/sleep"
+      test_params = ["2"]
+      iut = SHExecutor::Executor.new({:timeout => 1, :wait_for_completion => true, :application_path => test_command, :params => test_params})
+      expect(Process).to receive(:kill)
+      expect {
+        iut.execute
+      }.to raise_error(Timeout::Error, "execution expired")
+    end
+
     it 'should call run_process with the command and parameters specified' do
       test_command = "/bin/ls"
       test_params = ["/tmp/"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shexecutor
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Ernst van Graan