frontkick 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1ec1035f37f85a6c2df0efac9c9a2bf94f924aa
-  data.tar.gz: f86e5798517525996d28f8e9ea37752864771b50
+  metadata.gz: 21315e4ecfde359617b02081d2252b558e576acd
+  data.tar.gz: 158fd87c5c96234c08ac944259b734d580f4a7bf
 SHA512:
-  metadata.gz: 15f13d612326c77c06c274c0a21be7d80c5da51018a1060f8092ead9170387079cf99bc77447acc7aab34dd51a125b72cd0bf3dc46118aa7f682e6c54cf3c6f3
-  data.tar.gz: 13eb2a6ddc5fd04aba31e499428c17ba982e5a0ac6c80a80f6c668bf8cfb3cacdf7a1b056e98bb5d1488b1b0d527b08435680f252331bfc806dcc2b4fa97b1ca
+  metadata.gz: cca5e9b8043cf202446b3592d3370f17b3d5bdbe490df40e0b82f90b852154e2c44e157e74a901ab26427ffcd07bf82ea43e9ecfca16a2840c3486d4e210252f
+  data.tar.gz: 0cba11a2c72e2be354087dfb9d79c4df17ee2b737c6ad1c19457ce6dc78488a53d43dfa3b7804ec9a3c74c04633b766177ec59e64877497a07a5f2cd1640a3d4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.5.1 (2016/01/23)
+
+Changes:
+
+- Drop :kill_child option, instead, support pid block
+
 # 0.5.0 (2016/01/22)
 
 Enhancements:

data/README.md

@@ -54,20 +54,7 @@ If you prefer to be blocked:
 
     Frontkick.exec("sleep 2 && ls /hoge", :exclusive => "/tmp/frontkick.lock", :exclusive_blocking => true)
 
-### Kill Child Option
-
-On receiving INT and TERM signal, kill the kicked child process before exiting
-
-    Frontkick.exec(["sleep 100"], :kill_child => true)
-
-NOTE: This uses Kernel.trap inside.
-NOTE: Shoud use `[]` form, otherwirse `sh -c 'sleep 100'` is ran, and frotkick kills sh process, but sleep process remains
-
-### Spawn Options
-
-Other options such as :chdir are treated as options of `Kernel.#spawn`. See http://ruby-doc.org/core-2.3.0/Kernel.html#method-i-spawn for available options.
-
-### Redirect Options
+### Redirect Options (:out and :err)
 
     Frontkick.exec(["ls /something_not_found"], :out => 'stdout.txt', :err => 'stderr.txt')
 
@@ -79,6 +66,42 @@ This redirects STDOUT and STDERR into files. In this case, result.stdout, and re
 
 You can also give IO objects. In this case, result.stdout, and result.stderr are the given IO objects.
 
+### Popen3 Options (such as :chdir)
+
+Other options such as :chdir are treated as options of `Open3.#popen3`.
+
+### Kill Child Process
+
+To kill your frontkick process with its kicked child process, send signal to their signal group as
+
+    kill -TERM -{PGID}
+
+You can find PGID like `ps -eo pid,pgid,command`.
+
+If you can not send a signal to a signal group by some reasons, handle signal by yourself as
+
+```ruby
+Frontkick.exec(["sleep 100"]) do |wait_thr|
+  pid = wait_thr.pid
+  trap :INT do
+    Process.kill(:TERM, pid)
+    # wait child processes finish
+    begin
+      pid, status = Process.waitpid2(pid)
+    rescue Errno::ECHILD => e
+    end
+    exit 130
+  end
+  trap :TERM do
+    Process.kill(:TERM, pid)
+    Frontkick.process_wait(pid) # same with above
+    exit 143
+  end
+end
+```
+
+More sophisticated example is available at [./example/kill_child.rb]
+
 ## Contributing
 
 1. Fork it

data/example/kill_child.rb

@@ -1,5 +1,51 @@
 require 'frontkick'
 
-puts Process.pid
-result = Frontkick.exec(["sleep 3000"], :kill_child => true)
-puts result.stdout
+puts "kill -TERM #{Process.pid} or Hit Ctrl-C in 10 seconds"
+
+result = Frontkick.exec(["sleep 10"]) do |wait_thr|
+  pid = wait_thr.pid
+  signal_pipe_r, signal_pipe_w = IO.pipe
+
+  # You know, there are many things `can't be called from trap context`
+  trap :INT do
+    signal_pipe_w.puts 'INT'
+  end
+  trap :TERM do
+    signal_pipe_w.puts 'TERM'
+  end
+
+  # Create a new thread to handle signals
+  # This example kills child and self
+  signal_handler_thr = Thread.new do
+    readable_io = IO.select([signal_pipe_r])
+    signal = readable_io.first[0].gets.strip
+    case signal
+    when 'INT'
+      puts "kill -INT #{pid}"
+      Process.kill('INT', pid) rescue nil
+      pid, status = Process.waitpid2(pid) rescue nil
+      Kernel.exit(130)
+    when 'TERM'
+      puts "kill -TERM #{pid}"
+      Process.kill('TERM', pid) rescue nil
+      pid, status = Process.waitpid2(pid) rescue nil
+      Kernel.exit(148)
+    end
+  end
+
+  begin
+    # Wait child to finish (for normal situation)
+    wait_thr.join
+
+    # Send NOOP to finish signal_handler_thr (for normal situation)
+    signal_pipe_w.puts 'NOOP'
+    signal_handler_thr.join
+  ensure
+    signal_pipe_r.close rescue nil
+    signal_pipe_w.close rescue nil
+  end
+end
+
+# should come here if child process finished normally,
+# but not come here if signals are received (Kernel.exit)
+puts result.inspect

data/lib/frontkick.rb

@@ -5,7 +5,11 @@ require 'frontkick/command'
 require 'frontkick/result'
 
 module Frontkick
-  def self.exec(cmd, opts = {})
-    ::Frontkick::Command.exec(cmd, opts)
+  def self.exec(cmd, opts = {}, &block)
+    ::Frontkick::Command.exec(cmd, opts, &block)
+  end
+
+  def self.process_wait(pid)
+    ::Frontkick::Command.process_wait(pid)
   end
 end

data/lib/frontkick/command.rb

@@ -4,7 +4,7 @@ require 'shellwords'
 
 module Frontkick
   class Command
-    def self.exec(cmd, opts = {})
+    def self.exec(cmd, opts = {}, &block)
       opts[:timeout_kill] = true unless opts.has_key?(:timeout_kill) # default: true
 
       exit_code, duration = nil
@@ -39,14 +39,14 @@ module Frontkick
         return Result.new(:stdout => command, :stderr => '', :exit_code => 0, :duration => 0)
       end
 
-      spawn_opts = self.spawn_opts(opts)
+      popen3_opts = self.popen3_opts(opts)
 
       lock_fd = file_lock(opts[:exclusive], opts[:exclusive_blocking]) if opts[:exclusive]
       begin
         ::Timeout.timeout(opts[:timeout], Frontkick::TimeoutLocal) do # nil is for no timeout
           duration = Benchmark.realtime do
-            stdin, stdout, stderr, wait_thr = Open3.popen3(*cmd_array, spawn_opts)
-            out_thread = Thread.new {
+            stdin, stdout, stderr, wait_thr = Open3.popen3(*cmd_array, popen3_opts)
+            out_thr = Thread.new {
               begin
                 while true
                   out.write stdout.readpartial(4096)
@@ -54,7 +54,7 @@ module Frontkick
               rescue EOFError
               end
             }
-            err_thread = Thread.new {
+            err_thr = Thread.new {
               begin
                 while true
                   err.write stderr.readpartial(4096)
@@ -65,12 +65,10 @@ module Frontkick
             stdin.close
             pid = wait_thr.pid
 
-            if opts[:kill_child]
-              trap_signal(pid)
-            end
+            yield(wait_thr) if block_given?
 
-            out_thread.join
-            err_thread.join
+            out_thr.join
+            err_thr.join
             exit_code = wait_thr.value.exitstatus
             process_wait(pid)
           end
@@ -105,29 +103,17 @@ module Frontkick
 
     # private
 
-    def self.spawn_opts(opts)
+    def self.popen3_opts(opts)
       opts.dup.tap {|o|
         o.delete(:timeout_kill)
         o.delete(:exclusive)
         o.delete(:exclusive_blocking)
         o.delete(:timeout)
-        o.delete(:kill_child)
+        o.delete(:out)
+        o.delete(:err)
       }
     end
 
-    def self.trap_signal(pid)
-      trap :INT do
-        Process.kill(:TERM, pid)
-        process_wait(pid)
-        exit 130
-      end
-      trap :TERM do
-        Process.kill(:TERM, pid)
-        process_wait(pid)
-        exit 143
-      end
-    end
-
     def self.process_wait(pid)
       begin
         pid, status = Process.waitpid2(pid) # wait child processes finish

data/lib/frontkick/version.rb

@@ -1,3 +1,3 @@
 module Frontkick
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frontkick
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake