frontkick 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21315e4ecfde359617b02081d2252b558e576acd
-  data.tar.gz: 158fd87c5c96234c08ac944259b734d580f4a7bf
+  metadata.gz: 6086b0058c21edf9586f841eef70e15a746dbbaf
+  data.tar.gz: 0b1f63ed60327e2907dee507eaebe8ac9393df06
 SHA512:
-  metadata.gz: cca5e9b8043cf202446b3592d3370f17b3d5bdbe490df40e0b82f90b852154e2c44e157e74a901ab26427ffcd07bf82ea43e9ecfca16a2840c3486d4e210252f
-  data.tar.gz: 0cba11a2c72e2be354087dfb9d79c4df17ee2b737c6ad1c19457ce6dc78488a53d43dfa3b7804ec9a3c74c04633b766177ec59e64877497a07a5f2cd1640a3d4
+  metadata.gz: 170164a43b0a1a5175418a6c0216034a6b9d2e43637595699289bc9d100ef85767f466ef1dd2803eac27cd1c42cdbc825037ba807bab7fe3ab02bd3b70d48c5f
+  data.tar.gz: 5631ed597d2e5134fc5ef914f2bf51275485635b9fe6f022e50a34c070fa88b6b7f4117bc0aa9fbd73eb90d68c0f5e2d7f768248a13ef0d6f222c0617ea578bf

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
-#  - 1.8.7
-  - 1.9.2
-  - 1.9.3
   - 2.0.0
+  - 2.1.*
+  - 2.2.*
+  - 2.3.0
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.5.2 (2016/03/18)
+
+Fixes:
+
+- Fix not to return exitstatus 0 when a child process is killed by -9 (Now, exitstatus becomes nil as Open3.popen3)
+
 # 0.5.1 (2016/01/23)
 
 Changes:

data/README.md

@@ -1,7 +1,5 @@
 # frontkick [![Build Status](https://secure.travis-ci.org/sonots/frontkick.png?branch=master)](http://travis-ci.org/sonots/frontkick) [![Dependency Status](https://gemnasium.com/sonots/frontkick.png)](https://gemnasium.com/sonots/frontkick)
 
-testing ruby: 1.9.2, 1.9.3, 2.0.0;
-
 Frontkick is a gem to execute a command and obtain exit\_code, stdout, stderr simply. 
 
 ## What is This For?
@@ -72,35 +70,33 @@ 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
+Sending a signal to a kicked child process is fine because a frontkick process can finish.
+But, sending a signal to a frontkick process is not fine because a child process would become an orphan process.
+
+To kill your frontkick process with its child process correctly, send a signal to their **process 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
+If you can not take such an approach by some reasons (for example, `daemontools`, a process management tool,
+does not support to send a signal to a process group), 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]
+More sophisticated example is available at [./example/kill_child.rb](./example/kill_child.rb)
 
 ## Contributing
 

data/example/kill_child.rb

@@ -1,51 +1,77 @@
 require 'frontkick'
 
-puts "kill -TERM #{Process.pid} or Hit Ctrl-C in 10 seconds"
+class SignalHandler
+  def self.register
+    @pids ||= []
+    @main_threads ||= []
 
-result = Frontkick.exec(["sleep 10"]) do |wait_thr|
-  pid = wait_thr.pid
-  signal_pipe_r, signal_pipe_w = IO.pipe
+    if @signal_pipe_r.nil? and @signal_pipe_w.nil?
+      @signal_pipe_r, @signal_pipe_w = IO.pipe
+    end
+
+    # For example, loogger `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
 
-  # You know, there are many things `can't be called from trap context`
-  trap :INT do
-    signal_pipe_w.puts 'INT'
+    # Create a new thread to handle signals
+    # This example kills child (and self)
+    @signal_handler_thr ||= Thread.new do
+      begin
+        while readable_io = IO.select([@signal_pipe_r])
+          signal = readable_io.first[0].gets.strip
+          puts "#{signal} signal received"
+          @pids.each_with_index do |pid, idx|
+            main_thread = @main_threads[idx]
+            begin
+              puts "kill -#{signal} #{pid}"
+              Process.kill(signal, pid) rescue nil
+            rescue => e
+              main_thread.raise e
+            end
+          end
+          # case signal
+          # when 'INT'
+          #   Kernel.exit(130)
+          # when 'TERM'
+          #   Kernel.exit(148)
+          # end
+        end
+      rescue Exception => e
+        Thread.main.raise e
+      end
+    end
   end
-  trap :TERM do
-    signal_pipe_w.puts 'TERM'
+
+  def self.push(pid)
+    @pids << pid
+    @main_threads << Thread.current
   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
+  def self.pop(pid)
+    @pids -= [pid]
+    @main_threads -= [Thread.current]
   end
+end
 
-  begin
-    # Wait child to finish (for normal situation)
-    wait_thr.join
+SignalHandler.register
 
-    # Send NOOP to finish signal_handler_thr (for normal situation)
-    signal_pipe_w.puts 'NOOP'
-    signal_handler_thr.join
+puts "## Frontkick started"
+puts "kill -TERM #{Process.pid} or Hit Ctrl-C in 10 seconds"
+result = Frontkick.exec(["sleep 10"]) do |wait_thr|
+  begin
+    SignalHandler.push(wait_thr.pid)
+    puts wait_thr.value # wait child to finish (for normal situation)
   ensure
-    signal_pipe_r.close rescue nil
-    signal_pipe_w.close rescue nil
+    SignalHandler.pop(wait_thr.pid)
   end
 end
 
-# should come here if child process finished normally,
-# but not come here if signals are received (Kernel.exit)
+puts "## Fronkick finished"
+puts "kill -TERM #{Process.pid} or Hit Ctrl-C in 5 seconds"
+sleep 5
+
 puts result.inspect

data/example/run.rb

@@ -1,4 +1,5 @@
 require 'frontkick'
 
 result = Frontkick.exec(["#{__dir__}/../experiment/cat_64k.rb"])
-puts result.stdout
+puts "exitstatus: #{result.exitstatus}"
+puts "stdout: #{result.stdout}"

data/lib/frontkick/result.rb

@@ -9,7 +9,7 @@ module Frontkick
     def initialize(params = {})
       @stdout = params[:stdout] || ""
       @stderr = params[:stderr] || ""
-      @exit_code = params[:exit_code] || 0
+      @exit_code = params[:exit_code] # exit_code would be nil if child process is killed -9
       @duration = params[:duration] || 0
     end
 

data/lib/frontkick/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frontkick
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -69,9 +69,9 @@ files:
 - Rakefile
 - example/dry_run.rb
 - example/kill_child.rb
-- example/out_err.rb
+- example/popen3_options.rb
+- example/redirect_without_shell.rb
 - example/run.rb
-- example/spawn_opts.rb
 - experiment/capture3_no_deadlock.rb
 - experiment/cat_63k.rb
 - experiment/cat_64k.rb